Skip to end of metadata
Go to start of metadata

Name

Publish-JS7DeployableItem

SYNOPSIS

Deploys scheduling objects such as workflows to JS7 Controllers

SYNTAX

Publish-JS7DeployableItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [-ControllerId] <String> [-Delete] [-Valid] [-NoDraft] [-NoDeployed] [-Latest] [[-ObjectName] <String>] [[-ObjectType] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet deploys scheduling objects to a number of JS7 Controllers. Consider for example a workflow
that can be deployed to more than one Controller.

Deployment includes that objects such as workflows are digitally signed and are forwarded to a Controller.
Depending on the security level in use signing is available with a common private key/certificate (security level: LOW),
with a user based private key/certificate (security level: MEDIUM) or by external signing (security level: HIGH).

Deployment can include to permanently delete previously removed objects from Controllers and from the inventory.
Therefore, if a deployable object is removed, e.g. with the Remove-JS7InventoryItem cmdlet, then this removal has to
be committed using this cmdlet for deployment.

The following REST Web Service API resources are used:

* /inventory/deployable
* /inventory/deployables
* /inventory/deploy

PARAMETERS

Path

-Path <String>
Specifies the folder, sub-folder and name of the object, for example a workflow path.

Required?false
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

Type

-Type <String[]>
Specifies the object type which is one of:

* WORKFLOW
* FILEORDERSOURCE
* JOBRESOURCE
* NOTICEBOARD
* LOCK

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

Folder

-Folder <String>
Optionally specifies the folder from which included inventory objects should be published.
This parameter is used alternatively to the -Path parameter that specifies to publish an individual inventory object.

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

Recursive

-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up. By default no sub-folders will be considered.

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

ControllerId

-ControllerId <String>
Specifies one or more Controllers to which the indicated objects should be deployed.

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

Delete

-Delete <SwitchParameter>
Specifies the action to permanently delete objects from a Controller. Without this switch objects
are published for use with a Controller.

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

Valid

-Valid <SwitchParameter>
Limits the scope to valid scheduling objects only.

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

NoDraft

-NoDraft <SwitchParameter>
Specifies that no draft objects should be deployed. This boils down to the fact that only previously deployed objects will be deployed.
Possible use cases include to deploy to a different Controller or to redeploy to the same Controller.

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

NoDeployed

-NoDeployed <SwitchParameter>
Specifies that no previously deployed objects should be deployed. This is useful for preventing redeployment of objects.

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

Latest

-Latest <SwitchParameter>
If used with the -Path parameter then -Latest specifies that only the latest deployed object will be considered for redeployment.
This parameter is not considered if the -NoDeployed parameter is used.

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

ObjectName

-ObjectName <String>
Internal use for pipelining.

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

ObjectType

-ObjectType <String>

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

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.

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

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.

Required?false
Position?8
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?9
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > Publish-JS7DeployableItem -ControllerId testsuite -Folder /TestCases/sampleWorkflows -Recursive

Deploys any scheduling objects such as workflows from the specified folder and any sub-folders to the indicated Controllers.

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

PS > Publish-JS7DeployableItem -ControllerId testsuite -Folder /TestCases/sampleWorkflows -Recursive -Delete

Marks for deletion any scheduling objects such as workflows from the specified folder and any sub-folders. Consider that the specified folder is not deleted but its contents only.

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

PS > Publish-JS7DeployableItem -ControllerId testsuite,standalone -Path /TestCases/sampleWorkflow_001 -Type 'WORKFLOW'

Deploys the specified workflow from the indicated path to both Controller instances.

  • No labels