Introduction
- The JS7 offers to perform any operation on orders, workflows, jobs and related objects by the JS7 - REST Web Service API.
- Note that any operation available with the JOC Cockpit GUI makes use of the REST Web Service API.
- For detailed information see the Technical Documentation of the REST Web Service API.
- The REST Web Service API can be accessed from Shell utilities such as
curl
. - In addition, a PowerShell module is available for simplified access to the REST Web Service API. This is described in the JS7 - PowerShell Module article.
The script introduced in this article can be used to perform frequently used operations on workflows, jobs and orders.
Workflow Management Script
The script is provided for download and can be used to automate operations on workflows, jobs and orders.
- The script is available for Linux and MacOS® using bash shell.
- The script terminates with exit code 0 to signal successful cancellation, with exit code 1 for command line argument errors and with exit code 4 for non-recoverable errors. Exit code 3 signals that no matching objects have been found.
- The script is intended as a baseline example for customization by JS7 users and by SOS within the scope of professional services. Examples make use of JS7 Release 2.7.2, curl 7.29.0 and jq 1.6.0.
Prerequisites
The Script requires the curl utility and the jq utility to be available from the operating system.
jq ships with the MIT license, see https://opensource.org/licenses/MIT.
Download
Download: manage-workflow.sh
Usage
Invoking the script without arguments displays the usage clause:
Usage
Usage: manage-workflow.sh [Command] [Options] [Switches] Commands: add-order --workflow [--date-to] [--order-name] [--block-position] [--start-position] [--end-position] [--variable] [--force] cancel-order [--workflow] [--folder] [--recursive] [--order-id] [--state] [--date-from] [--date-to] [--time-zone] [--force] suspend-order [--workflow] [--folder] [--recursive] [--order-id] [--state] [--date-from] [--date-to] [--time-zone] [--force] resume-order [--workflow] [--folder] [--recursive] [--order-id] [--state] [--label] [--variable] letrun-order [--workflow] [--folder] [--recursive] [--order-id] [--state] transfer-order --workflow] [--folder] [--recursive] suspend-workflow --workflow [--folder] [--recursive] resume-workflow --workflow [--folder] [--recursive] stop-job --workflow --label unstop-job --workflow --label skip-job --workflow --label unskip-job --workflow --label post-notice --notice-board [--notice-id] [--notice-lifetime] delete-notice --notice-board [--notice-id] Options: --url=<url> | required: JOC Cockpit URL --controller-id=<id> | required: Controller ID --user=<account> | required: JOC Cockpit user account --password=<password> | optional: JOC Cockpit password --ca-cert=<path> | optional: path to CA Certificate used for JOC Cockpit login --client-cert=<path> | optional: path to Client Certificate used for login --client-key=<path> | optional: path to Client Key used for login --timeout=<seconds> | optional: timeout for request, default: 15 --order-name=<string> | optional: name for order, default: <current user> --block-position=<label> | optional: label for block instruction that hold start position --start-position=<label> | optional: label from which the order will be added --end-position=<label[,label]> | optional: list of labels before which the order will terminate --variable=<key=value[,key=value]> | optional: list of variables holding key/value pairs --date-from=<date> | optional: order past scheduled date --date-to=<date> | optional: order future scheduled date, default: now --time-zone=<tz> | optional: time zone for the given date, default: Europe/Berlin see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones --state=<state[,state]> | optional: list of states limiting orders to be processed such as SCHEDULED, INPROGRESS, RUNNING, SUSPENDED, WAITING, FAILED --folder=<path[,path]> | optional: list of folders holding workflows or orders to be processed --workflow=<name[,name]> | optional: list of workflow names --order-id=<id[,id]> | optional: list of order identifiers --label=<label[,label]> | optional: list of labels for related jobs --notice-board=<name[,name]> | optional: list of notice boards --notice-id=<id> | optional: notice identifier, default: <current date> --notice-lifetime=<period> | optional: lifetime for notice --log-dir=<directory> | optional: path to the directory holding the script's log files Switches: -h | --help | displays usage -v | --verbose | displays verbose output -p | --password | asks for password -r | --recursive | specifies folders to be looked up recursively -f | --force | specifies forced start or termination of jobs --show-logs | shows log output if --log-dir is used --make-dirs | creates directories if they do not exist
Commands
add-order
- Adds an order to a workflow. Allows to specify the start position and end position in the workflow in case that specific jobs only should be executed.
cancel-order
- Terminates an order which can include to forcibly terminate running jobs.
suspend-order
,resume-order
- Suspends an order which can include to forcibly terminate running jobs.
- Resumes a previously suspended order, optionally from a different position in the workflow.
letrun-order
- Orders in the pending, scheduled or waiting state for a JS7 - Cycle Instruction or JS7 - Retry Instruction can be forced to run immediately.
transfer-order
- Orders attached a previous version of a workflow for which a newer version exists are transferred to the latest version of the workflow.
suspend-workflow
,resume-workflow
- Suspends the worfklow and freezes orders in the given workflow.
- Resumes a previously suspended workflow. Frozen orders will awake and will continue.
stop-job
,unstop-job
- Stopping a job will prevent the job from running. A stopped job will suspend orders arriving at the job label.
- Unstopping a previously stopped job will allow orders to execute the job. Suspended orders must be resumed to execute the job.
skip-job
,unskip-job
- Skipping a job will prevent the job from running. Orders will skip the job and will continue with the next instruction.
- Unskipping a previously skipped job will allow orders to execute the job.
post-notice
,delete-notice
- Notices can be posted to resolve dependencies similar to use of the JS7 - PostNotices Instruction in workflows.
- Notices can be deleted to make workflows wait for dependencies as used with the JS7 - ExpectNotices Instruction and JS7 - ConsumeNotices Instruction.
Options
--url
- Specifies the URL by which JOC Cockpit is accessible using
<http|https>://<host>:<port>
. - Example: http://centostest-primary.sos:4446
- Example: https://centostest-primary.sos:4443
- Specifies the URL by which JOC Cockpit is accessible using
--user
- Specifies the user account for login to JOC Cockpit. If JS7 - Identity Services are available for Client authentication certificates that are specified with the
--client-cert
and--client-key
options then their common name (CN) attribute has to match the user account. - If a user account is specified then a password can be specified using the
--password
option or interactive keyboard input can be prompted using the-p
switch.
- Specifies the user account for login to JOC Cockpit. If JS7 - Identity Services are available for Client authentication certificates that are specified with the
--password
- Specifies the password used for the account specified with the
--user
option to login to JOC Cockpit. - Consider use of the
-p
switch offering a secure option for interactive keyboard input.
- Specifies the password used for the account specified with the
--controller-id
- Specifies the identification of the Controller that holds related orders.
--cacert
- Specifies the path to a .pem file that holds the Root CA Certificate and optionally Intermediate CA Certificates to verify HTTPS connections to JOC Cockpit.
--client-cert
- Specifies the path to a .pem file that holds the Client Certificate if HTTPS mutual authentication is used..
--client-key
- Specifies the path to a .pem file that holds the Client Privae Key if HTTPS mutual authentication is used..
--timeout
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default:
15
seconds.
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default:
--order-name
- Specifies a qualifier that is added to newly created orders. Used with
add-order
command.
- Specifies a qualifier that is added to newly created orders. Used with
--block-position
- Specifies the label of a block instruction such as JS7 - Resource Locks, should the
--start-position
option be used for a position inside the block instruction. Used withadd-order
command.
- Specifies the label of a block instruction such as JS7 - Resource Locks, should the
--start-position
- Specifies the label of an instruction in the workflow from which the order is started, for example from a job. Used with
add-order
andresume-order
commands. - The label of a top-level instruction can be specified. For start positions from nested instructions the
--block-position
option has to be specified too.
- Specifies the label of an instruction in the workflow from which the order is started, for example from a job. Used with
--end-position
- Specifies the label of an instruction before which the order will terminate. More than one label can be specified separated by comma. Used with
add-order
command. - If the
--block-position
option is used then the end position is inside the block. Otherwise the order will terminate when reaching the block's end.
- Specifies the label of an instruction before which the order will terminate. More than one label can be specified separated by comma. Used with
--variable
- One or more variables can be specified that hold key/value pairs separated by comma. Used with
add-order
andresume-order
commands. - Example:
--variable="myVar1=myValue1,myVar2=myValue2"
- One or more variables can be specified that hold key/value pairs separated by comma. Used with
--date-from
- Specifies the date and time in ISO format of the daily plan date, for example
2023-10-23
. Used withcancel-order
andsuspend-order
commands. - Dates can be calculated from the
date
command, for example:--date-to="$(TZ=Europe/London date +'%Y-%m-%d')"
specifies the daily plan date before the current day in the Europe/London time zone.--date-to="$(TZ=Europe/London date --date="1 day ago" +'%Y-%m-%d')"
specifies the daily plan date before yesterday.
- Specifies the date and time in ISO format of the daily plan date, for example
--date-to
- Specifies the date and time in ISO format of the daily plan date, for example
2023-10-23
. Used withadd-order
,cancel-order
andsuspend-order
commands. - Dates can be calculated from the
date
command, for example:--date-to="$(TZ=Europe/London date +'%Y-%m-%d')"
specifies the daily plan date before the current day in the Europe/London time zone.--date-to="$(TZ=Europe/London date --date="1 day ago" +'%Y-%m-%d')"
specifies the daily plan date before yesterday.
- Specifies the date and time in ISO format of the daily plan date, for example
--time-zone
- Specifies the time zone to be used for the
--date-from
and--date-to
options. By default the system time zone is used. - The time zone is specified from an identifier as explained by https://en.wikipedia.org/wiki/List_of_tz_database_time_zones, for example
--time-zone=Europe/London
.
- Specifies the time zone to be used for the
--state
- Specifies one or more states - separated by comma - for which orders should be processed. Used with
cancel-order
,suspend-order
,resume-order
andletrun-order
commands. - Valid states include
PENDING, SCHEDULED, INPROGRESS, RUNNING, SUSPENDED, WAITING, PROMPTING, FAILED, BLOCKED
. - For example
--state=SCHEDULED,SUSPENDED,FAILED
will process orders holding any of the given states.
- Specifies one or more states - separated by comma - for which orders should be processed. Used with
--folder
- Specifies one or more inventory folders from absolute paths - separated by comma - holding workflows that should be processed.
- For example
--folder=/ProductDemo/CyclicExecution,/ProductDemo/ScheduledExecution
will process workflows in the given folders. - If the
--recursive
switch is used then sub-folders will be looked up recursively.
--workflow
- Specifies one or more workflows - separated by comma - that should be processed. Used with most of the commands.
- For example
--workflow=Cyclic-Check,Daily-EOD
will consider theCyclic-Check
andDaily-EOD
workflows.
--order-id
- Specifies one or more order identifiers - separated by comma - for which orders should be processed. Used with
cancel-order
,suspend-order
,resume-order
andletrun-order
commands. - For example
--order-id=#2024-08-25#T54565139012-sos,#2024-08-25#T56189833113-sos
will process the indicated orders.
- Specifies one or more order identifiers - separated by comma - for which orders should be processed. Used with
--label
- Specifies one or more labels - separated by comma - for jobs that should be processed. Used with
stop-job
,unstop-job
,skip-job
andunskip-job
commands. - For example
--label=job1,job2
will consider jobs assigned the indicated labels.
- Specifies one or more labels - separated by comma - for jobs that should be processed. Used with
--notice-board
- Specifies one or more JS7 - Notice Boards - separated by comma - that should be processed. Used with the
post-notice
anddelete-notice
commands.
- Specifies one or more JS7 - Notice Boards - separated by comma - that should be processed. Used with the
--notice-id
- Specifies the identifier of a notice, frequently the daily plan date is used, for example
2024-08-21
. Used with thepost-notice
anddelete-notice
commands.
- Specifies the identifier of a notice, frequently the daily plan date is used, for example
--notice-lifetime
- Specifies the max. period for which the notice will be available. Periods such as
1h
,30m
can be specified. Used with thepost-notice
command.
- Specifies the max. period for which the notice will be available. Periods such as
--log-dir
- If a log directory is specified then the script will log information about processing steps to a log file in this directory.
- File names are created according to the pattern:
manage-workflow.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example:
manage-workflow.2022-03-19T20-50-45.log
Switches
-h | --help
- Displays usage.
-v | --verbose
- Displays verbose log output that includes requests and responses with the JS7 REST Web Service.
-p | --password
- Asks the user for interactive keyboard input of the password used for the account specified with the
--user
option.. - The switch is used for secure interactive input as an alternative to use of the option
--password=<password>
.
- Asks the user for interactive keyboard input of the password used for the account specified with the
-r | --recursive
- Specifies that folders will be looked up recursively if the
--workflow-folders
or--schedule-folders
option is used.
- Specifies that folders will be looked up recursively if the
-f | --force
- Specifies forcible processing. When used with the
add-order
command then JS7 - Admission Times for Jobs will be ignored and the job will be executed. When used withcancel-order
andsuspend-order
commands then a currently running job will be terminated. See JS7 - FAQ - Does JS7 reliably kill running jobs.
- Specifies forcible processing. When used with the
--show-logs
- Displays the log output created by the script if the
--log-dir
option is used.
- Displays the log output created by the script if the
--make-dirs
- If directories are missing that are indicated with the
--log-dir
option then they will be created.
- If directories are missing that are indicated with the
Exit Codes
0:
cancellation of orders successfully initiated1
: argument errors3
: no objects found4
: JS7 REST Web Service is not reachable or reports errors
Examples
The following examples illustrate typical use cases.
Adding Orders
Examples for AddingOrders
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # add ad hoc order ./manage-workflow.sh add-order ${request_options[@]} \ --workflow=ap3jobs # add ad hoc order for specific job ./manage-workflow.sh add-order ${request_options[@]} \ --workflow=ap3jobs --start-position=job2 --end-position=job3 # add pending order ./manage-workflow.sh add-order ${request_options[@]} \ --workflow=ap3jobs --date-to=never # add scheduled order and force admission ./manage-workflow.sh add-order ${request_options[@]} \ --workflow=ap3jobs --order-name=sample-1 --date-to=now+15 --force
Cancelling Orders
Examples for Cancelling Orders
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # cancel orders by state ./manage-workflow.sh cancel-order ${request_options[@]} \ --workflow=ap3jobs --date-to=-2h --state=SCHEDULED,PROMPTING,SUSPENDED,INPROGRESS,RUNNING # cancel orders by state, yesterday's start date, folder recursively ./manage-workflow.sh cancel-order ${request_options[@]} \ --folder=/ap --recursive --date-to="$(TZ=Europe/London date +'%Y-%m-%d')" --state=SCHEDULED,PROMPTING,SUSPENDED,INPROGRESS,RUNNING
Suspending and Resuming Orders
Examples for Suspending and Resuming Orders
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # suspend orders in workflow ./manage-workflow.sh suspend-order ${request_options[@]} \ --workflow=ap3jobs # suspend orders in workflow and terminate running job ./manage-workflow.sh suspend-order ${request_options[@]} \ --workflow=ap3jobs -force # resume suspended orders in workflow ./manage-workflow.sh resume-order ${request_options[@]} \ --workflow=ap3jobs --state=SUSPENDED
Letting run Orders
Example for Letting Run Orders
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # let run waiting orders in workflow ./manage-workflow.sh letrun-order ${request_options[@]} \ --workflow=ap3jobs --state=WAITING
Transferring Orders
Example for Transferring Orders
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # transfer orders to latest workflow version ./manage-workflow.sh transfer-order ${request_options[@]} \ --workflow=ap3jobs
Suspending and Resuming Workflows
Example for Suspending and Resuming Workflows
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # suspend workflow ./manage-workflow.sh suspend-workflow ${request_options[@]} \ --workflow=ap3jobs # resume workflow ./manage-workflow.sh resume-workflow ${request_options[@]} \ --workflow=ap3jobs
Stopping and Unstopping Jobs
Example for Stopping and Unstopping Jobs
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # stop jobs from labels ./manage-workflow.sh stop-job ${request_options[@]} \ --workflow=ap3jobs --label=job1,job2 # unstop jobs from labels ./manage-workflow.sh unstop-job ${request_options[@]} \ --workflow=ap3jobs --label=job1,job2
Skipping and Unskipping Jobs
Example for Skipping and Unskipping Jobs
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # skip jobs from labels ./manage-workflow.sh skip-job ${request_options[@]} \ --workflow=ap3jobs --label=job1,job2 # unskip jobs from labels ./manage-workflow.sh unskip-job -${request_options[@]} \ --workflow=ap3jobs --label=job1,job2
Posting and Deleting Notices
Example for Posting and Deleting Notices
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # post notice for current daily plan date ./manage-workflow.sh post-notice ${request_options[@]} \ --notice-board=ap3jobs # post notice for specific daily plan date and lifetime ./manage-workflow.sh post-notice ${request_options[@]} \ --notice-board=ap3jobs --notice-id=2024-08-26 --notice-lifetime=6h # delete notices for current daily plan date ./manage-workflow.sh delete-notice ${request_options[@]} \ --notice-board=ap3jobs # delete notices for notice board and notice identifiers ./manage-workflow.sh delete-notice ${request_options[@]} \ --notice-board=ap3jobs --notice-id=2024-08-25,2024-08-26
Resources
Overview
Content Tools