Page History

...

Code Block

title	Usage

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
    --logaudit-dirmessage=<directory><string>              | optional: pathaudit tolog directorymessage
 holding the script's log files

  Switches:
 --audit-time-spent=<number>       -h | --help     optional: audit log time spent in minutes
    --audit-link=<url>                 | displays usageoptional: audit log link
    -v | -log-verbosedir=<directory>              | optional: path to directory holding the | displays verbose outputscript's log files

  Switches:
    -ph | --passwordhelp                        | asksdisplays for passwordusage
    -rv | --recursiveverbose                   | specifies folders| todisplays be looked up recursivelyverbose output
    -fp | --forcepassword                       | specifiesasks forcedfor startpassword
 or termination of jobs
   -r | --show-logsrecursive                   | specifies folders to be | shows log output if --log-dir is usedlooked up recursively
    -f | --force                       | specifies forced start or termination of jobs
    --makeshow-dirslogs                        | createsshows log directoriesoutput if they do not exist

Commands

 --log-dir is used
    --make-dirs                        | creates directories if they do not exist

Commands

add-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 optionally includes to forcibly terminate running jobs.
suspend-order, resume-order
- Suspends an order which optionally includes 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, get-notice, delete-notice
- Notices can be posted to resolve dependencies similar to use of the JS7 - PostNotices Instruction in workflows.
- Notices can be retrieved to check which workflow dependencies are resolved.
- Notices can be deleted to make workflows wait for dependencies as used with the JS7 - ExpectNotices Instruction and JS7 - ConsumeNotices Instruction.

...

--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
--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.
--password
- Specifies the password used for the account specified with the --user option for login to JOC Cockpit.
- Consider use of the -p switch offering a secure option for interactive keyboard input.
--controller-id
- Specifies the identification of the Controller that holds related orders.
--ca-cert
- Specifies the path to a file in PEM format 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 file in PEM format that holds the Client Certificate if HTTPS mutual authentication is used..
--client-key
- Specifies the path to a file in PEM format that holds the Client Private Key if HTTPS mutual authentication is used..
--timeout
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default: 15 seconds.
--order-name
- Specifies a qualifier that is added to newly created orders. Used with add-order command.
--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 with add-order command.
--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 and resume-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.
--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.
--variable
- One or more variables can be specified that hold key/value pairs separated by comma. Used with add-order and resume-order commands.
- Example: --variable="myVar1=myValue1,myVar2=myValue2"
--date-from
- Specifies the date and time in ISO format of the daily plan date, for example 2023-10-23. Used with cancel-order and suspend-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.
--date-to
- Specifies the date and time in ISO format of the daily plan date, for example 2023-10-23. Used with add-order, cancel-order,suspend-order, get-notice and delete-notice 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.
--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.
--state
- Specifies one or more states - separated by comma - for which orders should be processed. Used with cancel-order, suspend-order, resume-order and letrun-order commands.
- Valid states includePENDING, SCHEDULED, INPROGRESS, RUNNING, SUSPENDED, WAITING, PROMPTING, FAILED, BLOCKED.
- For example --state=SCHEDULED,SUSPENDED,FAILED will process orders holding any of the given states.
--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 the Cyclic-Check and Daily-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 and letrun-order commands.
- For example --order-id=#2024-08-25#T54565139012-sos,#2024-08-25#T56189833113-sos will process the indicated orders.
--label
- Specifies one or more labels - separated by comma - for jobs that should be processed. Used with stop-job, unstop-job, skip-job and unskip-job commands.
- For example --label=job1,job2 will consider jobs assigned the indicated labels.
--notice-board
- Specifies one or more JS7 - Notice Boards - separated by comma - that should be processed. Used with the post-notice, get-notice and delete-notice commands.
--notice-id
- Specifies the identifier of a notice, frequently the daily plan date is used, for example 2024-08-21. Used with the post-notice, get-notice and delete-notice commands.
--notice-lifetime
- Specifies the max. period for which the notice will be available. Periods such as 1h, 30m can be specified. Used with the post-notice command.
--audit-message
- Specifies a message that is made available for the Audit Log.
- Specification of Audit Log messages can be enforced on a per user basis and for a JS7 environment.
--audit-time-spent
- Specifies the time spent to perform an operation which is added to the Audit Log.
- The option can be specified if the --audit-message option is used.
--audit-link
- Specifies a link (URL) which is added to the Audit Log.
- The option can be specified if the --audit-message option is used.
--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: operate-workflow.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example: operate-workflow.2022-03-19T20-50-45.log

...

Space shortcuts

Page tree

Versions Compared

Old Version 22

New Version 23

Key

Commands

Commands