Execution Plan allows to configure the scheduling of scheduled tasks.
Definition
Execution Plan allows to configure the scheduling of scheduled tasks.
There are four modes available ONCE, CRON,INTERVAL and MANUAL.
-
ONCE is used for only one execution at a specific date and time.
-
CRON and INTERVAL is used for recurrent tasks.
-
MANUAL is used to only trigger manualy an execution
Configuration
Properties
|
Property Name |
Type |
Mandatory |
Description |
Values (default value in bold) |
|---|---|---|---|---|
|
scheduleType |
|
YES |
Type of scheduling |
ONCE,CRON,INTERVAL |
|
fireTime |
|
YES if the mode is ONCE |
Date and time to execute task
|
2018-04-01T17:17:28.298Z |
|
cron |
|
YES if the mode is CRON |
Cron expression to schedule the task. Written in Cron syntax (see Cron Trigger)
|
0 */1 * * * ? * (every one minute) |
|
interval |
|
YES if the mode is INTERVAL |
Interval beetwen execution |
1,2,3,… |
|
intervalUnit |
|
YES if the mode is INTERVAL |
Interval unit beetwen execution |
MINUTES,DAYS,HOURS,….. |
|
timeZone |
|
No |
Time zone used |
Africa/Asmera |
Example
ONCE
<executionPlan>
<scheduleType>ONCE</scheduleType>
<fireTime>2023-12-18T09:50:58Z</fireTime>
</executionPlan>
In this example, the scheduled task will be executed only on December 18, 2023 at 9:50 a.m.
CRON
<executionPlan>
<scheduleType>CRON</scheduleType>
<cron>0 0 10 1 1 ? *</cron>
<timeZone>Africa/Asmera</timeZone>
</executionPlan>
In this example, the scheduled task will be executed every first day of January at 10 a.m.
INTERVAL
<executionPlan>
<scheduleType>INTERVAL</scheduleType>
<interval>1</interval>
<intervalUnit>DAYS</intervalUnit>
</executionPlan>
In this example, the scheduled task will be executed every day.
MANUAL
<executionPlan>
<scheduleType>MANUAL</scheduleType>
</executionPlan>
In this example, the job will be execute manually by an administrator only from scheduled job feature of administration portal.
Read Next
-
XML configuration All IM configuration can be imported or exported in XML, either through the UI or through API. This page describes the general principles governing this XML representation, and conventions used throughout this Technical documentation.
-
Search Expressions Search Expressions are domain-specific language used to search objects (Managed Objects, Reporting collections,…) or express constraints on them. They are composed of Property Expressions (e.g. firstName LIKE 'John*') and Functions combined with Logical Operators (AND, OR, NOT)
-
Rules A rule is an extension point of the application to implement custom behavior, for example (validation ....).
-
Scope A Scope describes a population of objects (Managed Objects such as Identities, Role Assignments,…). They are used throughout IM configuration to specify on which Data a Configuration Entity operates. For instance, which Objects are accessible through a Feature, or to which Identities a Password Policy applies to.
-
Execution Plan