Period definition properties
- Last UpdatedApr 03, 2025
- 3 minute read
Refer to the following tables for the key configurable properties of Period Definition.
Period properties
|
Property |
Description |
Valid values |
|---|---|---|
|
FixedPeriods |
Used to define periods that are fixed and do not have a cyclic repeat period. Click Browse (...) to open the Named Period Collection Editor and define the characteristics of any fixed periods that do not repeat.
|
A collection of named periods |
|
PublishEventOnPeriodEnded |
When this property is set to True, AVEVA™ Production Management publishes an event to the Service Bus when the period ends. Note: Set the Trigger property on the Planning state transition item to PeriodEnded. |
True, False |
|
RepeatingPeriods |
Used to define periods that repeat. Example: a day may consist of three 8 hour shifts called; morning, afternoon and night. A working week may consist of six working days. Click Browse (...) to open the Named Period Collection Editor and define the characteristics of any periods that repeat regularly.
|
A collection of named periods |
|
Units |
Used for display purposes in AVEVA™ Production Management. |
Any string value |
Period Blackouts properties
|
Property |
Description |
Valid values |
|---|---|---|
|
FixedBlackouts |
Used to mask exceptions to the fixed period. Any blackouts that occur within the fixed period. Click Browse (...) next to the property to open the Named Period Collection Editor and define the characteristics of any fixed blackout periods.
|
A collection of named periods |
|
RepeatingBlackouts |
Used to mask dates contained in a repeating period. For example, you want to use the repeating period of Week, but you want to block out Sunday. Click Browse (...) next to the property to open the Named Period Collection Editor and define the characteristics of any repeating blackout periods.
|
A collection of named periods |
Display properties
|
Property |
Description |
Valid values |
|---|---|---|
|
ShowInFilter |
This controls the period's visibility as a filter in the AVEVA Production Management Web Client. By default, this is set to True for both standard and custom periods. |
True, False |
Miscellaneous properties
|
Property |
Description |
Valid values |
|---|---|---|
|
AdjustForDaylightSavings |
Automatically adjust the period definition for daylight savings. |
True, False |
|
TimeZone |
Automatically adjust the period definition for the selected time zone. This property indicates the region or zone to be used, which follows a standard time that is either ahead or behind GMT. |
Supported listed time zones |