List of Expressions
A job will be executed only if the Expressions of its In Condition will be evaluated to true.
There are different types of Expressions available for conditions in Job Streams that are explained below:
S.No. | Expression Name | Description | In Conditions Examples | Out Conditions 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 | fileexist:path_to_file/filename [e.g. fileexist:config/one.txt] |
| C:/data/inbound/one.txt | C:/data/inbound/one.txt | ||
| config/one.txt | 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 [Syntax] | |
The global event can be specified by the keyword "global"
| 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[*] | |||
| global:name_of_event[today], global:jobStream.name_of_event[today] | |||
| global:name_of_event[yesterday], global:jobStream.name_of_event[yesterday] | |||
| global:name_of_event[yesterday - 2], global:jobStream.name_of_event[yesterday - 2] | |||
| global:name_of_event[prev], global:jobStream.name_of_event[prev] | |||
| global:name_of_event[prevSuccessful], global:jobStream.name_of_event[prevSuccessful] | |||
| global:name_of_event[prevError], | |||
| global:name_of_event[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 evaluate 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: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[*] | |||
| event:name_of_event[today], event:jobStream.name_of_event[today] | |||
| event:name_of_event[yesterday], event:jobStream.name_of_event[yesterday] | |||
| event:name_of_event[yesterday - 2], event:jobStream.name_of_event[yesterday - 2] | |||
| event:name_of_event[prev], event:jobStream.name_of_event[prev] | |||
| event:name_of_event[prevSuccessful], event:jobStream.name_of_event[prevSuccessful] | |||
| event:name_of_event[prevError], | |||
| event:name_of_event[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 | |||
| job:lastCompletedRunEndedSuccessful, job:path_to_job/name_of_job.lastCompletedRunEndedSuccessful | |||
| job:lastCompletedRunEndedWithError, job:path_to_job/name_of_job.lastCompletedRunEndedWithError | |||
| job:lastCompletedRunEndedTodaySuccessful, job:path_to_job/name_of_job.lastCompletedRunEndedTodaySuccessful | |||
| job:lastCompletedRunEndedTodayWithError, job:path_to_job/name_of_job.lastCompletedRunEndedTodayWithError | |||
| job:lastCompletedIsEndedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedIsEndedBefore[0:HH:MM:SS] | |||
| job:lastCompletedSuccessulIsEndedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedSuccessulIsEndedBefore[0:HH:MM:SS] | |||
| job:lastCompletedWithErrorIsEndedBefore[days:HH:MM:SS], | |||
| job:lastCompletedIsStartedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedIsStartedBefore[0:HH:MM:SS] | |||
| job:lastCompletedSuccessfulIsStartedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedSuccessfulIsStartedBefore[0:HH:MM:SS] | |||
| job:lastCompletedWithErrorIsStartedBefore[days:HH:MM:SS], job:path_to_job/name_of_job.lastCompletedWithErrorIsStartedBefore[0:HH:MM:SS] | |||
| job:isStartedToday, job:path_to_job/name_of_job.isStartedToday | |||
| job:isStartedTodayCompletedSuccessful, job:path_to_job/name_of_job.isStartedTodayCompletedSuccessful | |||
| job:isStartedTodayCompletedWithError, job:path_to_job/name_of_job.isStartedTodayCompletedWithError | |||
| job:isStartedTodayCompleted, job:path_to_job/name_of_job.isStartedTodayCompleted | |||
| job:isCompletedToday, job:path_to_job/name_of_job.isCompletedToday | |||
| job:path_to_job/isCompletedTodaySuccessfully, job:path_to_job/name_of_job.isCompletedTodaySuccessfully | |||
| job:isCompletedTodayWithError, job:path_to_job/name_of_job.isCompletedTodayWithError | |||
| job:isCompletedAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isCompletedAfter[0:HH:MM:SS] | |||
| job:isCompletedWithErrorAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isCompletedWithErrorAfter[0:HH:MM:SS] | |||
| job:isCompletedAfter[days:HH:MM:SS], | |||
| job:isStartedAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isStartedAfter[0:HH:MM:SS] | |||
| job:isStartedWithErrorAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isStartedWithErrorAfter[0:HH:MM:SS] | |||
| job:isStartedSuccessfulAfter[days:HH:MM:SS], job:path_to_job/name_of_job.isStartedSuccessfulAfter[0:HH:MM:SS] | |||
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 | |
| jobChain:rc, jobChain:name_of_jobChain.rc | |||
| jobChain:lastCompletedRunEndedSuccessful, | |||
| jobChain:lastCompletedRunEndedWithError, jobChain:path_to_jobChain/name_of_jobChain.lastCompletedRunEndedWithError | |||
| jobChain:lastCompletedRunEndedTodaySuccessful, jobChain:path_to_jobChain/name_of_jobChain.lastCompletedRunEndedTodaySuccessful | |||
| jobChain:lastCompletedRunEndedTodayWithError, jobChain:path_to_jobChain/name_of_jobChain.lastCompletedRunEndedTodayWithError | |||
| jobChain:lastCompletedIsEndedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedIsEndedBefore[0:HH:MM:SS] | |||
| jobChain:lastCompletedSuccessulIsEndedBefore[days:HH:MM:SS]], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedSuccessulIsEndedBefore[0:HH:MM:SS] | |||
| jobChain:lastCompletedIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedIsStartedBefore[0:HH:MM:SS] | |||
| jobChain:lastCompletedIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedIsStartedBefore[0:HH:MM:SS] | |||
| jobChain:lastCompletedSuccessfulIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedSuccessfulIsStartedBefore[0:HH:MM:SS] | |||
| jobChain:lastCompletedWithErrorIsStartedBefore[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.lastCompletedWithErrorIsStartedBefore[0:HH:MM:SS] | |||
| jobChain:isStartedToday, jobChain:path_to_jobChain/name_of_jobChain.isStartedToday | |||
| jobChain:isCompletedTodaySuccessfully, jobChain:path_to_jobChain/name_of_jobChain.isCompletedTodaySuccessfully | |||
| jobChain:isStartedTodayCompletedWithError, jobChain:path_to_jobChain/name_of_jobChain.isStartedTodayCompletedWithError | |||
| jobChain:isStartedTodayCompleted, jobChain:path_to_jobChain/name_of_jobChain.isStartedTodayCompleted | |||
| jobChain:isCompletedToday, jobChain:path_to_jobChain/name_of_jobChain.isCompletedToday | |||
| jobChain:isCompletedTodaySuccessfully, jobChain:path_to_jobChain/name_of_jobChain.isCompletedTodaySuccessfully | |||
| jobChain:isCompletedTodayWithError, jobChain:path_to_jobChain/name_of_jobChain.isCompletedTodayWithError | |||
| jobChain:isCompletedAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isCompletedAfter[0:HH:MM:SS] | |||
| jobChain:isCompletedWithErrorAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isCompletedWithErrorAfter[0:HH:MM:SS] | |||
| jobChain:isCompletedSuccessfulAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isCompletedSuccessfulAfter[0:HH:MM:SS] | |||
| jobChain:isStartedAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isStartedAfter[0:HH:MM:SS] | |||
| jobChain:isStartedWithErrorAfter[days:HH:MM:SS], jobChain:path_to_jobChain/name_of_jobChain.isStartedWithErrorAfter[0:HH:MM:SS] | |||
| jobChain:isStartedSuccessfulAfter[days:HH:MM:SS], |
Syntax description for job / job chain
Syntax for job:
- job:path_to_job/name_of_job.<expression>
- path_to_job: select the job from the tree.
- name_of_job: select the job from the folder.
Example: job:test001/job1.isCompletedToday
- job:path_to_job/name_of_job.<expression>[days:HH:MM:SS]
- path_to_job: select the job from the tree.
- name_of_job: select the job from the folder.
- [days:HH:MM:SS]: specify the time, for example, for yesterday 3 AM use "-1:03:00:00".
Example: job:test001/job1.isStartedToday[-1:03:00:00]
Syntax for job chain:
- jobChain:path_to_jobChain/name_of_jobChain.<expression>
- path_to_jobChain → select the job chain from the tree.
- name_of_jobChain → select the job chain from the folder.
Example: jobChain:test002/testjobchainA.isStartedToday
- jobChain:path_to_jobChain/name_of_jobChain.<expression>[days:HH:MM:SS]
- path_to_jobChain → select the job chain from the tree.
- name_of_jobChain → select the job chain from the folder.
- [days:HH:MM:SS] → specify the time, for example, for yesterday 3 AM use "-1:03:00:00".
Example: jobChain:test002/testjobchainB.lastCompletedSuccessfulIsStartedBefore[-1:03:00:00]
- jobChain:path_to_jobChain/name_of_jobChain[order_id].isStartedSuccessfulAfter[0:HH:MM:SS]
- path_to_jobChain → select the job chain from the tree.
- name_of_jobChain → select the job chain from the folder.
- [order_id] → specify the Order ID for the job chain.
- [days:HH:MM:SS] → specify the time, for example, for today 5 AM use "0:05:00:00".
Example: jobChain:test003/testjobchainC.isStartedSuccessfulAfter[0:05:00:00].