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 Workflow Deployment Script offered for Unix Shell can be used to perform frequently used operations on workflows, jobs and orders. For details see

...

deployment operations.

Workflow Deployment Script

Operation	Object	Documentation
export	Workflow	JS7 - Inventory Export and Import

...

import
import-deploy		JS7 - Secure Deployment of Scheduling Objects

...


deploy		JS7 -

...

Deployment of Scheduling Objects

...

release

The script is provided offered for download and can be used as a command line interface to operations on workflows, jobs and orders.for deployment operations:

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, bash 4.2, curl 7.29.0 and jq 1.6.0.

...

Code Block

title	Usage

Usage: deploy-workflow.sh [Command] [Options] [Switches]

  Commands:
    export            --file [--format] --path --type
    export            --file [--format] --folder [--recursive] [--type]
                     [--use-short-path] [--for-signing] [--no-draft] [--no-deployed] [--no-released] [--no-invalid]
    import            --file [--format] [--folder] [--overwrite] [--prefix] [--suffix]
    import-deploy     --file [--format] [--folder] [--algorithm]
    deploy            --path --type [--date-from] [--delete] [--no-draft] [--no-deployed]
     deploy            --folder [--recursive] [--date-from] [--delete] [--no-draft] [--no-deployed]
     release           --path --type [--date-from] [--delete]
    release           --folder [--recursive] [--date-from] [--delete]

  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
    --file=<path>                      | optional: path to export file or import file
    --format=<ZIP|TAR_GZ>              | optional: format of export file or import file
    --folder=<folder[,folder]>         | optional: list of inventory folders holding objects
    --path=<path[,path]>               | optional: list of inventory paths to objects
    --type=<type[,type]>               | optional: list of object types such as
                                                   WORKFLOW,FILEORDERSOURCE,JOBRESOURCE,NOTICEBOARD,LOCK
    --prefix=<string>                  | optional: prefix for duplicate objects on import
    --suffix=<string>                  | optional: suffix for duplicate objects on import
    --date-from=<date>                 | optional: update daily plan start date for deploy/release operation
    --time-zone=<tz>                   | optional: time zone for dates, default: Europe/Berlin
                                                   see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    --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
    -p | --password                    | asks for password
    -r | --recursive                   | specifies folders to be looked up recursively
    -d | --delete                      | deletes deployed/released objects
    -o | --overwrite                   | overwrites objects on import
    -s | --for-signing                 | exports objects for digital signing
    -u | --use-short-path              | exports relative paths
    --no-draft                         | does not process draft objects
    --no-deployed                      | does not process deployed objects
    --no-released                      | does not process released objects
    --no-invalid                       | does not process invalid objects
    --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 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.

Options

export
- Allows to export scheduling objects such as workflows to an archive file in .zip or .tar.gz format. The command comes in two flavors:
  - export individual objects specified by the --path and --type options.
    - Deployable object types include: WORKFLOW, FILEORDERSOURCE, JOBRESOURCE, NOTICEBOARD, LOCK
    - Releasable object types include: INCLUDESCRIPT, SCHEDULE, WORKINGDAYSCALENDAR, JOBTEMPLATE, REPORT
  - export objects from folders using the --folder and --recursive options.
    - Optionally the object type can be specified and otherwise all objects will be exported.
- The archive file is specified from the --file and --format options.
import
- Imports an archive file to the inventory.
- Users can specify if existing objects will be overwritten or if duplicate objects from the import file will be assigned a prefix or suffix.
import-deploy
- Imports an archive file to the inventory and deploys the included objects. The operation is applicable if JOC Cockpit is operated for the high security level.
  - As a prerequisite an archive file must have been exported using the --for-signing option.
  - Workflows and Job Resources from the archive file have been digitally signed by the user. Signature files have been added to the archive file.
- On import the objects in the archive file are deployed to related Controllers.
deploy
- Allows to deploy objects such as workflows. The command can be used in two flavors:
  - deploy individual objects specified by the --path and --type options.
  - deploy objects from folders using the --folder and --recursive options.
- Deletion of objects from a Controller is similarly considered a deplyoment operation.
release
- Allows to release objects such as schedules. The command can be used in two flavors:
  - release individual objects specified by the --path and --type options.
  - release objects from folders using the --folder and --recursive options.
- Revocation of objects is similarly considered a release operation..

Options

--url
- Specifies
--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-namefile
- Specifies a qualifier that is added to newly created orders. Used with add-order commandthe location of the archive file that is used with export, import and import-deploy operations.
- On export an existing archive file will be overwritten.
--block-positionformat
- 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 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.
--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.
--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

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>.
-r | --recursive
- Specifies that folders will be looked up recursively if the --folders option is used.
-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 with cancel-order and suspend-order commands then a currently running job will be terminated. See JS7 - FAQ - How does JobScheduler terminate Jobs.
--show-logs
- Displays the log output created by the script if the --log-dir option is used.
--make-dirs
- If directories are missing that are indicated with the --log-dir option then they will be created.

Exit Codes

0: cancellation of orders successfully initiated
1: argument errors
3: no objects found
4: JS7 REST Web Service is not reachable or reports errors

Examples

The following examples illustrate typical use cases.

Adding Orders

Code Block

title	Examples for Adding Orders
linenumbers	true

# 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
./operate-workflow.sh add-order ${request_options[@]} \
	--workflow=ap3jobs

# add ad hoc order for specific job
./operate-workflow.sh add-order ${request_options[@]} \
	--workflow=ap3jobs --start-position=job2 --end-position=job3

# add pending order
./operate-workflow.sh add-order ${request_options[@]} \
	--workflow=ap3jobs --date-to=never

# add scheduled order and force admission
./operate-workflow.sh add-order ${request_options[@]} \
	--workflow=ap3jobs --order-name=sample-1 --date-to=now+15 --force

Cancelling Orders

Code Block

title	Examples for Cancelling Orders
linenumbers	true

# 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
./operate-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
./operate-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

Code Block

title	Examples for Suspending and Resuming Orders
linenumbers	true

# 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
./operate-workflow.sh suspend-order ${request_options[@]} \
	--workflow=ap3jobs

# suspend orders in workflow and terminate running job
./operate-workflow.sh suspend-order ${request_options[@]} \
	--workflow=ap3jobs --force

# resume suspended orders in workflow
./operate-workflow.sh resume-order ${request_options[@]} \
	--workflow=ap3jobs --state=SUSPENDED

Letting run Orders

- format of the archive file indicated with the --file option.
- The format can be one of ZIP or TAR_GZ. Default: ZIP. The JS7 can process archive files in .zip format on Unix.
--folder
- Specifies the inventory folder used for the related operation.
  - Folder specification starts from a / followed by a hierarchy of sub-folders.
  - More than one folder can be specified using comma as in --folder=/ProductDemo/AgentCluster,/ProductDemo/ScheduledExecution.
- When used with the import and import-deploy operations a single folder can be specified that is prepended the folders included with the archive file.
--path
- Specifies the path of an object such as a workflow, job resource, schedule. A path starts from a /, optionally followed by a hierarchy of sub-folders, and the object name.
- Objects are identified from thier path and object type.
--type
- Specifies the object type such as a workflow that is indicated together with the --path option to identify an object.
  - Deployable object types include: WORKFLOW, FILEORDERSOURCE, JOBRESOURCE, NOTICEBOARD, LOCK
  - Releasable object types include: INCLUDESCRIPT, SCHEDULE, WORKINGDAYSCALENDAR, JOBTEMPLATE, REPORT
- When used with the export operation for folders then more than one type can be specified separated by comma, for example --type=WORKFLOW,JOBRESOURCE
--prefix
- When used with the import operation then a prefix can be specified that is prepended any objects that are imported.
- If an object with the same prefix exists, then it will not be imported.
--suffix
- When used with the import operation then a suffix can be specified that is appended any objects that are imported.
- If an object with the same suffix exists, then it will not be imported.
--date-from
- Specifies the date starting from which the Daily Plan will be updated:
  - The --date-from=now value specifies that the Daily Plan will be updated for orders starting from now.
  - The Daily Plan date in ISO date format can be specified, for example --date-from=2023-10-23.
  - If omitted then the Daily Plan will not be updated.
- Orders in the Daily Plan can be updated if the underlying workflow or schedule is changed.
--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: deploy-workflow.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example: deploy-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>.
-r | --recursive
- Specifies that folders will be looked up recursively if the --folder option is used.
-d | --delete
- Specifies that objects should be deleted from the inventory.
- Deployable objects will be revoked from the Controller. Releasable objects will be recalled.
-o | --overwrite
- Specifies that objects with the same name and type will be overwritten when used with the import operation.
-s | --for-signing
- Specifies that objects are exported for digital signing when used with the export operation. For JS7 environments operated for the high security level digitally signed objects can be imported using the import-deploy operation.
-u | --use-short-path
- Specifies that relative object paths will be applied to the archive file will used with the export operation.
- An object path /a/b/c/workflow will be add as /c/workflow to the archive file. A folder /a/b/c will be added as /c to the archive file.
--no-draft
- Specifies that no draft objects will be processed when used with the export and deploy operations.
--no-deployed
- Specifies that no objects in deployed status will be processed when used with the export and deploy operations.
--no-released
- Specifies that no objects in released status will be processed when used with the export operation.
--no-invalid
- Specifies that only valid objects will be processed when used with the export operation.
--show-logs
- Displays the log output created by the script if the --log-dir option is used.
--make-dirs
- If directories are missing that are indicated with the --log-dir option then they will be created.

Exit Codes

0: operation successful
1: argument errors
3: no objects found
4: JS7 REST Web Service is not reachable or reports errors

Examples

The following examples illustrate typical use cases.

Exporting Objects

Code Block

language	bash
title	Examples for Exporting Objects

Code Block

title	Example for Letting Run Orders
linenumbers	true

# 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 workflowexport workflows
./operatedeploy-workflow.sh letrun-orderexport ${request_options[@]} \
	    --file=export.zip --workflowpath=/ap/ap3jobs,/ap/Agent/apRunAsUser --state=WAITING

Transferring Orders

Code Block

title	Example for Transferring Orders
linenumbers	true

# 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
./operate-workflow.sh transfer-ordertype=WORKFLOW

# export schedules
./deploy-workflow.sh export ${request_options[@]} \
    --file=export.zip --path=/ap/Agent/apAgentSchedule01,/ap/Agent/apAgentSchedule02 --type=SCHEDULE

# export objects from folder
./deploy-workflow.sh export-folder ${request_options[@]} \
	--workflow=ap3jobs

Suspending and Resuming Workflows

Code Block

title	Example for Suspending and Resuming Workflows
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)

# suspend workflow
./operate\
    --file=export.zip --folder=/ap --recursive

# export objects from folder using relative path
./deploy-workflow.sh suspendexport-workflowfolder ${request_options[@]} \
	    --file=export.zip --workflow=ap3jobsfolder=/ap/Agent --recursive --use-short-path

# resume workflow export objects from folder, feeding audit log
./operatedeploy-workflow.sh resumeexport-workflowfolder ${request_options[@]} \
	--workflow=ap3jobs

Stopping and Unstopping Jobs

    --file=export.zip --folder=/ap --recursive --audit-message="export to production"

Importing Objects

Code Block

language	bash
title	Examples for Importing Objects

Code Block

title	Example for Stopping and Unstopping Jobs
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)

# stop# jobsimport from labelsobjects
./operatedeploy-workflow.sh stop-jobimport ${request_options[@]} \
	    --workflowfile=ap3jobsexport.zip --label=job1,job2overwrite

# unstop jobs from labels import objects to a new top-level folder and apply suffix
./operatedeploy-workflow.sh unstop-jobimport ${request_options[@]} \
	    --file=export.zip --workflowfolder=ap3jobs/Version22 --labelsuffix=job1,job2v22

...

Exporting and Importing/Deploying for High Security Level

Code Block

language	bash
title	Example for Skipping and Unskipping JobsExporting and Importing/Deploying for High Security Level
linenumbers	true

# 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
./operate-workflow.sh skip-job ${request_options[@]} \
	--workflow=ap3jobs --label=job1,job2)

# unskipexport jobsobjects from folder for labelssigning
./operatedeploy-workflow.sh unskipexport-jobfolder ${request_options[@]} \
	    --workflowfile=ap3jobsexport.zip --label=job1,job2

Posting, Reading and Deleting Notices

Code Block

title	Example for Posting, Reading and Deleting Notices
linenumbers	true

# 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
./operate-workflow.sh post-notice ${request_options[@]} \
	--notice-board=ap3jobs

# post notice for specific daily plan date and lifetime
./operate-workflow.sh post-noticefolder=/myFolder --recursive --for-signing

# digitally sign objects
rm -fr ./temp/*
unzip -d ./temp ./export.zip
./js7_sign_workflow.sh --dir=./temp --key=./ecdsa.key --cert=./ecdsa.crt --hash=sha512
rm -f ./import-from-signing.zip
cd ./temp
zip -r ../import-from-signing.zip *
cd -

# import/deploy objects
./deploy-workflow.sh import-deploy ${request_options[@]} \
	--notice-board=ap3jobs --notice-id=2024-08-26 --notice-lifetime=6h


# reading notices from notice board
./operate-workflow.sh get-notice} \
    --file=import-from-signing.zip

Deploying Objects

Code Block

language	bash
title	Examples for Deploying Objects
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)

# deploy objects from folder recursively and update daily plan
./deploy-workflow.sh deploy ${request_options[@]} \
    --notice-board=ap3jobs-folder=/ap/Agent --recursive --date-from=now

# readingdeploy specificworkflows noticeand fromupdate noticedaily boardplan
./operatedeploy-workflow.sh get-noticedeploy ${request_options[@]} \
    --notice-board=ap3jobspath=/ap/ap3jobs,/ap/apEnv --notice-id=2024-08-26

# reading notices by folder
./operate-workflow.sh get-notice ${request_options[@]} \
    --folder=/ap --recursive


# delete notices from notice board for current daily plan date
./operate-workflow.sh delete-notice ${request_options[@]} \
	--notice-board=ap3jobs

# delete specific notices from notice board using notice identifiers
./operate-workflow.sh delete-noticetype=WORKFLOW --date-from=now

Releasing Objects

Code Block

language	bash
title	Examples for Releasing Objects
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller)

# release objects from folder and update daily plan
./deploy-workflow.sh release ${request_options[@]} \
	    --notice-board=ap3jobsfolder=/ap/Agent --noticerecursive -id=2024-08-25,2024-08-26date-from=now

# delete notices by folder
 ./operaterelease schedules and update daily plan
./deploy-workflow.sh delete-noticerelease ${request_options[@]} \
	    --folder=/appath=/ap/Agent/apAgentSchedule01,/ap/Agent/apAgentSchedule02 --type=SCHEDULE --recursivedate-from=now

Resources

API
- JS7 - REST Web Service API
- JS7 - PowerShell Module
Status
Deployment Operations
- JS7 - Workflows - Status Operations on WorkflowsDeployment of Scheduling Objects
- JS7 - Workflows - Status Operations on Instructions
- JS7 - Workflows - Status Operations on Jobs
- Secure Deployment of Scheduling Objects
Status Operations
- JS7 - Unix Shell CLI for workflow status operations JS7 - Workflows - Status Operations on Orders

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Workflow Deployment Script

Commands

Options

Options

Switches

Exit Codes

Examples

Adding Orders

Cancelling Orders

Suspending and Resuming Orders

Letting run Orders

Switches

Exit Codes

Examples

Exporting Objects

Transferring Orders

Suspending and Resuming Workflows

Stopping and Unstopping Jobs

Importing Objects

Exporting and Importing/Deploying for High Security Level

Posting, Reading and Deleting Notices

Deploying Objects

Releasing Objects

Resources

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

Workflow Deployment Script

Commands

Options

Options

Switches

Exit Codes

Examples

Adding Orders

Cancelling Orders

Suspending and Resuming Orders

Letting run Orders

Switches

Exit Codes

Examples

Exporting Objects

Transferring Orders

Suspending and Resuming Workflows

Stopping and Unstopping Jobs

Importing Objects

Exporting and Importing/Deploying for High Security Level

Posting, Reading and Deleting Notices

Deploying Objects

Releasing Objects

Resources