Jobs
After completing the instructions described in Initial setup, you are ready to start executing workflows.
In the CWM application, a particular execution of workflow definition is called a job, and by following guidelines in this chapter, you can:
-
start a job immediately, or
-
create a schedule to run planned jobs in the future.
Run job
This section explains how to run a job (workflow execution) via CWM.
Prerequisites: A workflow definition stored in CWM and listed in the All Workflows tab; uploaded adapter(s) with workers.
Procedure
Step 1 |
In CWM, go to the Workflows -> All Workflows tab. Select the workflow you want to execute and click Run under the Actions column. |
||
Step 2 |
In the Run job modal, insert the initial workflow data input in the Input variables field. |
||
Step 3 |
By default, your job’s name is the same as your workflow definition, but you can change it in the Job name field. |
||
Step 4 |
Optionally, you can assign tags to your job. To insert more than one tag, separate them with a comma.
|
||
Step 5 |
Leave the radio button Start directly selected to run your job immediately. If you want to create a schedule for the future run, follow the Schedule Job instructions. |
||
Step 6 |
Click Run job to start the workflow execution. |
Check job status
Procedure
Step 1 |
Go to the Job Manager -> All Jobs tab. |
Step 2 |
In the All jobs table, find your job and check the status of the workflow execution in the Status column.
|
Check job result
Procedure
Step 1 |
Click the job name to enter its details. |
Step 2 |
In the Job Event Log table, you can expand every event entry by clicking on the :material-plus-box-outline: icon. |
Step 3 |
To check the result of the execution, expand the WorkflowExecution entry at the bottom of the table. Depending on the result, the Job Event Type may differ, for example: |
Check parent-child workflow relation
Identify child workflow runs
If a job run has been triggered as a child workflow, its job name is created following the schema below:
parent_job_run_name. + child_workflow_def_name. + child_workflow def_version.
For example, if a parent job run name is "Parent", and the child workflow definition name is "Child", the job run executed as child workflow is named "Parent.Child.1.0".
Find child workflow runs from the Job Event Log
If a given job run triggers child workflow executions, you can check them under the Job Even Log table of the parent run.
Procedure
Step 1 |
Click the job name to enter its details. |
||
Step 2 |
In the Job Event Log table, under the Job Event Type entry, search for the |
||
Step 3 |
On the child job Details page, besides standard fields, you can find the Parent Run ID that redirects to the details of the parent job run.
|
Rerun job
Procedure
Step 1 |
Go to the Job Manager -> All jobs tab. |
Step 2 |
In the All jobs table, find a job that you want to rerun and click the Rerun button in the same row under the Actions column. |
Step 3 |
In the Rerun job modal, you can edit the Job name, Tags and Input variables (data input) or use the same values from the previous run. |
Step 4 |
Click Run job. |
Cancel job
Procedure
Step 1 |
Go to the Job Manager -> Active jobs tab. |
||
Step 2 |
In the Active jobs table, find a job that you want to cancel and click the Cancel button in the same row under the Actions column. |
||
Step 3 |
In the Cancel job modal, you can enter an optional Reason for cancelling. |
||
Step 4 |
Tick Force terminate checkbox if you want to cancel the running job immediately. If you leave this checkbox unticked, the workflow worker will complete the ongoing task execution from the workflow definition and then cancel the job. |
||
Step 5 |
Click Cancel Job. Details tab.
|
Schedule job
This section explains how to schedule a single job run (workflow execution) or recurring runs that are invoked in the future.
Prerequisites: A workflow definition added to CWM and listed in the All Workflows tab; uploaded adapter(s) with workers.
Procedure
Step 1 |
In CWM, go to the Workflows -> All Workflows tab. Select the workflow you want to schedule and click Run under the Actions column. |
||
Step 2 |
In the Run job modal, insert the initial workflow data input in the Input variables field. Each scheduled run of a workflow receives identical input variables. |
||
Step 3 |
By default, your job name is the same as your workflow definition name, but you can change it in the Job name field. |
||
Step 4 |
Optionally, you can assign tags to your scheduled job(s). To insert more than one tag, separate them with a comma. All jobs in the schedule will have the same tags set. |
||
Step 5 |
Choose one scheduling option depending on whether you planned a single run in the future or a recurring series of runs. |
||
Step 6 |
Type a unique name for your schedule in the Schedule ID field. |
||
Step 7 |
Click Schedule Job to schedule the workflow execution(s).
|
Check scheduled jobs
All schedules are displayed under the Scheduled jobs tab.
Procedure
Step 1 |
Go to the Job Manager -> Scheduled jobs tab. |
||
Step 2 |
In the Scheduled jobs table, you can find all the schedules with details:
|
Delete schedule
You can delete a whole schedule via CWM UI. This process will delete all future planned jobs in a schedule, but will not terminate or affect a job that is already in execution. Already started scheduled workflow execution can be canceled using the Cancel Job action.
Procedure
Step 1 |
Go to the Job Manager -> Scheduled Jobs tab. |
Step 2 |
In the Scheduled Jobs table, find a schedule that you want to delete and click the Delete button in the same row under the Actions column. |