Introduction

• The JS7 offers to perform any operation on operations on Controllers and Agents, 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.

The Unix Shell Command Line Interface can be used to perform frequently used operations on workflows, jobs and orders:deployment operations and status operations:

• Controller Deployment
  • Initial Operation: register, unregister
  • Agent Management: store, delete, deploy, revoke
• Controller Status Operations
  • Controller Operations: terminate, restart, cancel
  • Agent Operations: enable, disable, reset
  • Cluster Operations on Controller and Agents: switch-over
• Workflow Deployment
  • Objects: export, import, deploy, release, store, remove
  • Trash: restore, delete
• Workflow Status Operations
  • Orders: add, cancel, suspend, resume, let run, transfer
  • Workflows: suspend, resume
  • Jobs and Instructions: stop, unstop, skip, unskip
  • Notices: post, get, delete

Download

The Unix Shell CLI is provided for download to perform deployment and status operations outside of JS7 products.

• Download: JS7 - Download (Section: Unix Shell ClI, File: js7.unix_shell_cli.tar.gz)
• The Unix Shell CLI can be used from the command line for Linux, MacOS® using bash shell.
• For encryption/decryption operations Java 17 or newer is required. All other operations do not require Java.

The archive file of the Unix Shell CLI holds the following files and directories:

Unix

• js7.unix_shell_cli
  • bin
    • deploy-controller.sh: see JS7 - Unix Shell CLI for Controller Deployment
    • deploy-workflow.sh: see JS7 - Unix Shell CLI for Workflow Deployment
    • operate-controller.sh: see JS7 - Unix Shell CLI for Controller Status Operations
    • operate-workflow.sh: see JS7 - Unix Shell CLI for Workflow Status Operations
  • examples
    • *.sh: examples for use of scripts
  • lib
    • 3rd-party: libraries provided by 3rd-party projects
    • sos: libraries provided by SOS
• Workflow Status Operations
  • suspend workflow, resume workflow, see JS7 - Workflows - Status Operations on Workflows
  • stop instruction, skip instruction, see JS7 - Workflows - Status Operations on Instructions
  • start job, stop job, skip job, see JS7 - Workflows - Status Operations on Jobs
  • add order, cancel order, suspend order, resume order, transfer order, see JS7 - Workflows - Status Operations on Orders
• Workflow Deployment
  • export, import, see JS7 - Inventory Export and Import
  • deploy, release, see JS7 - Deployment of Scheduling Objects and JS7 - Secure Deployment of Scheduling Objects

Resources