Name

Set-JS7Order

SYNOPSIS

Transitions an existing order that will be continued or transferred

SYNTAX

Set-JS7Order [[-OrderId] <String>] [[-WorkflowId] <PSObject>] [[-WorkflowPath] <String>] [[-WorkflowVersionId] <String>] [-Transfer] [-LetRun] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Transition an existing order for the JS7 Controller

The following REST Web Service API resources are used:

* /orders/continue
* /workflow/transition

PARAMETERS

OrderId

-OrderId <String>
Specifies the identifier of the order.

The argument is required if the -LetRun switch is used.

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

WorkflowId

-WorkflowId <PSObject>

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

WorkflowPath

-WorkflowPath <String>
Specifies the the path and name of a workflow for which orders should be transferred

The argument is required if the -Transfer switch is used.

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

WorkflowVersionId

-WorkflowVersionId <String>
Deployed workflows are assigned a version identifier. The argument allows to select the
workflow that is assigned the specified version.

The argument is required if the -Transfer switch is used.

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

Transfer

-Transfer <SwitchParameter>
Transfers orders from a previous workflow version to the latest workflow version.

The argument requires the -WorkflowPath and -WorkflowVersionId arguments to be specified.
Related information is returned by the Get-JS7Workflow cmdlet.

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

LetRun

-LetRun <SwitchParameter>
Continues orders in a waiting state.

The argument requires the -OrderId argument to be specified.

Required?false
Position?named
Default valueFalse
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?5
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?6
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?7
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

WhatIf

-WhatIf <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

Confirm

-Confirm <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > Set-JS7Order -OrderId "#2020-11-23#T158058928-myTest03" -LetRun

Continues the order with Order ID "#2020-11-23#T158058928-myTest03".

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

PS > Get-JS7Order -Folder /some_folder -Waiting | Set-JS7Order -LetRun

Continues all waiting orders from the given workflow folder.

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

PS > Get-JS7Workflow -Folder /some_folder | Set-JS7Order -Transfer

Transfers orders from earlier versions of the workflow to the latest version of the workflow.

  • No labels