Access

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 in the PLANTA customizer help area

Information

  • In this module you can have a look at time-controlled events and edit their settings.
  • You can also have a look at the event history.
  • In this module you cannot create or delete events. For this purpose, the respective Time-Controlled Events customizer module is used.

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

Event Settings

Information

  • 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 listbox specifies whether and how often the event is to recur. The following entries are offered for selection:
IntervalDescription
OnceThe event is executed once at the planned point in time and does not recur.
HourlyThe event recurs every hour.
DailyThe event recurs every day.
WeeklyThe event recurs every seven days.
MonthlyThe event recurs the next month on the same week day, e.g. on the first Monday or on the last Friday of a month.
Yearly

The event recurs on the same date in the following year. Events on 02/29 only recur in leap years

User-definedA user-defined interval is specified. This allows for a more detailed configuration.
  • 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.