Versions Compared

Key

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

...

Export-JS7InventoryItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [-Releasable] [-Deployable] [-Released] [-Deployed] [-Valid] [-NoRemovedWithoutRemoved] [-ForSigning] [[-ControllerId] <String>] [[-FileTypeFilePath] <String>] [[-FilePathArchiveFormat] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

...

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

* Deployable Objects: use of the -Deployable parameter
** Inventory objects 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 is requested by use of the -Deployed parameter.
* Releasable Objects: use of the -Releasable parameter
** Inventory objects 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 is requested by use of the -Released parameter.

An export is performed either to backup deployable and releasable objects that later on can be imported (restored),
or to export objects for signing and later depeloyment with a JOC Cockpit operated in security level "high".

The process to export 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.

PARAMETERS

Path

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

...

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

WithoutRemoved

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

...

-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.
The export file can

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

Required?false
Position?4
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

FilePath

-FileType FilePath <String>
Specifies the type of path to the archive file that will be returned: .zip, .tar.gz or .gz.
If the -FilePath parameter is specified then the extension of the file name will be used for the file typethe exported inventory objects are written to.

If no file path is specified then an octet stream is returned by the cmdlet.

Required?false
Position?5
Default value.zip
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

ArchiveFormat

-FilePath ArchiveFormat <String>
Specifies the path to type of the output file that the exported inventory objects are written to.
If no output file is specified then an octet stream is returned by the cmdletarchive file that will be returned: ZIP, TAR.GZ.

If the -FilePath parameter is specified then the extension of the file name will be used for the file type.

Required?false
Position?6
Default valueZIP
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

Exports all inventory objects to a zipped octet-stream that is written to a file. This includes deployable and releasable inventory objects. By default draft versions are used instead of deployed or released versions. If no draft version exists then the latest deployed or released version is used.

...

PS > Export-JS7InventoryItem -Folder /some_folder -File FilePath /tmp/export.zip.tar.gz -ArchiveFormat TAR.GZ

Exports any objects from the given folder to a zipped compressed tar file.

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

PS > Export-JS7InventoryItem -Folder /some_folder -Deployable -File 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 4 --------------------------

PS > Export-JS7InventoryItem -Path /some_folder/some_workflow -Type WORKFLOW -File 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.

...

PS > Export-JS7InventoryItem -Path /some_folder/some_workflow -Type WORKFLOW -Valid -File 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.

...