S.No. | Expression Name | Description | Examples |
---|
|
|
|
|
1. | rc | It is used as an Expression in Out Conditions to check the return code of the job. If it validates to true then events will be created. | rc: -2 [less that or equals to 2] rc: 1-7 [interval between 1 to 7] rc: 5- [greater than or equal to 5] rc: -5,6,7,10-20 [multiple return codes separated by comma] |
2. | fileexist | It checks whether the file exists in the specified path. It can be configured on both (In Condition and Out Condition) in two ways: | fileexist:path_to_file/filename [e.g. fileexist:config/one.txt] |
- the path from the root directory
| e.g. C:/data/inbound/one.txt |
- the path from the default directory {$SCHEDULER_DATA}
| e.g. config/one.txt |
|
|
3. | global | Global Events can be checked on both In Conditions and Out Conditions. Global Events can be created and deleted with an Out Condition. In Conditions and Out Conditions evaluate an Expression to true if the global event with the specified name exists.
| global:name_of_event |
|
| The global event can be specified by the keyword "global" - global: is optional
- name_of_event can specify the name of the job stream that created the event
- name_of_event can specify the date when the event was created
| global:job1 or job1 [if the event "job1" exists within the same job stream] test.job1 [if the event "job1" exists in job stream "test"] |
|
| | global:name_of_event[*], global:jobStream.name_of_event[*] [e.g. global:test.job1[*]] |
|
| - [today]: the global event was created today, this is the default.
| global:name_of_event[today], global:jobStream.name_of_event[today] [e.g. global:test.job1[today]] |
|
| - [yesterday]: the global event was created yesterday.
| global:name_of_event[yesterday], global:jobStream.name_of_event[yesterday] [e.g. global:test.job1[yesterday]] |
|
| - [yesterday - 2]: the global event was created two days before yesterday.
| global:name_of_event[yesterday-2], global:jobStream.name_of_event[yesterday-2] [e.g. global:test.job1[yesterday-2]] |
|
| - [prev]: will be substituted with the date of the last run.
| global:name_of_event[prev], global:jobStream.name_of_event[prev] [e.g. global:test.job1[prev]] |
|
| - [prevSuccessful]: will be substituted with the date of the last successful run.
| global:name_of_event[prevSuccessful], global:jobStream.name_of_event[prevSuccessful] [e.g. global:test.job1[prevSuccessful]] |
|
| - [prevError]: will be substituted with the date of the last run with an error.
| global:name_of_event[prevError], global:jobStream.name_of_event[prevError] [e.g. global.test.job1[prevError]] |
|
| - [20,11] : specific dates.
| global:name_of_event[20.11], global:jobStream.name_of_event[20.11] [e.g. global:test.job1[20.11]] |
|
|
|
|
3.
| event
| Events can be checked on both In Conditions and Out Conditions. Events can be created and deleted with an Out Condition. In Conditions and Out Conditions evaluates an Expression to true if the event with the specified name exists.
| event:name_of_event |
The event is specified by event:name_of_event. event: is optional name_of_event can specify the name of the job stream that created the event name_of_event can specify the date when the event was created
| event:name_of_event [Syntax] event:job1 or job1 [if the event "job1" exists within the same job stream] test.job1 [if the event "job1" exists in job stream "test"] |
| event:name_of_event[*], event:jobStream.name_of_event[*] [e.g. event:testjs.event1[*]] |
- [today]: the event was created today, this is the default.
| event:name_of_event[today], event:jobStream.name_of_event[today] [e.g. event:testjs.event1[today]] |
- [yesterday]: the event was created yesterday.
| event:name_of_event[yesterday], event:jobStream.name_of_event[yesterday] [e.g. event:testjs.event1[yesterday]] |
- [yesterday - 2]: the event was created two days before yesterday.
| event:name_of_event[yesterday-2], event:jobStream.name_of_event[yesterday-2] [e.g. event:testjs.event1[yesterday-2]] |
- [prev]: will be substituted with the date of the last run.
| event:name_of_event[prev], event:jobStream.name_of_event[prev] [e.g. event:testjs.event1[prev]] |
- [prevSuccessful]: will be substituted with the date of the last successful run.
| event:name_of_event[prevSuccessful], event:jobStream.name_of_event[prevSuccessful] [e.g. event:testjs.event1[prevSuccessful]] |
- [prevError]: will be substituted with the date of the last run with an error.
| event:name_of_event[prevError], event:jobStream.name_of_event[prevError] [e.g. event:testjs.event1[prevError]] |
| event:name_of_event[8.26], event:jobStream.name_of_event[8.26] [e.g. event:testjs.event1[8.26]] |
|
|
4.
| job
| The job is specified by job:name_of_job Users can browse and select any job from the tree. |
|
| job:rc, job:path_to_job/name_of_job.rc |
- [lastCompletedRunEndedSuccessful] → True, if the last job run completed successfully.
| job:lastCompletedRunEndedSuccessful, job:path_to_job/name_of_job.lastCompletedRunEndedSuccessful [e.g. job:test/job1.lastCompletedRunEndedSuccessful] |
- [lastCompletedRunEndedWithError] → True, if the last job run completed with an error.
| job:lastCompletedRunEndedWithError, job:path_to_job/name_of_job.lastCompletedRunEndedWithError [e.g. job:test/job1.lastCompletedRunEndedWithError] |
- [lastCompletedRunEndedTodaySuccessful] → True, if the last job run completed successfully today.
| job:lastCompletedRunEndedTodaySuccessful, job:path_to_job/name_of_job.lastCompletedRunEndedTodaySuccessful [e.g. job:test/job1.lastCompletedRunEndedTodaySuccessful] |
- [lastCompletedRunEndedTodayWithError] → True, if the last job run completed with an error today.
| job:lastCompletedRunEndedTodayWithError, job:path_to_job/name_of_job.lastCompletedRunEndedTodayWithError [e.g. job:test/job1.lastCompletedRunEndedTodayWithError] |
- [lastCompletedIsEndedBefore] → True, if the last job run completed before the given time. It doesn't matter whether the job run completed successfully or with an error.
| job:lastCompletedIsEndedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedIsEndedBefore[0:HH:MM:SS] [e.g. job:test/job1.lastCompletedIsEndedBefore[08:15:34]] |
- [lastCompletedSuccessfulIsEndedBefore] → True, if the last job run completed successfully before the given time.
| job:lastCompletedSuccessulIsEndedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedSuccessulIsEndedBefore[0:HH:MM:SS] [e.g. job:test/job1.lastCompletedSuccessulIsEndedBefore[08:15:34]] |
- [lastCompletedWithErrorIsEndedBefore] → True, if the last completion of the job implied an error and happened before the given time.
| job:lastCompletedWithErrorIsEndedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedWithErrorIsEndedBefore[0:HH:MM:SS] [e.g. job:test/job1.lastCompletedWithErrorIsEndedBefore[08:15:34]] |
- [lastCompletedIsStartedBefore] → True, if the last run of the job is completed and if the job was started before the given time.
| job:lastCompletedIsStartedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedIsStartedBefore[0:HH:MM:SS] [e.g. job:test/job1.lastCompletedIsStartedBefore[08:15:34]] |
- [lastCompletedSuccessfulIsStartedBefore] → True, if the last job run completed successfully and if the job was started before the given time.
| job:lastCompletedSuccessfulIsStartedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedSuccessfulIsStartedBefore[0:HH:MM:SS] [e.g. job:test/job1.lastCompletedSuccessfulIsStartedBefore[08:15:34]] |
- [lastCompletedWithErrorIsStartedBefore] → True, if the last job run completed with an error and if the job was started before the given time.
| job:lastCompletedWithErrorIsStartedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedWithErrorIsStartedBefore[0:HH:MM:SS] [e.g. job:test/job1.lastCompletedWithErrorIsStartedBefore[08:15:34]] |
- [isStartedToday] → True, if the job was started today. It doesn't matter whether the job completed successfully or with an error.
| job:isStartedToday, job:path_to_job/name_of_job.isStartedToday [e.g. job:test/job1.isStartedToday] |
- [isStartedTodayCompletedSuccessful] → True, if the job was started today and completed successfully today.
| job:isStartedTodayCompletedSuccessful, job:path_to_job/name_of_job.isStartedTodayCompletedSuccessful [e.g. job:test/job1.isStartedTodayCompletedSuccessful] |
- [isStartedTodayCompletedWithError] → True, if the job was started today and completed with an error.
| job:isStartedTodayCompletedWithError, job:path_to_job/name_of_job.isStartedTodayCompletedWithError [e.g. job:test/job1.isStartedTodayCompletedWithError] |
- [isStartedTodayCompleted] → True, if the job was started today and completed. It doesn't matter whether the job run completed successfully or with an error.
| job:isStartedTodayCompleted, job:path_to_job/name_of_job.isStartedTodayCompleted [e.g. job:test/job1.isStartedTodayCompleted] |
- [isCompletedToday] → True, if the job completed today. It doesn't matter when the job was started and whether the job run completed successfully or with an error.
| job:isCompletedToday, job:path_to_job/name_of_job.isCompletedToday [e.g. job:test/job1.isCompletedToday] |
- [isCompletedTodaySuccessfully] → True, if the job run completed successfully today.
| job:path_to_job/isCompletedTodaySuccessfully, job:path_to_job/name_of_job.isCompletedTodaySuccessfully [e.g. job:test/job1.isCompletedTodaySuccessfully] |
- [isCompletedTodayWithError] → True, if the job run completed with an error today.
| job:isCompletedTodayWithError, job:path_to_job/name_of_job.isCompletedTodayWithError |
- [isCompletedAfter] → True, if the job run completed after the given time. It doesn't matter whether the job run completed successfully or with an error.
| job:isCompletedAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isCompletedAfter[0:HH:MM:SS] [e.g. job:test/job1.isCompletedAfter[08:15:34]] |
- [isCompletedWithErrorAfter] → True, if the job run completed with an error after the given time.
| job:isCompletedWithErrorAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isCompletedWithErrorAfter[0:HH:MM:SS] [e.g. job:test/job1.isCompletedWithErrorAfter[08:15:24]] |
- [isCompletedSuccessfulAfter] → True, if the job run completed successfully after the given time.
| job:isCompletedAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isCompletedAfter[0:HH:MM:SS] [e.g. job:test/job1.isCompletedAfter[08:15:24]] |
- [isStartedAfter] → True, if the job was started after the given time. It doesn't matter whether the job run completed successfully or with an error or if the job is still running.
| job:isStartedAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isStartedAfter[0:HH:MM:SS] [e.g. job:test/job1.isStartedAfter[08:15:24]] |
- [isStartedWithErrorAfter] → True, if the job was started after the given time and raised an error.
| job:isStartedWithErrorAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isStartedWithErrorAfter[0:HH:MM:SS] [e.g. job:test/job1.isStartedWithErrorAfter[08:15:24]] |
- [isStartedSuccessfulAfter] → True, if the job was started after the given time and completed successfully.
| job:isStartedSuccessfulAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isStartedSuccessfulAfter[0:HH:MM:SS] [e.g. job:test/job1.isStartedSuccessfulAfter[08:15:24]] |
|
|
5.
| jobChain
| The job chain is specified by jobChain:name_of_job_chain Users can browse and select any job chain from the tree. | jobChain:name_of_jobChain [e.g. jobChain:myjobchain] |
| jobChain:rc, jobChain:name_of_jobChain.rc |
- [lastCompletedRunEndedSuccessful] → True, if the last job chain run completed successfully.
| jobChain:lastCompletedRunEndedSuccessful,
jobChain:path_to_jobChain/name_of_jobChain.lastCompletedRunEndedSuccessful jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedRunEndedSuccessful [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedRunEndedSuccessful] |
- [lastCompletedRunEndedWithError] → True, if the last job chain run completed with an error.
| jobChain:lastCompletedRunEndedWithError, jobChain:path_to_jobChain/name_of_jobChain.lastCompletedRunEndedWithError jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedRunEndedWithError [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedRunEndedWithError] |
- [lastCompletedRunEndedTodaySuccessful] → True, if the last job chain run completed successfully today.
| jobChain:lastCompletedRunEndedTodaySuccessful, jobChain:path_to_jobChain/name_of_jobChain.lastCompletedRunEndedTodaySuccessful jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedRunEndedTodaySuccessful [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedRunEndedTodaySuccessful] |
- [lastCompletedRunEndedTodayWithError] → True, if the last job chain run completed with an error today.
| jobChain:lastCompletedRunEndedTodayWithError, jobChain:path_to_jobChain/name_of_jobChain.lastCompletedRunEndedTodayWithError jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedRunEndedTodayWithError [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedRunEndedTodayWithError] |
- [lastCompletedIsEndedBefore] → True, if the last job chain run completed before the given time.
| jobChain:lastCompletedIsEndedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedIsEndedBefore[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedIsEndedBefore[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedIsEndedBefore[-1:09:25:10]] |
- [lastCompletedSuccessfulIsEndedBefore] → True, if the last job chain run completed successfully before the given time.
| jobChain:lastCompletedSuccessulIsEndedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedSuccessulIsEndedBefore[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedSuccessulIsEndedBefore[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedSuccessulIsEndedBefore[-1:09:25:10]] |
- [lastCompletedWithErrorIsEndedBefore] → True, if the last job chain run completed with an error before the given time.
| jobChain:lastCompletedIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedIsStartedBefore[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedIsStartedBefore[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedIsStartedBefore[-1:02:03:44]] |
- [lastCompletedIsStartedBefore] → True, if the last job chain run completed and was started before the given time.
| jobChain:lastCompletedIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedIsStartedBefore[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedIsStartedBefore[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedIsStartedBefore[-1:09:25:10]] |
- [lastCompletedSuccessfulIsStartedBefore] → True, if the last job chain run completed successfully and was started before the given time.
| jobChain:lastCompletedSuccessfulIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedSuccessfulIsStartedBefore[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedSuccessfulIsStartedBefore[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedSuccessfulIsStartedBefore[-1:09:25:10]] |
- [lastCompletedWithErrorIsStartedBefore] → True, if the last job chain run completed with an error and was started before the given time.
| jobChain:lastCompletedWithErrorIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedWithErrorIsStartedBefore[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].lastCompletedWithErrorIsStartedBefore[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].lastCompletedWithErrorIsStartedBefore[-1:09:25:10]] |
- [isStartedToday] → True, if any job chain run was started today. It doesn't matter whether the job chain run completed successfully or with an error or whether the job chain is still running.
| jobChain:isStartedToday, jobChain:path_to_jobChain/name_of_jobChain.isStartedToday jobChain:path_to_jobChain/name_of_jobChain[order_id].isStartedToday [e.g. jobChain:test01/myjobchain[myorder01].isStartedToday] |
- [isStartedTodayCompletedSuccessful] → True, if any job chain run was started and completed successfully today.
| jobChain:isCompletedTodaySuccessfully, jobChain:path_to_jobChain/name_of_jobChain.isCompletedTodaySuccessfully jobChain:path_to_jobChain/name_of_jobChain[order_id].isCompletedTodaySuccessfully [e.g. jobChain:test01/myjobchain[myorder01].isCompletedTodaySuccessfully] |
- [isStartedTodayCompletedWithError] → True, if any job chain run was started and completed with an error today.
| jobChain:isStartedTodayCompletedWithError, jobChain:path_to_jobChain/name_of_jobChain.isStartedTodayCompletedWithError jobChain:path_to_jobChain/name_of_jobChain[order_id].isStartedTodayCompletedWithError [e.g. jobChain:test01/myjobchain[myorder01].isStartedTodayCompletedWithError] |
- [isStartedTodayCompleted] → True, if any job chain was started and completed today.
| jobChain:isStartedTodayCompleted, jobChain:path_to_jobChain/name_of_jobChain.isStartedTodayCompleted jobChain:path_to_jobChain/name_of_jobChain[order_id].isStartedTodayCompleted [e.g. jobChain:test01/myjobchain[myorder01].isStartedTodayCompleted] |
- [isCompletedToday] → True, if any job chain run completed today. It doesn't matter whether the job chain run completed successfully or with an error.
| jobChain:isCompletedToday, jobChain:path_to_jobChain/name_of_jobChain.isCompletedToday jobChain:path_to_jobChain/name_of_jobChain[order_id].isCompletedToday [e.g. jobChain:test01/myjobchain[myorder01].isCompletedToday] |
- [isCompletedTodaySuccessfully] → True, if any job chain run completed successfully today.
| jobChain:isCompletedTodaySuccessfully, jobChain:path_to_jobChain/name_of_jobChain.isCompletedTodaySuccessfully jobChain:path_to_jobChain/name_of_jobChain[order_id].isCompletedTodaySuccessfully [e.g. jobChain:test01/myjobchain[myorder01].isCompletedTodaySuccessfully] |
- [isCompletedTodayWithError] → True, if any job chain run completed today with an error.
| jobChain:isCompletedTodayWithError, jobChain:path_to_jobChain/name_of_jobChain.isCompletedTodayWithError jobChain:path_to_jobChain/name_of_jobChain[order_id].isCompletedTodayWithError [e.g. jobChain:test01/myjobchain[myorder01].isCompletedTodayWithError] |
- [isCompletedAfter] → True, if any job chain run completed after the given time. It doesn't matter whether the run completed successfully or with an error.
| jobChain:isCompletedAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isCompletedAfter[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].isCompletedAfter[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].isCompletedAfter[1:09:25:10]] |
- [isCompletedWithErrorAfter] → True, if any job chain run completed with error after the given time.
| jobChain:isCompletedWithErrorAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isCompletedWithErrorAfter[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].isCompletedWithErrorAfter[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].isCompletedWithErrorAfter[1:09:25:10]] |
- [isCompletedSuccessfulAfter] → True, if any job chain run completed successfully after the given time.
| jobChain:isCompletedSuccessfulAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isCompletedSuccessfulAfter[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].isCompletedSuccessfulAfter[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].isCompletedSuccessfulAfter[1:09:25:10]] |
- [isStartedAfter] → True, if any job chain run was started after the given time. It doesn't matter whether the job chain run completed successfully or with an error.
| jobChain:isStartedAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isStartedAfter[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].isStartedAfter[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].isStartedAfter[1:09:25:10]] |
- [isStartedWithErrorAfter] → True, if any job chain run was started after the given time and raised an error.
| jobChain:isStartedWithErrorAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isStartedWithErrorAfter[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].isStartedWithErrorAfter[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].isStartedWithErrorAfter[1:09:25:10]] |
- [isStartedSuccessfulAfter] → True, if any job chain run started after the given time and completed successfully.
| jobChain:isStartedSuccessfulAfter[days:HH:MM:SS],
jobChain:path_to_jobChain/name_of_jobChain.isStartedSuccessfulAfter[0:HH:MM:SS] jobChain:path_to_jobChain/name_of_jobChain[order_id].isStartedSuccessfulAfter[0:HH:MM:SS] [e.g. jobChain:test01/myjobchain[myorder01].isStartedSuccessfulAfter[1:09:25:10]] |