JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 8

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 9

changes.mady.by.user Andreas Püschel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The JS7 offers to perform any operation operations on orders, workflows, jobs and related objects by the JS7 - 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 is available for Linux and MacOS® using bash shell.
  • The script terminates with exit code 0 to signal successful cancellationexecution, 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.

...

  • 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 the archive file must have been exported using the --for-signing option 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.
    • On import the objects in the archive file are deployed to related Controllers as specified during export.
  • 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 options switch.
    • Deletion of objects from a Controller is similarly considered similar 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 option and --recursive options switch.
    • Revocation of objects is similarly considered similar to a release operation..

Options

  • --url
  • --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.
    • 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: 15 seconds.
  • --file
    • Specifies the location of the an archive file that is used with export, import and import-deploy operations.
    • On export an existing archive file will be overwritten.
  • --format
    • Specifies the 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 all objects that are imported.
    • If an object with the same name and prefix exists, then it the object will not be imported.
  • --suffix
    • When used with the import operation then , a suffix can be specified that is appended any all objects that are imported.
    • If an object with the same name and suffix exists, then it the object 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

...

  • -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 when used with the export operation.
    • An object path /a/b/c/workflow will be add added 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.

...