Period (PERIOD)

Period objects provide the time parameters needed for executing an object using the Execute Recurring option. They define when and how often the recurring execution should run. As a developer and object designer, instead of manually defining the date, time and frequency of the recurrence, you can assign it a Period object. If necessary, you can modify the values loaded by the Period object before starting the execution.

Note: You can start a new execution of an object while a previous execution is still running. If you use the Execute Recurring option, the recurrent execution parameters are effective after the current run completes.

Tip: Define Period objects for typical recurring specifications that you can use as templates. This way you save time and you ensure consistency when you execute recurring tasks. For sample definitions, see Examples of Period Objects.

Object class: Passive object

Object type/Short name: PERIOD

To Define a Period Object

1. In he Process Assembly perspective click Add Object. On the Add Object dialog, select Period.

   A Period object definition is made up of the following pages:

   • Standard pages that are always available, no matter what type of object you are defining:

     • General Page
     • Version Management Page
     • Documentation Page

   • The object-specific page described here

   Note: You can also create Period objects directly from the Combo Boxes that serve to select objects.

2. In the Period section, specify when the period starts and ends.

   Changes to the End of a period do not affect recurring executions that have already started.

3. Define the Frequency of the Period object.

   • Execute

     Defines when and how often within one day the executions start. Depending on your selection, further options are display to refine the run intervals:

     • at

     • in intervals of every

       Fix time intervals

       Maximum: 504 hours= 21 days

       The first execution starts immediately unless you define an Initial Start Time.

       Tip: Use this option in combination with Initial Start Time so that the intervals start at regular clock-time segments.

       Example: The period is defined to execute the job in 30-minute intervals, and you start the recurring execution at 9:07.

       With Initial Start Time	Without Initial Start Time
       9:07 (immediate start)	9:30 (start at the next half hour)
       9:37 (9:07 (start) + 00:30)	10:00 (9:30 (start) + 00:30)
       10:07 (9:37 (start) + 00:30)	10:30 (10:00 (start) + 00:30)
       and so on	and so on

     • after the previous run ends plus

       Buffer time after the end of the previous run

       Maximum: 504 hours= 21 days

       Using this option with an Initial Start Time has little effect on the execution times. The first execution starts at a normal clock-time segment (not at 9:07 but at 9:15). However, the rest of the executions start based on the actual runtime of each run plus the fixed buffer time. This results in irregular clock-time starts.

   • Between time window

     If you select in intervals of every, you can also define the time window in which the object is started.

   • Allow one overlap

     The next scheduled execution starts even if the previous one is still running. Without this option, the execution would be skipped until the next scheduled time.

4. Use the Days section to restrict the executions to certain weekdays. You can use Calendar conditions o define more complex and precise days for the executions. For more information, see Calendars (CALE) and Calendar Events.

See also:

Examples of Period Objects