Versions Compared

Key

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

...

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

...

-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?12
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

...

-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?23
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

...

-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?34
Default value
Accept pipeline input?true (ByValue, 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?45
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?56
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?67
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...