Skip to main content

Periodicities

This interface is included in the Scheduling package.

Description​

A pattern for generating next date.

Properties​

This interface has the following properties.

PropertyValue
NamePeriodicities
CodedesignInterfaces_periodicity_68109e5096e0ec0345072f8a
TypeInterface
ContextPackage
AI agent enabledNot specified, defaults to true
Iconicon-wrap
Colour#f9bc13  
Title{{attributes_periodicityDesciption_8d1d48809aaff63e89b1fdcc}}
SubtitlePeriodicity

Implements​

This interface doesn't implement any other interfaces.

Attributes​

This interface has the following attributes.

Description​

PropertyValue
NameDescription
Codeattributes_periodicityDesciption_8d1d48809aaff63e89b1fdcc
TypeString
Requiredtrue
Uniquetrue
Read-onlyfalse
AI agent enabledNot specified, defaults to true

Repeat​

The repeating pattern including the 'interval' and 'unit' which should read as 'Repeat from the start date every <interval> <unit>s'. e.g. 'Repeat from 01/05/2024 every 3 Weeks'.

PropertyValue
NameRepeat
Codeattributes_periodicityRepeat_8e35bd9dad29336f460f2acd
TypeJson
Requiredtrue
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Options
Show options (29 lines)
{
  "jsonSchema": {
    "type": "object",
    "properties": {
      "interval": {
        "title": {
          "en": "Interval"
        },
        "type": "number",
        "multipleOf": 1,
        "minimum": 1
      },
      "unit": {
        "title": {
          "en": "Unit"
        },
        "type": "string",
        "enum": [
          "Days",
          "Weeks",
          "Months",
          "Years"
        ]
      }
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-07/schema#"
  }
}

Valid on​

Selection of value combinations for day, week, month and year. Dates will only be generated when matching all these (if specified).

PropertyValue
NameValid on
Codeattributes_periodicityValidOn_80a6a695435acd16e0b4d317
TypeJson
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true
Options
Show options (91 lines)
{
  "jsonSchema": {
    "type": "object",
    "properties": {
      "daysOfWeek": {
        "title": {
          "en": "Days of the Week"
        },
        "type": "array",
        "items": {
          "type": "number",
          "multipleOf": 1,
          "minimum": 1,
          "maximum": 7
        }
      },
      "daysOfMonth": {
        "title": {
          "en": "Days of the Month"
        },
        "type": "array",
        "items": {
          "type": "number",
          "multipleOf": 1,
          "minimum": 1,
          "maximum": 31
        }
      },
      "daysOfYear": {
        "title": {
          "en": "Days of the Year"
        },
        "type": "array",
        "items": {
          "type": "number",
          "multipleOf": 1,
          "minimum": 1,
          "maximum": 366
        }
      },
      "weeksOfMonth": {
        "title": {
          "en": "Weeks of the Month"
        },
        "type": "array",
        "items": {
          "type": "number",
          "multipleOf": 1,
          "minimum": 1,
          "maximum": 5
        }
      },
      "weeksOfYear": {
        "title": {
          "en": "Weeks of the Year"
        },
        "type": "array",
        "items": {
          "type": "number",
          "multipleOf": 1,
          "minimum": 1,
          "maximum": 54
        }
      },
      "monthsOfYear": {
        "title": {
          "en": "Months of the Year"
        },
        "type": "array",
        "items": {
          "type": "number",
          "multipleOf": 1,
          "minimum": 1,
          "maximum": 12
        }
      },
      "years": {
        "title": {
          "en": "Years"
        },
        "type": "array",
        "items": {
          "type": "number",
          "multipleOf": 1
        }
      }
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-07/schema#"
  }
}

Next Date​

The next date to be generated on or after the time the scheduler will next run (i.e. not on or after today, but some later date!) and generate tasks for. This is the soonest next date.

PropertyValue
NameNext Date
Codeattributes_periodicityNextDate_8b766935838e7116fb62e7c0
TypeDate
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledNot specified, defaults to true

Standard paths​

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

Permissions​

This interface has no defined permissions.