PowerShell CLI 2.0 - Cmdlets - Export-JS7InventoryItem

Name

Export-JS7InventoryItem

SYNOPSIS

Exports inventory items, e.g. workflows, schedules etc. from JOC Cockpit

SYNTAX

Export-JS7InventoryItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String[]>] [-Recursive] [-Releasable] [-Deployable] [-NoDraft] [-NoReleased] [-NoDeployed] [-Latest] [-Valid] [-NoRemoved] [-ForSigning] [-UseShortPath] [[-ControllerId] <String>] [-FilePath] <String> [[-Format] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet exports inventory items that are stored with JOC Cockpit.

* Deployable Objects: use of the -Deployable parameter
** Inventory items such as workflows are deployed to a JS7 Controller. The -Type parameter can be used to restrict object types.
** When exporting deployable objects then either a draft version can be used or the latest deployed version by use of the -Deployed parameter.
* Releasable Objects: use of the -Releasable parameter
** Inventory items such as calendars and schedules are not deployed to a Controller but are used by JOC Cockpit.
** When exporting releasable objects then either a draft version can be used or the latest released version by use of the -Released parameter.

An export is performed either to backup deployable and releasable objects that later on can be imported,
or to export objects for signing and later deployment with a JOC Cockpit operated in security level HIGH.

The process to export objects for signigng includes the following steps:

* export deployable objects to a compressed archive (.zip, .tar.gz),
* unzip the archive to the local file system,
* manually sign objects,
* zip signed objects and signature files to a compressed archive,
* import the archive and deploy the signed objects.

The following REST Web Service API resources are used:

* /inventory/deployable
* /inventory/deployables
* /inventory/releasable
* /inventory/releasables
* /inventory/export

PARAMETERS

Path

-Path <String>
Specifies the path and name of an individual inventory item that should be exported, e.g. a workflow.

Type

-Type <String[]>
Optionally restricts the object type to export which is one of:

* Deployable Object Types
** WORKFLOW
** FILEORDERSOURCE
** JOBRESOURCE
** NOTICEBOARD
** LOCK
* Releasable Object Types
** INCLUDESCRIPT
** JOBTEMPLATE
** WORKINGDAYSCALENDAR
** NONWORKINGDAYSCALENDAR
** SCHEDULE
** REPORT

The -Type parameter can be used to restrict either deployable or releasable object types to be exported.
Without specifying this parameter objects of any type within the areas of releasable and deployable objects are exported
depending on use of the -Releasable and -Deployable parameters.

Folder

-Folder <String[]>
Optionally specifies the folder for which all included inventory items should be exported.
This parameter is used alternatively to the -Path parameter that specifies export of an individual inventory item.

Recursive

-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up if the -Folder parameter is used.
By default no sub-folders will be searched for exportable objects.

Releasable

-Releasable <SwitchParameter>
Specifies that only releasable objects should be exported that include the object types:

* INCLUDESCRIPT
* JOBTEMPLATE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
* SCHEDULE
* REPORT

If none of the parameters -Releasable or -Deployable is used then both releasable and deployable inventory items are exported.

Deployable

-Deployable <SwitchParameter>
Specifies that only deployable objects should be exported that include the object types:

** WORKFLOW
** FILEORDERSOURCE
** JOBRESOURCE
** NOTICEBOARD
** LOCK

If none of the parameters -Releasable or -Deployable is used then both releasable and deployable inventory items are exported.

NoDraft

-NoDraft <SwitchParameter>
Specifies that no draft versions of releasable or deployable objects will be exported but only released/deployed versions.
Without this parameter the draft version of the inventory item will be exported if available.

If this switch is in place then depending on the presence of the -Latest parameter for deployable objects only the latest
deployed version will be used for export.

NoReleased

-NoReleased <SwitchParameter>
Specifies that no released versions of the releasable objects will be exported but only draft versions if available.
Without this parameter any draft versions and released versions of inventory objects will be exported.

NoDeployed

-NoDeployed <SwitchParameter>
Specifies that no deployed versions of deployable objects will be exported but only draft versions.
Without this parameter the draft version of the inventory object will be exported if available.

Latest

-Latest <SwitchParameter>
Specifies that for deployable objects the latest deployed version is eligible for export.

Valid

-Valid <SwitchParameter>
Specifies that only valid versions of inventory draft objects are eligible for export.
This applies to releasable and to deployable objects.
Without this parameter draft versions will be exported that are in progress and therefore are not valid.

NoRemoved

-NoRemoved <SwitchParameter>
Optionally specifies that no removed objects should be added to the export file. Such objects are marked for deletion, however,
deletion has not yet been confirmed by a deploy/release operation that permanently erases objects.

ForSigning

-ForSigning <SwitchParameter>
Specifies that deployable objects are exported for external signing and later import into a JOC Cockpit
instance operated for security level HIGH.

* The export file cannot include releasable objects as such objects are not subject to signing.
* The export file must be created from the same JOC Cockpit instance to which it will be imported for deployment.
* The process of export/signing/import must not exceed the max. idle time that is configured for a user's JOC Cockpit session.

Without this parameter the export file is created for backup purposes and can include any deployable and releasable objects.

UseShortPath

-UseShortPath <SwitchParameter>
Specifies that the export file will not use the absolute path of folders but will start from the last sub-folder specified with the -Folder argument.

ControllerId

-ControllerId <String>
Specifies the ID of the Controller to which objects should be deployed after external signing.
This parameter is required if the -ForSigning parameter is used.

FilePath

-FilePath <String>
Specifies the path to the archive file that the exported inventory objects are written to.

Format

-Format <String>
Specifies the type of the archive file that will be returned: ZIP, TAR_GZ.

AuditComment

-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.

The Audit Comment is visible from the Audit Log view of the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.

AuditTicketLink

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.

This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Export-JS7InventoryItem -Folder /some_folder -FilePath /tmp/export.tar.gz -Format TAR_GZ

Exports any objects from the given folder to a compressed tar file. This includes deployable and releasable inventory objects. By default draft versions and deployed or released versions are used.

-------------------------- EXAMPLE 2 --------------------------

PS > Export-JS7InventoryItem -Folder /some_folder -Deployable -FilePath /tmp/export.zip -ForSigning

Exports deployable objects only from the given folder to a zipped file that is used for signing. After signing and adding the signature files to the export archive then this archive can be imported and deployed in a JOC Cockpit instance operated for security level "high".

-------------------------- EXAMPLE 3 --------------------------

PS > Export-JS7InventoryItem -Path /some_folder/some_workflow -Type WORKFLOW -FilePath /tmp/export.zip

Exports the specified workflow from the indcated path to a zipped file. Use of the -Path parameter requires to specify the -Type parameter for the object type. Depending on availability the draft version or the latest deployed version of the workflow is used. If a draft version is available then it is eligible for export independent from the fact that the draft is valid or invalid.

-------------------------- EXAMPLE 4 --------------------------

PS > Export-JS7InventoryItem -Path /some_folder/some_workflow -Type WORKFLOW -Valid -FilePath /tmp/export.zip

Exports the specified workflow from the indcated path to a zipped file. Use of the -Path parameter requires to specify the -Type parameter for the object type. Depending on availability the draft version or the latest deployed version of the workflow is used. A draft version is considered only if it is valid otherwise the deployed version is used.

-------------------------- EXAMPLE 5 --------------------------

PS > Export-JS7InventoryItem -Folder /some_folder -Deployable -FilePath /tmp/export.zip

Exports any deployable inventory items such as workflows, resource locks etc. that are available from the specified folder to a zipped file. The latest deployed version of the objects is used.