Time-Controlled Events MOD009DA6

Access

• Customizer → System Customizer → Events → Time-Controlled Events

Time-controlled events are programmable events which are run independent of save processes and other activities at defined points in time. Further information on events

Information

• In this module you can create and modify time-controlled events.
• You can also have a look at the event history.

Module Structure and Functions

Information

• Each event is displayed in a box which contains all of its data.
• On the left hand side of the box, general event information is displayed of which some may be editable.
• On the right hand side, the interval settings of the event are displayed.
• At the very right you will find the following buttons:
  • Configure - Via this button you can open the Configure User-Defined Interval module in which a user-defined recursion interval can be configured for an event.
  • History - Via this button, the Event History   module is opened which contains the history records of an event.
  • Delete - This button can be used to delete an event.

Event Settings

Information

• In the Function type listbox, the language or method of the event is specified.
  • The listbox allows the Java, Jython and Python, entries, however, currently only Java and Jython functions are used for time-controlled events.
• In the Function name field the full name of the (static) class method to be run is specified including its path.
• In the Parameter field you can enter a freely definable string for the method to be run.
• In the Status field, the status of the event is specified and adjusted automatically by the system. 
  • The following Status values are used for time-controlled events:
    • 0: Waiting
      • The event is currently scheduled to run at another time. 
      • This is the default status of any event at its creation.
    • 1: Is run
      • The function assigned to the event is currently running.
    • 2: Terminated
      • The event has been terminated without errors and will not be run again.
    • 3: Failed
      • An error has occurred in the last run. The event will be run again after server restart.
  •  A manual change of the status has no influence on whether an event is run again or not. Execution only depends on the Activated parameter as well as of the interval settings of the event.
• The Activated parameter determines whether the event is executed ( ) or ignored ( ).
  • An event is only executed if the Activated checkbox is activated.
• Below the editable event settings, information on the next start time, the last execution and the number of effected executions is displayed.

Interval Settings

Information

• By default, the interval settings consist of the Day, Time, and Recurs fields.
  • Day and Time define the initial start time of the event.
  • The Recurs  checkbox specifies whether and how often the event is to recur. The following entries are offered for selection:

• User-Defined interval settings will only be displayed if the User-defined setting has been selected in the Recurs field. The fields in question are output fields (grayed-out) which cannot be edited in this module.
  • In order to edit user-defined interval settings, click on the configure button. The Configure User-Defined Interval module will be displayed in which the changes can be made.
  • Changes which are made in the Configure User-Defined Interval module are directly adopted in the output fields of the event record.