Versions Compared

Key

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

...

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

...

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.

...

-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, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

Required?false
Position?6
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 visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.

Required?false
Position?7
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 JobSchedulerJS7.

This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.

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

...

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

Resumes suspended orders for the specified workflow.

-------------------------- EXAMPLE 7 --------------------------

PS > $orders = Get-JS7Order -WorkflowPath /ProductDemo/ParallelExecution/pdwFork -Suspended
$positions = $orders | Get-JS7OrderResumePosition
$orders | Resume-JS7Order -Position $positions[2].position

Retrieves suspended orders and possible positions to resume. The third (index: 2) position is used to resume the order.