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 view 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 you can open the Event History module which contains the history records of an event.
- Delete - This button can be used to delete an event.
- Execute - This button can be used to manually execute an event once. For this purpose, status, type of recursion, and start time are changed and the event history of this event is deleted.

Event Settings

Information

In the Function type listbox, you can specify the language or method of the event.
- 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 executed.
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 executed
    - The function assigned to the event is currently running.
  - 2: Terminated
    - The event was terminated without errors and will not be executed again.
  - 3: Failed
    - An error has occurred during the last execution. The event will be executed again after server restart.
- A manual change of the status has no influence on whether an event is executed 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.
After the last execution, a traffic light is displayed which either indicates successful (green tranche) or incorrect (yellow tranche) execution.

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:

Interval	Description
Once	The event is executed once at the planned point in time and does not recur.
Hourly	The event recurs every hour.
Daily	The event recurs every day.
Weekly	The event recurs every seven days.
Monthly	The 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-defined	A 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.
- 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.

Create Time-Controlled Event

Procedure

Insert a new event record in the Time-Controlled Events module.
Allocate a function type and function name.
- Currently, only the Jython and Java function types are supported for time-controlled events.
Optionally you can make an entry in the Parameter field.
Enter Day and Time of the initial execution of the event.
In the Recurs field, set how often the event is to be executed by making a selection from the listbox.
- If the recursion of the event is to be defined more precisely:
  - Select the User-defined entry.
  - Save.
  - Opn the Configure User-Defined Interval module by clicking on the Configure button.
    - Enter a number below the Recurs every heading and enter a Unit in order to define the interval between the recursions of the event.
    - Optionally activate the checkboxes of the weekdays below the Recurs on heading in order to restrict the execution of the event to particular days.
      - On the weekdays for which the checkboxes are activated, the event can be executed.
    - Define below the Ends heading when the event is to be terminated, i.e. when the recursions of the event are to be suspended.
      - The Never ends checkbox is activated by default.
      - If the event is to be terminated on a particular date, activate the Ends on checkbox and store the date.
      - If the event is to be terminated after a particular number of executions, activate the Ends after checkbox and store the number of desired executions.
If the event is to be immediately active, mark the Activated checkbox.
- An event is only executed if the Activated checkbox is activated.
Save.

Details

In order to edit a user-defined interval, click on the configure button and make the changes in the Configure User-Defined Interval module.

Standard Events

The following events are made available by PLANTA by default:

Nocturnal replanning	Carries out a nocturnal replanning (calculation of all planning objects).
Anonymize resources left	Data of Persons left such as name, first name, e-mail address, etc. are pseudonymized. The configuration is made in the customizing via listbox category 00000502. Here, you can enter the data items to be pseudonymized. The following parameters are defined per data item: Category: Python ID of the data item Number 4 digits: Pseudonymization code 1: ID. Here, the Python ID of the table which corresponds to the resource ID from 467 is entered. The HQL search_record is constructed based on this Python ID 2: pseudonymize, causes the DI to be filled with a random value 3: empty, important for, e.g., e-mail fields Number 9 digits.: Table ID to which the DI with this Python ID belongs In pseudonymization, IDs (codes) of persons/resources are changed/replaced by the Change person/resource ID function. For this reason, when implementing individual data tables with personal data you have to make sure that the DT and ID data item in question are additionally included in the mapping for Change person/resource ID. The technical person ID is not changed during pseudonymization. The sex of all pseudonymized persons is set to "male" by default.
Jira Hybrid synchronization Pulse Hybrid synchronization	Are used for the automatic synchronization of PLANTA project data with external systems (synchronization with PLANTA pulse and synchronization with Jira). The respective event is automatically activated when the API-URL is defined for the corresponding external system.
Send automatic e-mails for resource requests	Is used when employing the resource requests function to inform the responsible department managers/project managers when resources are requested or approved/denied. The event is automatically activated when the global Resource requests active setting is set to "1" or "2".
Delete archived planning objects	Deletes archived projects which are older than 10 years and which are not assigned to any portfolio and do no contain any external links.
Start underposting correction	Is required for the automatic correction of underpostings. The event triggers a module (009DSP) every night, which in turn executes the Python code that checks whether an underbooking correction is to be carried out on this day. For detailed information on the automated correction of underpostings/overpostings, please click here.
LDAP Import	Carries out a nocturnal user import (at 4.30) via LDAP.
Notification function for missing bookings	If this event is activated, the missing bookings for the working days of the previous week are checked every Monday. If the working hours are exceeded by the hours of presence, the person concerned is informed by e-mail or, if activated, via adaptive cards.
Notification function for missing status report	If this is activated, the system checks whether all projects in the current month have a released status report. For projects without a status report, the project manager is informed by e-mail or, if activated, via adaptive cards.

Note

In general, events are deactivated by default and can be activated by activating the Activated checkbox. Some events are automatically activated if the underlying function is activated.
You have to define the clientless session user in the Parameter field for all events (except Send automatic e-mails for resource requests). In the PLANTA standard system it is PLSYSTEM.

See also: Programmable Events