UI overview
The Crosswork Workflow Manager 1.1 gives users access to the core functionalities of the CWM via a graphical interface.
The CWM UI dashboard contains three main functional areas which you can access from the navigation menu on the left:
-
Workflows: where you can add, manage, and delete workflow definitions.
-
Job Manager: where you can run added workflows, check the status of particular workflow execution (job) or view schedules.
-
Admin: where you can manage adapters, workers, secrets and resources.
Workflows
The main Workflows window consists of the All Workflows tab that lists workflows added to CWM with details and possible actions.
All Workflows
-
A) Workflow definition name: unique name of the workflow.
-
B) Definition ID: unique identifier assigned automatically after workflow creation.
-
C) Description: optional field used for describing your workflow functionality.
-
D) Version: indicates the current workflow version number, allows keeping track of the workflow versioning.
-
E) Workflow tags: shows tags assigned to a given workflow.
-
F) Actions: shows possible actions for a given workflow:
-
Run: starts a single execution of a given workflow (job).
-
Delete: removes an added workflow from CWM (this action is irreversible).
-
To adjust the columns displayed in the table, use the :gear: icon on the right side above the table.
You can use the filter table option to search the table for the specified value(s). By default, the filter fields are displayed; click the :material-filter: icon on the right to hide/unhide them.
Bulk actions on workflows
You can perform bulk actions on many workflows at once. To select a workflow, tick the checkbox on the right side of the All Workflows table. You have three possible bulk actions:
-
Edit tags: modifies tags for selected workflows by adding one or more or resetting them.
-
Export Selected: exports selected workflow entries to a CSV file.
-
Delete Selected: removes selected workflows from the list and CWM (this action is irreversible).
Job Manager
Job Manager allows you to check the status of your jobs and rerun or cancel their execution. The main Job Manager window consists of four tabs:
-
A) Active jobs: currently running jobs.
-
B) Completed jobs: successfully completed jobs.
-
C) Canceled jobs: manually terminated jobs by the user and automatically failed jobs.
-
D) Scheduled jobs: list of all schedules with details.
Note
The Scheduled jobs view displays only schedules and their details. Particular jobs of a given schedule can be found in respective tabs according to their status (for example, completed or active).
-
E) All jobs: all active, completed and canceled jobs.
Note |
The Job Manager view lists all workflow executions run in the last 24 hours. |
You can use the filter table option to search the table for the specified value(s). While filtering based on tags, you can filter by only one tag at once.
Note |
You can search for jobs based on multiple job tags via API. |
Bulk actions on jobs
You can perform bulk actions on many jobs at once. To select a job, tick the checkbox on the right side of the jobs table. Depending on the tab, you have different possible bulk actions:
-
Export Selected: exports selected job entries to a CSV file.
-
Cancel Selected: terminates currently running selected jobs (available only from the Active jobs tab).
Bulk actions on schedules
You can perform bulk actions on many schedules at once. To select a schedule, tick the checkbox on the right side of the Scheduled jobs table.
-
Export Selected: exports selected schedule entries to a CSV file.
-
Delete Selected: removes selected schedules from the list and CWM (this action is irreversible).
Job details
Procedure
Step 1 |
To check the details of a job, in the Job Manager choose the appropriate tab (Active, Completed, Cancelled or All). |
Step 2 |
In the table, click on the name of the job entry you want to check. |
Step 3 |
In the Details tab, you can check the following data for the given job:
|
Job Event Log
The Job Event Log lists the series of events that the workflow engine performs while executing the workflow definition.
-
A) Job Event Name: name of an event specific to CWM, for example
WorkflowExecution
. -
B) Job Event Type: type of the event used by the workflow engine, for example
WorkflowExecutionStarted
. -
C) Status: event execution status.
-
D) Attempts: number of attempts performed for completion of the task.
-
E) Worker: name of the worker performing the task.
-
F) Start Time: date and time when event execution started, for example
05-May-2023 03:59:25 PM CEST
. -
G) Close Time: date and time when event execution ended.
Note |
The Job Event Log view displays all events for given job (no pagination available in CWM 1.1, but you can filter them for more relevant result. |
Admin
Adapters
The Adapters tab displays a table listing all uploaded adapters. Above the table, there are various action buttons:
-
Add Adapter: allows you to upload adapter to CWM and and install it.
-
Export selected: downloads the CSV file with all details of the selected adapters.
-
A) Adapter name: unique adapter name.
-
B) Version: version of the added adapter.
-
C) Vendor: vendor name, as specified in the adapter properties.
-
D) Set as default: in this column, the adapter can have one of two possible statuses, depending on whether it is set as a default adapter to be used by workflow.
-
True: indicates the adapter is the default one for accociated activities.
-
False: indicates the adapter is not set as the default one.
-
-
E) In Use: in this column, the adapter can have one of two possible statuses, depending on whether it is currently in use, which determines if it can be deleted.
-
True: indicates the adapter is currently in use by one or more workflows and therefore cannot be deleted.
-
False: indicates the adapter is not in use by any workflow and can be deleted.
-
-
F) Actions:
-
Delete: removes uploaded adapter from CWM.
-
Install installs already uploaded adapter to CWM.
-
Workers
The Workers tab displays a table listing all existing workers. Above the table, there are various action buttons:
-
Add Worker: allows you to create a new worker and assign to it activities from already installed adapters.
-
Start Worker: starting the worker allows it to execute assigned tasks and changes the worker's status to running.
-
Stop Worker: stopping the worker allows it to execute pending actions but blocks its ability to accept new tasks. After clicking on the Stop Worker button, the confirmation modal Stop worker(s) appears. If the worker actively executes an ongoing task, you won't be able to stop it, unless you tick the checkbox Force stop. This action stops the worker regarding whether it performs any task and might cause the failure of ongoing jobs.
-
Delete: removes the worker permanently (this action is irreversible). If the worker is running, it's force stopped before deleting.
-
Export selected: downloads the CSV file with the details of the selected workers, including worker name, status and nr of activities.
-
A) Worker Name: unique worker's name. Once created, it cannot be modified.
-
B) Status: worker has three possible statuses visible in the CWM UI:
-
Initialized: worker status after creation, if you don't choose to start it immediately.
-
Running: indicates started worker available to execute tasks.
-
Stopped: indicates stopped worker unavailable for task execution.
-
-
C) Nr of activities: shows how many adapters' activities are assigned to the worker.
Resources
The Resources tab displays a table listing all added resources. Above the table, there are various action buttons:
-
Add Resource: allows you to add resource to CWM.
-
Export selected: downloads the CSV file with all details of the selected resources.
-
A) Resource name: unique resource name.
-
B) Resource type: resource type specified in the adapter files.
-
C) Secret ID: associated secret ID.
-
D) Actions:
-
Delete: removes resource from CWM
-
Secrets
The Secrets tab displays a table listing all added secrets. Above the table, there are various action buttons:
-
Add Secret: allows you to add secret to CWM.
-
Export selected: downloads the CSV file with all details of the selected secrets.
-
A) Secret ID: unique secret name.
-
B) Secret type: secret type specified in the adapter files.
-
C) Actions:
-
Delete: removes secret from CWM
-