JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

Name

Resume-JS7Order

SYNOPSIS

Resumes suspended orders in a JS7 Controller

SYNTAX

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

DESCRIPTION

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

PARAMETERS

OrderId

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

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

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.

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

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' }

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

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

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

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

PS > Get-JS7Order -Suspended -Folder / | Resume-JS7Order

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

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

PS > Get-JS7Order -Folder /some_path -Recursive | Resume-JS7Order

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

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

PS > Get-JS7Order -WorkflowPath /test/globals/chain1 | Resume-JS7Order

Resumes orders for the specified workflow.

  • No labels