Versions Compared

Key

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

...

Import-JS7InventoryItem [-FilePath] <String> [[-Format] <String>] [[-TargetFolder] <String>] [[-Prefix] <String>] [[-Suffix] <String>] [-Overwrite] [-Deploy] [[-ControllerId] <String>] [[-SignatureAlgorithm] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

...

JOC Cockpit inventory items can be exported with the Export-JS7InventoryItem cmdlet. The archive file
created by the cmdlet can be imported by use of this cmdlet. This offers a mechanism to backup and to
restore inventory data, e.g. in case of switching the DBMS for JOC Cockpit or when upgrading to newer
JS7 releases.

Consider that this cmdlet requires PowerShell version 6.0 or newer.

The following REST Web Service API resources are used:

* /inventory/import
* /inventory/deployment/import_deploy

PARAMETERS

FilePath

-FilePath <String>
Specifies the path to the archive file that includes objects for import to the JOC Cockpit inventory.

...

-Overwrite <SwitchParameter>
Specifies that existing objects in the JOC Cockpit inventory will be overwritten
from objects with the same path in the archive file.

Without this parameter objects from the import file are ignored if objects with the same path
exist in the JOC Cockpit inventory.

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

Deploy

-Deploy <SwitchParameter>
When deploying scheduling objects for high security level then they must be exported for signing and must be digitally signed,
for example using the Export-JS7InventoryFolder and Sign-JS7Workflow cmdlets. Deployment is performed on import of the signed worfklows.

The switch specifieds that both operations to import and to deploy should be performed for high security level.

The switch requires to specify the -ControllerId and -SignatureAlgorithm arguments.

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

ControllerId

-ControllerId <String>
When deploying scheduling objects for high security level then they must be exported for signing and must be digitally signed,
for example using the Export-JS7InventoryFolder and Sign-JS7Workflow cmdlets. Deployment is performed on import of the signed worfklows.

The argument specifies the identification of the Controller to which scheduling objects should be deployed.

The argument requires to specify the -Deploy and -SignatureAlgorithm arguments.

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

SignatureAlgorithm

-SignatureAlgorithm <String>
When deploying scheduling objects for high security level then they must be exported for signing and must be digitally signed,
for example using the Export-JS7InventoryFolder and Sign-JS7Workflow cmdlets. Deployment is performed on import of the signed worfklows.

The argument specifies the algorithm used when creating signatures:

* SHA256withECDSA
* SHA512withECDSA
* SHA256withRSA
* SHA512withRSA

The argument requires to specify the -Deploy and -ControllerId arguments.

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

...

-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.

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

...

-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.

Required?false
Position?79
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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.

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

...