Page History
...
Code Block | ||
---|---|---|
| ||
Usage: deploy-workflow.sh [Command] [Options] [Switches] Commands: export --file [--format] --path --type [--use-short-path] [--start-folder] .. --file [--format] --folder [--recursive] [--type] [--use-short-path] [--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] [--no-draft] [--no-deployed] .. --folder [--recursive] [--date-from] [--no-draft] [--no-deployed] revoke --path --type .. --folder [--recursive] release --path --type [--date-from] .. --folder [--recursive] [--date-from] recall --path --type .. --folder [--recursive] store --path --type --file remove --path --type [--date-from] .. --folder [--date-from] restore --path --type --new-path [--prefix] [--suffix] .. --folder --new-path [--prefix] [--suffix] delete --path --type .. --folder 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: 60 --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, repeat to increase verbosity -p | --password | asks for password -r | --recursive | specifies folders to be looked up recursively -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 --remove | removes deployed/released objects --show-logs | shows log output if --log-dir is used --make-dirs | creates directories if they do not exist |
...
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.- Should relative paths be used in the archive file then the
--start-folder
option and--use-short-path
switch can be applied.
- Should relative paths be used in the archive file then the
- export objects from folders using the
--folder
option and--recursive
switch.- Optionally the object type is specified and otherwise all objects will be exported.
- Should relative paths be used in the archive file
- then the
--
- then the
use-short-path
switch can be applied.
- export individual objects specified by the
- The archive file is specified from the
--file
and--format
-format options.
- Allows to export scheduling objects such as workflows to an archive file in .zip or .tar.gz format. The command comes in two flavors:
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 or will be ignored.
- 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 the archive file must have been exported using the
--for-signing
switch. - Workflows and Job Resources from the archive file have been digitally signed by the user. Signature files have been added to the archive file.
- As a prerequisite the archive file must have been exported using the
- On import the objects in the archive file are deployed to related Controllers as specified during export.
- 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.
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
option and--recursive
switch.
- deploy individual objects specified by the
- Deploying objects forwards them to Controllers and Agents.
- Allows to deploy objects such as workflows. The command can be used in two flavors:
revoke
- Allows to undeploy objects such as workflows. The command can be used in two flavors:
- revoke individual objects specified by the
--path
and--type
options. - revoke objects from folders using the
--folder
option and--recursive
switch.
- revoke individual objects specified by the
- Revoking objects deletes them from the Controller and Agents, objects remain in draft status in the inventory.
- Allows to undeploy objects such as workflows. The command can be used in two flavors:
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
option and--recursive
switch.
- release individual objects specified by the
- Rleasing objects activates them for example for use by the Daily Plan.
- Allows to release objects such as schedules. The command can be used in two flavors:
recall
- Allows to unrelease objects such as schedules. The command can be used in two flavors:
- recall individual objects specified by the
--path
and--type
options. - recall objects from folders using the
--folder
option and--recursive
switch.
- recall individual objects specified by the
- Recalling objects deactivates them from further use, objects remain in draft status in the inventory.
- Allows to unrelease objects such as schedules. The command can be used in two flavors:
store
- Allows to store an object such as a workflow or schedule from a file to the inventory.
- The
--file
option specifies the file that holds the JSON representation of an object. - The
--type
option specifies the object type. - The
--path
option specifies the folders and object name of the objects inventory location.
- The
- Objects are stored to the inventory in draft status and can be deployed or released using the related commands.
- Allows to store an object such as a workflow or schedule from a file to the inventory.
remove
- Allows to remove objects such as workflows or schedules from the inventory. The command can be used in two flavors:
- remove individual objects specified by the
--path
and--type
options. - remove objects from folders recursively using the
--folder
option.
- remove individual objects specified by the
- Removing objects moves them to the trash from which they can be restored or deleted
- Allows to remove objects such as workflows or schedules from the inventory. The command can be used in two flavors:
restore
- Allows to restore objects such as workflows or schedules from the trash. The command can be used in two flavors:
- restore individual objects specified by the
--path
and--type
options. - restore objects from folders recursively using the
--folder
option.
- restore individual objects specified by the
- Restoring objects moves them from the trash to the inventory from which they can be deployed or released.
- Allows to restore objects such as workflows or schedules from the trash. The command can be used in two flavors:
delete
- Allows to delete objects such as workflows or schedules from the trash. The command can be used in two flavors:
- delete individual objects specified by the
--path
and--type
options. - delete objects from folders recursively using the
--folder
option.
- delete individual objects specified by the
- Deleting objects will permanently wipe them from the trash.
- Allows to delete objects such as workflows or schedules from the trash. The command can be used in two flavors:
...
--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 for 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.
- More than one Controller ID can be specified, separated by comma, for the
export
operation when using the--for-signing
switch.
--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:
60
seconds.
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default:
--file
- Specifies the location of an archive file that is used with
export
,import
andimport-deploy
operations. - On export an existing archive file will be overwritten.
- Specifies the location of an archive file that is used with
--format
- Specifies the format of the archive file indicated with the
--file
option. - The format can be one of
ZIP
orTAR_GZ
. Default:ZIP
. The JS7 can process archive files in .zip format on Unix.
- Specifies the format of the archive file indicated with the
--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
.
- Folder specification starts from a
- When used with the
import
andimport-deploy
operations, a single folder can be specified that is prepended the folders included with the archive file.
- Specifies the inventory folder used for the related operation.
--start-folder
- Specifies the inventory folder used for relative paths in archive files when using the
export
operation with the--path
option, see--use-short-path
switch.
- Specifies the inventory folder used for relative paths in archive files when using the
--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 or schedule 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, NONWORKINGDAYSCALENDAR, 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
- Specifies the object type such as a workflow or schedule that is indicated together with the
--new-path
- When used with the
restore
operation, the new path is specified to which the object will be restored in the inventory.
- When used with the
--prefix
- When used with the
import
operation, a prefix can be specified that is prepended all objects that are imported. - If an object with the same name and prefix exists, then the object will not be imported.
- When used with the
--suffix
- When used with the
import
operation, a suffix can be specified that is appended all objects that are imported. - If an object with the same name and suffix exists, then the object will not be imported.
- When used with the
--algorithm
- When used with the
import-deploy
operation, the signature algorithm is specified that was used to digitally sign objects. Default:SHA512withECDSA
. - The algorithm name is made up of the hash algorithm name such as SHA256, SHA512 and the encryption type of the Private Key such as ECDSA or RSA.
- This offers to specify the following algorithm names:
SHA256withECDSA
,SHA256withRSA
,SHA512withECDSA
,SHA512withRSA
.
- When used with the
--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.
- The
- Orders in the Daily Plan can be updated if the underlying workflow or schedule is changed.
- Specifies the date starting from which the Daily Plan will be updated:
--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
...
-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 -v
then 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
--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
--folder
option is used.
- Specifies that folders will be looked up recursively if the
-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.
- Specifies that objects with the same name and type will be overwritten when used with the
-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 theimport-deploy
operation.
- Specifies that objects are exported for digital signing when used with the
-u | --use-short-path
- Specifies that relative object paths will be applied to the archive file files when used with the
export
operation. - An object path
/a/b/c/workflow
will be added as/c/workflow
to the archive file. A folder/a/b/c
will be added as/c
to the archive file.
- Specifies that relative object paths will be applied to the archive file files when used with the
--no-draft
- Specifies that no draft objects will be processed when used with the
export
anddeploy
operations.
- Specifies that no draft objects will be processed when used with the
--no-deployed
- Specifies that no objects in deployed status will be processed when used with the
export
anddeploy
operations.
- Specifies that no objects in deployed status will be processed when used with the
--no-released
- Specifies that no objects in released status will be processed when used with the
export
operation.
- Specifies that no objects in released status will be processed when used with the
--no-invalid
- Specifies that only valid objects will be processed when used with the
export
operation.
- Specifies that only valid objects will be processed 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
...
Overview
Content Tools