UA Part 24: Scheduler - 8 OPC UA DataTypes

This structure contains a period, a list of time actions, and a priority. It is a means to identify moments in time over one or more days. How the priority is used is defined in section 6.2. The structure is defined in Table 16.

Table 16 – SpecialEventType Structure

Name	Type	Description
SpecialEventType	structure
Period	SpecialEventPeriodType	A period where the special event is active
ListOfTimeActions	TimeActionsType[]	Points in time where the special event occurs and the associated actions
EventPriority	0:Byte	Priority of this special event. The lower the number, the higher the priority.

Its representation in the AddressSpace is defined in Table 17.

Table 17 – SpecialEventType Definition

Attribute		Value
BrowseName		SpecialEventType
IsAbstract		False
Description		This structure contains a period, a list of time values, and a priority. It is a means to identify moments in time over one or more days.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure
Conformance Units
Scheduler Scheduling Base

8.2 SpecialEventPeriodType

This union contains a calendar entry or a reference to a calendar Object. The union is defined in Table 18.

Table 18 – SpecialEventPeriodType Union

Name	Type	Description
SpecialEventPeriodType	union
CalendarEntry	CalendarEntryType	A calendar entry
CalendarReference	0:NodeId	Reference to a calendar object

Its representation in the AddressSpace is defined in Table 19.

Table 19 – SpecialEventPeriodType definition

Attributes		Value
BrowseName		SpecialEventPeriodType
IsAbstract		False
Description		This union contains a calendar entry or a reference to a calendar object
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of 0:Union
Conformance Units
Scheduler Scheduling Base

8.3 CalendarEntryType

This union that defines various calendar date values. The union is defined in Table 18.

Table 20 – CalendarEntryType Union

Name	Type	Description
CalendarEntryType	union
Date	DateType	A calendar date, potentially partly defined and repeating
DateRange	DateRangeType	A range of dates

Its representation in the AddressSpace is defined in Table 19.

Table 21 – CalendarEntryType Definition

Attributes		Value
BrowseName		CalendarEntryType
IsAbstract		False
Description		This union that defines various calendar date values
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of 0:Union
Conformance Units
Scheduler Scheduling Base
Scheduler Calendar Base

8.4 DateType

This structure defines a calendar date. It allows to define a concrete date, e.g. 2022-02-12. By using wildcards, it also allows to define repeating dates, like every Wednesday, every odd day of a month, every 24th of December, every last day of a month in 2023, etc. Its composition is formally defined in Table 22.

Table 22 – DateType Structure

Name	Type	Description
DateType	structure
Year	0:UInt16	Years based on the Gregorian calendar, 0 is used as “unspecific”.
Month	Month	A specific Gregorian calendar month or relative (e.g. “odd”, “even”)
DayOfMonth	DayOfMonth	A specific day of the month or relative (e.g. “last day”). Shall be “unspecific” if DayOfWeek is not “unspecific”.
DayOfWeek	DayOfWeek	A specific day of the week. Shall be “unspecific” if DayOfMonth is not “unspecific”.

Its representation in the AddressSpace is defined in Table 23.

Table 23 – DateType Definition

Attribute		Value
BrowseName		DateType
IsAbstract		False
Description		This structure defines a calendar date. It allows to define a concrete date, e.g. 2022-02-12. By using wildcards, it also allows to define repeating dates, like every Wednesday, every odd day of a month, every 24th of December, every last day of a month in 2023, etc.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure
Conformance Units
Scheduler Scheduling Base
Scheduler Calendar Base

8.5 Month

This enumeration indicates either a specific Gregorian calendar month, or a relative relationship (“odd”, “even”, and “unspecified”). The enumeration is defined in Table 24.

Table 24 – Month Values

Name	Value	Description
Unspecified	0
January	1
February	2
March	3
April	4
May	5
June	6
July	7
August	8
September	9
October	10
November	11
December	12
Odd	13
Even	14

Its representation in the AddressSpace is defined in Table 25.

Table 25 – Month Definition

Attribute		Value
BrowseName		Month
IsAbstract		False
Description		This enumeration indicates either a specific Gregorian calendar month, or a relative relationship (“odd”, “even”, and “unspecified”).
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText[]	0:PropertyType
Conformance Units
Scheduler Scheduling Base
Scheduler Calendar Base

8.6 DayOfMonth

This enumeration indicates specific days of the month by specific date (“1”, “22”, and so on) or by relative position (“last day of month”, “even day of month”, and so on). The enumeration is defined in Table 26.

Table 26 – DayOfMonth Values

Name	Value	Description
Unspecified	0
Day1	1
Day2	2
Day3	3
Day4	4
Day5	5
Day6	6
Day7	7
Day8	8
Day9	9
Day10	10
Day11	11
Day12	12
Day13	13
Day14	14
Day15	15
Day16	16
Day17	17
Day18	18
Day19	19
Day20	20
Day21	21
Day22	22
Day23	23
Day24	24
Day25	25
Day26	26
Day27	27
Day28	28
Day29	29
Day30	30
Day31	31
LastDayOfMonth	32
OddDayOfMonth	33
EvenDayOfMonth	34

Its representation in the AddressSpace is defined in Table 27.

Table 27 – DayOfMonth Definition

Attribute		Value
BrowseName		DayOfMonth
IsAbstract		False
Description		This enumeration indicates specific days of the month by specific date (“1”, “22”, and so on) or by relative position (“last day of month”, “even day of month”, and so on).
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText[]	0:PropertyType
Conformance Units
Scheduler Scheduling Base
Scheduler Calendar Base

8.7 DayOfWeek

This enumeration indicates each of the seven days of the week, or “unspecified”. The enumeration is defined in Table 28.

Table 28 – DayOfWeek Values

Name	Value	Description
Unspecified	0
Monday	1
Tuesday	2
Wednesday	3
Thursday	4
Friday	5
Saturday	6
Sunday	7

Its representation in the AddressSpace is defined in Table 29.

Table 29 – DayOfWeek Definition

Attribute		Value
BrowseName		DayOfWeek
IsAbstract		False
Description		This enumeration indicates each of the seven days of the week, or “unspecified”.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Enumeration type defined in OPC 10000-5
0:HasProperty	Variable		0:EnumStrings	0:LocalizedText[]	0:PropertyType
Conformance Units
Scheduler Scheduling Base
Scheduler Calendar Base

8.8 DateRangeType

This structure defines a time span, with start and end dates that are either open or absolute. The structure is defined in Table 30.

The StartDate and EndDate are limited to either use specific dates, i.e., wild cards like odd months are not allowed, or unspecified dates, i.e. only use wild cards.

In case a specific date is provided, the Year field shall not be 0; the Month field shall be a value between 1 to 12; the DayOfMonth field shall be between 1 to 31 and the DayOfWeek field shall be “unspecified”.

In case an unspecified date is provided, the Year field shall be 0, the Month field shall be “unspecified”, the DayOfMonth field shall be “unspecified”, and the DayOfWeek field shall be “unspecified”.

No other values shall be used for StartDate and EndDate.

Table 30 – DateRangeType Structure

Name	Type	Description
DateRangeType	structure
StartDate	DateType	The start date of the date range. The start day is included in the range.
EndDate	DateType	The end date of the date range. The end day is included in the range.

Its representation in the AddressSpace is defined in Table 31.

Table 31 – DateRangeType Definition

Attribute		Value
BrowseName		DateRangeType
IsAbstract		False
Description		This structure defines a time span, with absolute start and end dates. The StartDate and EndDate are limited to specific values, i.e., wild cards like odd months are not allowed. The Year field shall not be 0; the Month field shall be a value between 1 to 12; the DayOfMonth field shall be between 1 to 31 and the DayOfMonth field shall be “unspecified”.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure
Conformance Units
Scheduler Scheduling Base
Scheduler Calendar Base

8.9 TimeActionsType

This structure contains a time and an array of actions. It is used to define which actions shall be executed at a specific point in time. The structure is defined in Table 16.

Table 32 – TimeActionsType Structure

Name	Type	Description	AllowSubtypes
TimeActionsType	structure
Time	TimeType	A point in time during a day
Actions	BaseActionType[]	A list of actions to be executed at the defined Time Note: Here, subtypes are allowed. The table format will be updated, once a final format is defined.	True

Its representation in the AddressSpace is defined in Table 17.

Table 33 – TimeActionsType Definition

Attribute		Value
BrowseName		TimeActionsType
IsAbstract		False
Description		This structure contains a time and an array of actions. It is used to define actions to be executed at a specific point in time.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure
Conformance Units
Scheduler Scheduling Base

8.10 BaseActionType

This abstract structure defines the base of an action. The base only contains information, if the last execution of the action was successful. The structure is defined in Table 34.

Table 34 – BaseActionType Structure

Name	Type	Description
BaseActionType	structure
LastActionResult	0:StatusCode	Contains information, whether the last execution of the action was successful. Shall be Uncertain, if action was never executed or last execution not known by Server anymore, e.g., because of a restart. Shall be a good status code when execution of action was successful, and a bad status code, when execution was not successful. Subtypes might add additional information on execution of action, e.g. output arguments.

Its representation in the AddressSpace is defined in Table 35.

Table 35 – BaseActionType Definition

Attribute		Value
BrowseName		BaseActionType
IsAbstract		True
Description		This abstract structure defines the base of an action. The base only contains information, if the last execution of the action was successful.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure
Conformance Units
Scheduler Scheduling Base

8.11 WriteLocalVariableActionType

This structure defines an action to write the value of a Variable managed in the same Server where the action is used. The structure is defined in Table 36.

Table 36 – WriteLocalVariableActionType Structure

Name	Type	Description
WriteLocalVariableActionType	structure
Variable	0:NodeId	The NodeId of the Variable to be written
Value	0:BaseDataType	The value to be written to the Variable

Its representation in the AddressSpace is defined in Table 37.

Table 37 – WriteLocalVariableActionType Definition

Attribute		Value
BrowseName		WriteLocalVariableActionType
IsAbstract		False
Description		This structure defines an action to write the value of a Variable managed in the same Server where the action is used.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the BaseActionType
Conformance Units
Scheduler Scheduling Base

8.12 CallLocalMethodActionType

This structure defines an action to call a Method of an Object managed in the same Server where the action is used. The structure is defined in Table 38.

Table 38 – CallLocalMethodActionType Structure

Name	Type	Description
CallLocalMethodActionType	structure
ObjectId	0:NodeId	The NodeId of the Object the Method should be called on
MethodId	0:NodeId	The NodeId of the Method to be called
InputValues	0:BaseDataType[]	An array of input values to be used in the Method call
LastOutputValues	0:BaseDataType[]	An array of the output values the last time the Method was called. Shall be an empty array if no outputs arguments, the LastActionResult is a bad status code or the action was never executed or last execution is unknown.

Its representation in the AddressSpace is defined in Table 39.

Table 39 – CallLocalMethodActionType Definition

Attribute		Value
BrowseName		CallLocalMethodActionType
IsAbstract		False
Description		This structure defines an action to call a Method of an Object managed in the same Server where the action is used.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the BaseActionType
Conformance Units
Scheduler Scheduling Base

8.13 TimeType

This structure that represents a point in time during a day. The structure is defined in Table 40.

Table 40 – TimeType Structure

Name	Type	Description
TimeType	structure
Hour	0:Byte	Allowed values between 0 and 23 – 255 as unspecific
Minute	0:Byte	Allowed values between 0 and 59 – 255 as unspecific
Second	0:Byte	Allowed values between 0 and 59 – 255 as unspecific

Its representation in the AddressSpace is defined in Table 41.

Table 41 – TimeType Definition

Attribute		Value
BrowseName		TimeType
IsAbstract		False
Description		This structure that represents a point in time during a day
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure
Conformance Units
Scheduler Scheduling Base

8.14 DailyScheduleType

This structure defines a sequence of TimeActionsType structures. Each element in the sequence defines a time and a list of actions that shall be executed at that point in time. The structure is defined in Table 42.

Table 42 – DailyScheduleType Structure

Name	Type	Description
DailyScheduleType	structure
DaySchedule	TimeActionsType[]	A sequence of time / value pairs describing the value at a given point in the day.

Its representation in the AddressSpace is defined in Table 43.

Table 43 – DailyScheduleType Definition

Attribute		Value
BrowseName		DailyScheduleType
IsAbstract		False
Description		This structure defines a sequence of TimeActionsType structures. Each element in the sequence defines a time/actions pair that describes the actions to be executed at a given point in the day.
References	NodeClass		BrowseName	DataType	TypeDefinition	Other
Subtype of the 0:Structure
Conformance Units
Scheduler Scheduling Base