Skip to main content

Schedules

This interface is included in the Scheduling package.

Description​

A recurring schedule for which tasks should be generated, when assigned to a schedulable item.

Properties​

This interface has the following properties.

PropertyValue
NameSchedules
CodedesignInterfaces_schedule_8bbf2c5dac22df0ab9d7e055
TypeInterface
ContextPackage
AI agent enabledNot specified, defaults to true
Iconicon-schedule-date-time
Colour#0266a7  
Title{{attributes_scheduleScheduleName_853fb7b0364e821472000a7f}}
SubtitleSchedule

Implements​

This interface doesn't implement any other interfaces.

Attributes​

This interface has the following attributes.

Tolerance​

PropertyValue
NameTolerance
Codeattributes_scheduleTolerance_67d7fb0ce3b13a41662d552d
TypeJson
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Options
Show options (23 lines)
{
"jsonSchema": {
"type": "object",
"properties": {
"days": {
"title": {
"en": "Tolerance Days"
},
"type": "number",
"multipleOf": 1
},
"months": {
"title": {
"en": "Tolerance Months"
},
"type": "number",
"multipleOf": 1
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
}

Schedule name​

PropertyValue
NameSchedule name
Codeattributes_scheduleScheduleName_853fb7b0364e821472000a7f
TypeString
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true

Description​

PropertyValue
NameDescription
Codeattributes_scheduleDescription_8878cba653b4d0efadac17b5
TypeString
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true

Task to generate​

Task type to be generated for this schedule.

PropertyValue
NameTask to generate
Codeattributes_scheduleTasksToGenerate_8e052b8307c10ea8ae43b4ec
TypeLink
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Links toTask type - list
Options
{
"code": "designs_taskTypeList_8a63fe9dd1667361be296c4f",
"graph": "Lookup",
"max": 1
}

Live or Template project​

Project to assign tasks generated by this schedule to. Setting a LIVE project only adds tasks to the defined project, whereas setting a TEMPLATE project will create a new project for each date in the schedule and add relevant tasks to it.

PropertyValue
NameLive or Template project
Codeattributes_scheduleLiveOrTemplateProject_8e78cba487983ce05e5f0dc3
TypeLink
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Links toProjects
Options
{
"code": "designInterfaces_projects",
"graph": "Scheduling",
"weakReference": true,
"max": 1
}

Starts On (Inclusive)​

Schedule dates will not be generated before this date.

PropertyValue
NameStarts On (Inclusive)
Codeattributes_scheduleStartsOn_8938a2342563580acb7d5ca5
TypeDate
Requiredtrue
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true

Ends On (Exclusive)​

Schedule dates will not be generated on or after this date.

PropertyValue
NameEnds On (Exclusive)
Codeattributes_scheduleEndsOn_8f3ddb33870afa31cde2e449
TypeDate
Requiredtrue
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true

Explicit Dates​

Explicitly add or block specific dates on this schedule.

PropertyValue
NameExplicit Dates
Codeattributes_scheduleDates_8de88b7173c8a0a7ca743e7e
TypeJson
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Options
Show options (29 lines)
{
"jsonSchema": {
"type": "object",
"properties": {
"include": {
"title": {
"en": "Include"
},
"type": "array",
"items": {
"type": "string",
"format": "date"
}
},
"exclude": {
"title": {
"en": "Exclude"
},
"type": "array",
"items": {
"type": "string",
"format": "date"
}
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
}

Generation Frequency​

Frequency of task generation.

PropertyValue
NameGeneration Frequency
Codeattributes_scheduleGenerationFrequency_85e3a5bd733c864694ecffbd
TypeLink
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Links toPeriodicities
Options
{
"code": "designs_periodicity_8f3183380533b281ac719c10",
"graph": "Lookup",
"max": 1,
"defaultValue": [
"67d43ecad1c020d6302710bc"
]
}

Generation Period Start​

Offset to start generating tasks from.

PropertyValue
NameGeneration Period Start
Codeattributes_scheduleGenerationPeriodStart_85e3a5ba731c864294ecf358
TypeJson
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Options
Show options (23 lines)
{
"jsonSchema": {
"type": "object",
"properties": {
"days": {
"title": {
"en": "Start Days"
},
"type": "number",
"multipleOf": 1
},
"months": {
"title": {
"en": "Start Months"
},
"type": "number",
"multipleOf": 1
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
}

Generation Period Length​

Timespan to generate tasks from Generation Period Start.

PropertyValue
NameGeneration Period Length
Codeattributes_scheduleGenerationPeriodLength_8be3a54d323c874694ecfab2
TypeJson
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Options
Show options (23 lines)
{
"jsonSchema": {
"type": "object",
"properties": {
"days": {
"title": {
"en": "Length Days"
},
"type": "number",
"multipleOf": 1
},
"months": {
"title": {
"en": "Length Months"
},
"type": "number",
"multipleOf": 1
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
}

Standard paths​

This interface doesn't have any standard paths of its own.

Permissions​

This interface has no defined permissions.