Page History
...
Operation | Object | Documentation |
---|---|---|
export / import | Any | JS7 - Inventory Export and Import |
sign import-deploy | Controller objects such as Workflows | JS7 - Secure Deployment of Scheduling Objects |
deploy / revoke | Automation Controller objects such as Workflows | JS7 - Deployment of Scheduling Objects |
release / recall | Automation objects such as Schedules | |
store / remove | Any | Store object to inventory / move objects to trash |
restore / delete | Any | Restore removed objects / delete removed objects from trash |
revalidate | Any | Revalidate objects from inventory folder |
...
Code Block | ||
---|---|---|
| ||
Usage: deploy-workflow.sh [Command] [Options] [Switches] Commands: export --file [--format] --path --type [--use-short-path] [--start-folder] [--for-signing] .. --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] [--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 revalidate --folder [--recursive] Options: --url=<url>sign --file | required: JOC Cockpit URL --controller-id=<id[,id]>[--keystore |--key --cert] [--key-password] [--hash] .. | required: Controller ID --user=<account> --directory [--keystore |--key --cert] [--key-password] [--hash] Options: --url=<url> | required: JOC Cockpit user account --password=<password> | optionalrequired: JOC Cockpit passwordURL --cacontroller-cert=<path> id=<id[,id]> | required: Controller ID --user=<account> | optional: path to CA Certificate used| forrequired: JOC Cockpit loginuser account --client-certpassword=<path><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 --start-folder=<folder> | optional: start folder for export with relative paths --path=<path[,path]> | optional: list of inventory paths to objects --type=<type[,type]> | optional: list of object types such as WORKFLOW,SCHEDDULE --new-path=<path> | optional: new object path on restore --prefix=<string> | optional: prefix for duplicate objects on import --suffix=<string> | optional: suffix for duplicate objects on import --algorithm=<identifier> | optional: signature algorithm for import, default: SHA512withECDSA --date-from=<date> | optional: update daily plan start date for deploy/release operation --audit-message=<string>directory=<directory> | optional: audit log message path to directory with files that should be signed --audit-time-spent=<number>keystore=<path> | optional: auditpath logto timekeystore spentfile in PKCS12 minutesformat --audit-link=<url>key=<path> | optional: audit log link path to private key file in PEM format --log-dir=<directory>key_password=<password> | optional: pathpassword tofor directorykeystore/private holding the script's log files key file Switches: --cert=<path> -h | --help | optional: path to certificate file |in displaysPEM usageformat -v | --verbose-hash=<sha256|sha512> | optional: hash algorithm for signing such as | displays verbose outputsha256, sha512, repeat to increase verbositydefault: sha256} -p | -audit-passwordmessage=<string> | optional: audit | asks for passwordlog message --r | audit--recursive time-spent=<number> | specifiesoptional: foldersaudit tolog betime lookedspent upin recursivelyminutes -o | --overwrite audit-link=<url> | overwritesoptional: objectsaudit onlog importlink -s | --for-signinglog-dir=<directory> | optional: path |to exports objects for digital signingdirectory holding the script's log files Switches: -uh | --use-short-pathhelp | exportsdisplays relative pathsusage -v | -no-draftverbose | displays verbose output, |repeat excludesto draftincrease objectsverbosity -p | -no-deployed password | excludesasks deployedfor objectspassword -r | -no-releasedrecursive | specifies folders |to excludesbe releasedlooked objectsup recursively -o | -no-invalidoverwrite | overwrites objects on import | excludes invalid objects -s | --showfor-logssigning | exports objects for digital signing | shows log-u output| if --use-log-dir is usedshort-path | exports relative paths --makeno-dirsdraft | createsexcludes directoriesdraft ifobjects they do not exist |
...
--no-deployed | excludes deployed objects
--no-released | excludes released objects
--no-invalid | excludes invalid objects
--show-logs | shows log output if --log-dir is used
--make-dirs | creates directories if they do not exist |
Anchor | ||||
---|---|---|---|---|
|
export
- Allows to export 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 one or more object types can be specified and otherwise all objects will be exported, see
--type
option. - Should relative paths be used in the archive file then the
--use-short-path
switch can be applied. - Export of objects can further be limited by use of the
--no-*
switches, see section Switches.
- Optionally one or more object types can be specified and otherwise all objects will be exported, see
- export individual objects specified by the
- The archive file is specified from the
--file
and--format
options. - If JOC Cockpit is operated for the High Security Level then the
--for-signing
switch can be used to export Controller Objects that should be digitally signed. Objects and signatures can be imported using theimport-deploy
command.
- Allows to export 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. The operation applies to use of JOC Cockpit with the Low and Medium Security Level.
- 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.
sign
- Digitally signs workflows and job resources from an export archive file. The operation applies to use of JOC Cockpit with the High Security Level.
- Signing includes to specify the Private Key and Certificate from files in PEM format or from a keystore. Optionally the hash algorithm sha256 or sha512 is specified.
- The sequence of operations includes to
export
, tosign
and toimport-deploy
signed objects. - The
sign
command works without access to the JS7 REST Web Service and does not require to specify options for connecting to JOC Cockpit.
- 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 be exported using the
--for-signing
switch. - Workflows and Job Resources from the archive file are digitally signed by the user. Signature files are added to the archive file.
- As a prerequisite the archive file must be 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 Controller Objects such as workflows. The command can be used in two flavors:
- deploy individual objects specified
export
- Allows to export 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 one or more object types can be specified and otherwise all objects will be exported, see
--type
option. - Should relative paths be used in the archive file then the
--use-short-path
switch can be applied. - Export of objects can further be limited by use of the
--no-*
switches, see section Switches.
- Optionally one or more object types can be specified and otherwise all objects will be exported, see
- export individual objects specified by the
- The archive file is specified from the
--file
and--format
options. - If JOC Cockpit is operated for the High Security Level then the
--for-signing
switch can be used to export Controller Objects that should be digitally signed. Objects and signatures can be imported using theimport-deploy
command.
- Allows to deploy Controller Objects such as workflows. The command can be used in two flavors:
import
- Imports an archive file to the inventory. The operation applies to use of JOC Cockpit with the Low and Medium Security Level.
- 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 be exported using the
--for-signing
switch. - Workflows and Job Resources from the archive file are digitally signed by the user. Signature files are added to the archive file.
- As a prerequisite the archive file must be 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 objects from folders using the
--folder
option and--recursive
switch.
- Deploying objects forwards them to Controllers and Agents.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
revoke
- Allows to undeploy Controller 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 Controller objects deletes them from the Controller and Agents, objects remain in draft status in the inventory.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
- Allows to undeploy Controller Objects such as workflows. The command can be used in two flavors:
release
- Allows to release Automation 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
- Releasing objects activates them for example for use by the Daily Plan.
- Allows to release Automation Objects such as schedules. The command can be used in two flavors:
recall
- Allows to unrelease Automation Objects such as schedules
deploy
- Allows to deploy Controller Objects such as workflows. The command can be used in two flavors:
- deploy recall individual objects specified objects specified by the
--path
and--type
options. - deploy objects from folders using the
--folder
option and--recursive
switch.
- deploy recall individual objects specified objects specified by the
- Deploying objects forwards them to Controllers and Agents.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
revoke
- and
--type
options. - recall objects from folders using the
--folder
option and--recursive
switch.
- and
- Recalling objects deactivates them from further use, objects remain in draft status in the inventory.
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
- Allows to undeploy Controller Objects such as workflows. The command can be used in two flavors:
- revoke remove individual objects specified by the
--path
and--type
options. - revoke remove objects from folders recursively using the
--folder
option and--recursive
switch.
- revoke remove individual objects specified by the
- Revoking Controller objects deletes them such as workflows are removed from the Controller and Agents, objects remain in draft status in the inventory.
- More than one Controller ID can be specified like this:
--controller-id=controller-uat-1,controller-uat-2
- More than one Controller ID can be specified like this:
release
- Allows to release Automation 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
- Releasing objects activates them for example for use by the Daily Plan.
- Allows to release Automation Objects such as schedules. The command can be used in two flavors:
- from the inventory. Automation objects such as schedules are removed from the inventory.
- Removing objects moves them to the trash from which they can be restored or deleted
restore
- Allows to restore objects such as workflows or schedules from the trash
recall
- Allows to unrelease Automation Objects such as schedules. The command can be used in two flavors:
- recall restore individual objects specified by the
--path
and--type
options. - recall restore objects from folders recursively using the
--folder
option and--recursive
switch.
- recall restore individual objects specified by the
- Recalling Restoring objects deactivates them from further use, objects remain in draft status in the inventory.
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.
- moves them from the trash to the inventory from which they can be deployed or released.
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:
revalidate
- Allows to revalildate
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
- Controller objects such as workflows are removed from the Controller and from the inventory. Automation objects such as schedules are removed from the inventory.
- Removing objects moves them to the trash from which they can be restored or deleted
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:
revalidate
- Allows to revalildate objects such as workflows or schedules from the inventory, for example after import. The command can be used for inventory folders.
...
- , for example after import. The command can be used for inventory folders.
Anchor | ||||
---|---|---|---|---|
|
--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
commands. - 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 one or more 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
commands, 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
command 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.- Controller Object types include:
WORKFLOW,FILEORDERSOURCE,JOBRESOURCE,NOTICEBOARD,LOCK
- Automation Object types include:
SCHEDULE,WORKINGDAYSCALENDAR,NONWORKINGDAYSCALENDAR,JOBTEMPLATE,INCLUDESCRIPT,REPORT
- Controller Object types include:
- When used with the
export
command for folders then more than one object 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
command, 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
command, 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
command, 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
command, 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
option 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 for example if the underlying workflow or schedule is changed.
- Specifies the date starting from which the Daily Plan will be updated:
--directory
- When used with the
sign
command, specifies the directory in which workflow files with the extension *.workflow.json and job resources holding the extension .jobresource.json are looked up for signing. Sub-directories are looked up recursively. - All files found will be digitally signed by creating a signature file with the extension *.json.sig that holds the signature of the related object.
- When used with the
--keystore
- When used with the
sign
command, specifies the path to a keystore file in PKCS12 format. The keystore is expected to hold the Private Key and Certificate. - Only one of the options
--keystore
and--key
can be specified.
- When used with the
--key
- When used with the
sign
command, specifies the path to a key file that holds the private key used for signing in PEM format. - Only one of the options
--keystore
and--key
can be specified.
- When used with the
--cert
- When used with the
sign
command, specifies the path to a Certificate file that matches the Private Key used for signing. The Certificate is expected in PEM format. - The argument is required if the
--key
option is used. - The argument is optional If the
--keystore
option is used. The--cert
option has precedence if used with the--keystore
option.
- When used with the
--key-password
- When used with the
sign
command, specifies the password for access to the keystore or key file. - Password input from the command line is considered insecure. Consider use of the
-k
switch or more elaborate mechanisms, for example by temporarily populating the system keystore form a security key such as a YubiKey® or similar.
- When used with the
--hash
- When used with the
sign
command, specifies the hash algorithm used to create a hash from a file that is to be signed. - Possible values include
sha256
andsha512
. Default:sha256
- When used with the
--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
commands. - 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 one or more 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
commands, 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
command 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.- Controller Object types include:
WORKFLOW,FILEORDERSOURCE,JOBRESOURCE,NOTICEBOARD,LOCK
- Automation Object types include:
SCHEDULE,WORKINGDAYSCALENDAR,NONWORKINGDAYSCALENDAR,JOBTEMPLATE,INCLUDESCRIPT,REPORT
- Controller Object types include:
- When used with the
export
command for folders then more than one object 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
command, 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
command, 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
command, 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
command, 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
option 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 for example 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 to 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
-k | --key-password
- Asks the user for interactive keyboard input of the password used for access to a keystore or key file specified with the
--keystore
or--key
options. - The switch is used for secure interactive input as an alternative to use of the
--key-password=<password>
option.
- Asks the user for interactive keyboard input of the password used for access to a keystore or key file 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
-o | --overwrite
- Specifies that objects with the same name and type will be overwritten when used with the
import
command.
- 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
command. For JS7 environments operated for the High Security Level digitally signed objects can be imported using theimport-deploy
command.
- 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 archive files when used with the
export
command. - 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 archive files when used with the
--no-draft
- Specifies that draft objects will be excluded when used with the
export
anddeploy
command.
- Specifies that draft objects will be excluded when used with the
--no-deployed
- Specifies that deployed objects will be excluded when used with the
export
anddeploy
command.
- Specifies that deployed objects will be excluded when used with the
--no-released
- Specifies that released objects will be excluded when used with the
export
command.
- Specifies that released objects will be excluded when used with the
--no-invalid
- Specifies that invalid objects will be excluded when used with the
export
command.
- Specifies that invalid objects will be excluded 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
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# common options for connection to JS7 REST API request_options=(--url=http://localhost:4446 --user=root --password=root --controller-id=controller) # export objects from folder for signing ./deploy-workflow.sh export ${request_options[@]} \ --file=export.zip --folder=/myFolder --recursive --for-signing # digitally sign objects mkdir -p ./temp rm -fr ./temp/* unzip -d ./temp ./export.zip ./js7_sign_deploy-workflow.sh sign \ --dirdirectory=./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[@]} \ --file=import-from-signing.zip |
...
Overview
Content Tools