Page History
...
| Code Block | ||
|---|---|---|
| ||
Usage: operate-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]
get-notice [--notice-board] [--notice-id] [--folder] [--recursive] [--date-to]
delete-notice [--notice-board] [--notice-id] [--folder] [--recursive] [--date-to]
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 holds start position
--start-position=<label> | optional: label from which the order will be started
--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 scheduled date or notice date, default: now
--time-zone=<tz> | optional: time zone for dates, default: <current-time-zone>
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, orders, notice boards
--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 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
--audit-message=<string> | optional: audit log message
--audit-time-spent=<number> | optional: audit log time spent in minutes
--audit-link=<url> | optional: audit log link
--log-dir=<directory> | optional: path to directory holding the script's log files
Switches:
-h | --help | displays usage
-v | --verbose | displays verbose output, repeat to increase verbosity
-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 |
...
-h | --help- Displays usage.
-v | --verbose- Displays verbose log output that includes requests and responses with the JS7 REST Web Service.
- When used twice as with
-v -vthen curl verbose output will be displayed.
-p | --password- Asks the user for interactive keyboard input of the password used for the account specified with the
--useroption.. - 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
--folderoption is used.
- Specifies that folders will be looked up recursively if the
-f | --force- Specifies forcible processing. When used with the
add-ordercommand then JS7 - Admission Times for Jobs will be ignored and the job will be executed. When used withcancel-orderandsuspend-ordercommands then a currently running job will be terminated. See JS7 - FAQ - How does JobScheduler terminate Jobs.
- Specifies forcible processing. When used with the
--show-logs- Displays the log output created by the script if the
--log-diroption is used.
- Displays the log output created by the script if the
--make-dirs- If directories are missing that are indicated with the
--log-diroption then they will be created.
- If directories are missing that are indicated with the
...
Overview
Content Tools