PowerShell CLI 2.0 - Cmdlets - Resume-JS7Order

Name

Resume-JS7Order

SYNOPSIS

Resumes suspended or failed orders in a JS7 Controller

SYNTAX

Resume-JS7Order [[-OrderId] <String>] [[-Position] <Object[]>] [[-Arguments] <Hashtable>] [[-Folder] <String>] [-Recursive] [[-State] <String[]>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet resumes orders that are suspended or failed in a JS7 Controller.

The following REST Web Service API resources are used:

* /orders/resume

PARAMETERS

OrderId

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

Position

-Position <Object[]>
Specifies the position in the workflow for which the order should be resumed,
i.e. the order will continue to execute with the instruction indicated by the position.

The position is specified as an array, e.g. @(2, "then", 0) which translates to the
3rd instruction of the workflow, that is an If-Instruction, and the first instruction in the "then" branch.

Arguments

-Arguments <Hashtable>
Specifies the arguments for the order. Arguments are created from a hashmap,
i.e. a list of names and values.

Example:
$orderArgs = @{ 'arg1' = 'value1'; 'arg2' = 'value2' }

Folder

-Folder <String>
Optionally specifies the folder of workflows for which orders should be resumed.

One of the parameters -Folder, -OrderId, -Folders or -State has to be specified.

Recursive

-Recursive <SwitchParameter>
When used with the -Folder parameter specifies that any sub-folders should be looked up.
By default no sub-folders will be searched for workflows.

State

-State <String[]>
Limits the scope of orders to be resumed to the following order states:

* PENDING
* SCHEDULED
* INPROGRESS
* RUNNING
* SUSPENDED
* WAITING
* PROMPTING
* FAILED
* BLOCKED

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.

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.

AuditTicketLink

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

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Resume-JS7Order -OrderId "#2020-11-22#T072521128-Reporting"

Resumes the order with the given ID from its current position.

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

PS > Resume-JS7Order -OrderId "#2020-11-22#T072521128-Reporting" -Position @(2)

Resumes the order with the given ID from the 3rd instruction in the workflow.

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

PS > Get-JS7Order -Suspended | Resume-JS7Order

Resumes all suspended orders for any workflows.

-------------------------- EXAMPLE 4 --------------------------

PS > Resume-JS7Order -State 'SUSPENDED','FAILED' -Folder /

Resumes orders that are configured with the root folder without consideration of sub-folders.

-------------------------- EXAMPLE 5 --------------------------

PS > Resume-JS7Order -State 'SUSPENDED','FAILED' -Folder /some_path -Recursive

Resumes suspended and failed orders that are configured with the indicated folder and any sub-folders.

-------------------------- EXAMPLE 6 --------------------------

PS > Get-JS7Order -WorkflowPath /test/samples/workflow1 | Resume-JS7Order

Resumes orders for the specified workflow.