Versions Compared

Key

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

...

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

...

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

PARAMETERS

...

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

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

...

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

...

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

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.

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

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.

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

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

Required?false
Position?5
Default value
Accept pipeline input?false
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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any interventions.

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

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

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

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

...

Resumes all suspended orders for all any workflows.

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

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

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

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

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

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

...

PS > Get-JS7Order -WorkflowPath /test/globalssamples/chain1 workflow1 | Resume-JS7Order

Resumes orders for the specified workflow.