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, When you execute an object by selecting the Execute Recurring option, 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. For more information, see Executing Objects - Recurring.

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.

1. In the Process Assembly perspective click Add Object. On the Add Object dialog, select Period. For information on how to add objects, see Adding Objects.

   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 Using AWI Combo Boxes that serve to select objects.

2. On the Object Name dialog enter the name of the new object. Choose it carefully. For more information, see Best Practices: Naming Conventions.

3. Click OK to open the object definition pages.

4. 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.

5. 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

       Specify the Time at which the object should be executed.

     • in intervals

       Specify the fix time intervals in which the object will start executing.

       • In Every you determine the interval between executions. The maximum interval possible is 504 hours (21 days).

       • In From / To you further restrict the time window in which the object can execute.

       The first execution starts immediately unless you define an Initial Start Time. Use this option in combination with Initial Start Time so that the intervals start at regular clock-time segments.

       Example: You enter 30 minutes in in intervals of every. This means that the job to which you assign this Period object will execute every 30 minutes. Let's suppose that you start the recurring execution at 9:07. This table explains what happens when you activate and when you do not activate the Initial Start Time option:

       You DO NOT activate Initial Start Time	You ACTIVATE  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

       Select Allow One Overlap if you want the next scheduled execution of the object to start even if the previous one is still running. Without this option, the execution would be skipped until the next scheduled time.

     • after the previous execution ends plus

       Specify a buffer time after the end of the previous run.

       • In Time After Execution you define how many hours and seconds that must elapse before the next run can start. The maximum interval possible is 504 hours (21 days).

       • In From / To you further restrict the time window in which the object can execute.

       Important! 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.

6. 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.