Page History

...

• list-item
  • Returns the list of scheduling objects from JOC Cockpit's Git repository. The list will be returned in JSON format.
  • The command is used alternatively
    • with the --path and --type options to specify an individual object. One of the following object types has to be specified:
      • Deployable object types: WORKFLOW, FILEORDERSOURCE, JOBRESOURCE, NOTICEBOARD, LOCK
      • Releasable object types: INCLUDESCRIPT, SCHEDULE, WORKINGDAYSCALENDAR, NONWORKINGDAYSCALENDAR, JOBTEMPLATE, REPORT
    • with the --folder option to include all objects in the related folder to be returned. The --recursive switch can be used to process sub-folders recursively.
• store-item
  • Stores the current version of scheduling objects of JOC Cockpit's inventory to JOC Cockpit's Git repository. This applies to any of draft, deployed and released objects.
  • The following options and switches can be used to limit objects that should be stored:
    • The --path and --type options are used to store individual objects JOC Cockpit's Git repository.
    • The --folder option and optionally --recursive switch are used to store objects from a folder hierarchy to JOC Cockpit's Git repository.
    • The --change option is used to store objects and dependencies of a change to JOC Cockpit's Git repository.
      • The --folder option can be specified to limit objects to the related folder in JOC Cockpit's Git repository. Without this option the objects of the change will be stored to related JOC Cockpit Git repositories corresponding to their folders.
      • The --no-referencing option can be specified to exclude objects that hold references to one of the objects included with the change.
      • The --no-references option can be specified to exclude objects that are referenced by objects in the change.
  • Later commit and push commands will apply changes resulting from updated objects in JOC Cockpit's Git repository.
• update-item
  
  • Updates the JOC Cockpit inventory from scheduling objects available in JOC Cockpit's Git repository. This applies to any of draft, deployed and released objects.
  • The --path and --type options are used to update individual objects from JOC Cockpit's Git repository to the inventory.
  • The --folder option and optionally --recursive switch are used to update objects from a folder hierarchy in JOC Cockpit's Git repository to the inventory.
  • The --change option is used to update objects and dependencies of a change from JOC Cockpit's Git repository. For applicable options and switches see store-item command.
• delete-item

  • Deletes scheduling objects from JOC Cockpit's Git repository.  This applies to any of draft, deployed and released objects. The operation does not affect existence of objects in JOC Cockpit's inventory. Later commit and push commands will apply changes. Users should first use the command to delete objects from JOC Cockpit's Git repository, then delete objects from the inventory.

  • The --path and --type options are used to delete individual objects from JOC Cockpit's Git repository.
  • The --folder option and optionally --recursive switch are used to delete objects from a folder hierarchy in JOC Cockpit's Git repository.
  • The --change option is used to delete objects and dependencies of a change from JOC Cockpit's Git repository. For applicable options and switches see store-item command.
• clone
  • Clones a remote Git repository to a JOC Cockpit Git repository.
  • The command is used with the --remote-url option to identify the remote Git repository. Frequently the syntax git@<git-server>:<owner>/<repository> is used, for example: git@github.com:sos-berlin/js7-demo-inventory-rollout-test
• checkout
  • A specific branch from the remote Git repository is checked out using the --branch or --tag options to identify the branch.
• add
  • Adds changes to JOC Cockpit's Git repository.
• commit
  • Commits changes to JOC Cockpit's Git repository.
  • The command is used with the --folder option to specify the inventory folder that is mapped to the Git repository. The --message option is used to specify a message that  typically becomes visible when displaying commits to a repository in a Git Server.
  • The command returns the commit hash created by Git when committing changes.
• push
  • Pushes objects from JOC Cockpit's Git repository to the remote Git repository.
  • The command is used with the --folder option to specify the inventory folder that is mapped to the Git repository.
• pull
  • Pulls objects from the remote Git repository to JOC Cockpit's Git repository. Objects in JOC Cockpit's Git repository will be removed, added or updated.
  • The command is used with the --folder option to specify the inventory folder that is mapped to the Git repository.
• get-credentials
  • Reads Git credentials from the user's profile in JOC Cockpit.
  • If credentials for more than one Git Server are available then they will be returned.
• store-credentials
  • Stores Git credentials to the user's profile in JOC Cockpit.
  • The command is used with the --server option to specify the Git Server for which credentials will be stored.
  • For authentication with Git one of the --user-password, --user-access-token or --user-private-key options must be used.
    • The location of a private key file must be specified from an absolute path that is readable for the JOC Cockpit service.
    • Users have to store the private key file to the related location.
• delete-credentials
  • Deletes Git credentials from the user's profile in JOC Cockpit.
  • The command is used with the --server option to specify the Git Server for which credentials will be deleted.

...