Schedules
Task scheduling allows an activity to be executed on a specific date and/or time or periodically, which makes it possible to control the number of executions, with a deadline or even for an indefinite period of time, automatically. For example, configuring the system to issue a report for a period of the day.
The scheduling service only allows you to schedule platform service tasks and reference them by their domain, service and primitive name (endpoint). Onlyendpoints cataloged files can be registered to execute.
What can you do:
Create schedule
- Go to Technology > Customization > Schedules and choose the domain grouping you want to configure;
- Click on the service you want to open the scheduling options, then clickCreate schedule;
- In Scheduling data, fill in the fieldsSchedule name It isSituation;
- InFunctionality, choose the functionality that the schedule will implement;
- In the fieldInput Parameter, configure the type of input that the schedule will receive. Most services require apayload input to be able to execute. This input can be defined in two ways: JSON or JavaScript. In both cases, the input must comply with thecontract expected by the service being executed.
- Configure the entry that will be executed. It is also possible to configure tags for better location and control of scheduling.
- InExecution, configure the task execution period.
- click inTo save.
Create automatic LDAP synchronization schedule
To use automatic synchronization, create the schedule:
- Access the Technology > Customization > Schedules menu;
- In Users, in the serviceUser, create the schedule. To facilitate identification, the name, for example, could be Synchronize LDAP Users;
- Select the optionActive and select the functionalitysynchronizeLDAPUsers and the JSON input type;
- InInput inform { tenantName: xxxx}
- Enter the start date of the schedule and the time at which the synchronization will take place;
- Select the optionRepeat, set the synchronization frequency. Choose the optionNever to indicate the scheduled end of this synchronization.
- Save the schedule.
Edit a schedule
- Access Technology > Customization > Schedules;
- On the scheduling screen, choose the domain grouping you want to configure;
- Click on the desired service to open the scheduling options;
- On the schedule you want, clickTo edit;
- Change the panel fieldScheduling data;
- click inTo save.
Important
In scheduled tasks, it is only possible to change the scheduling parameters. This limitation exists to avoid conflicts in quantity and execution periods.
Inactivate or delete a schedule
Inactivating and deleting a schedule must be done in Technology > Customization > Schedules. On the scheduling screen, choose the domain grouping you want to configure and click on the desired service to open the scheduling options.
click inTo edit in the schedule you want, change the fieldSituation forInactive and click To save, or, to delete, click To edit and then in Delete.
View execution history
All executions of a service are recorded and kept in a history, which can be accessed by clicking the buttonView history. A table will be displayed with the schedules and execution status. If you want to see only the schedules that failed to run, clickShow only errors.
The information maintained for a run is:
- id: unique identification of the execution;
- jobId: identifier of the executed task;
- status: execution status, which can beSuccess orError;
- start: start of execution;
- finish: end of execution;
- duration: execution duration, in milliseconds;
- response: the response of the called service, both for errors and successful executions.
By default, run histories older than 90 days are deleted. To adjust this value, seedocumentation setting the value of the job.history.max_age property.
