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 13 Next »

Name

Confirm-JS7Order

SYNOPSIS

Confirms a prompting order

SYNTAX

Confirm-JS7Order [-OrderId] <String> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Workflows can use a prompt instruction to put orders on hold until confirmation.

The following REST Web Service API resources are used:

* /orders/confirm

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

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?2
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?3
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?4
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

WhatIf

-WhatIf <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

Confirm

-Confirm <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > Confirm-JS7Order -OrderId "#2020-11-19#P0000000498-orderSampleWorfklow2a"

Confirms a prompting order to continue execution of the workflow.

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

PS > Get-JS7Order -WorkflowPath /some_path/some_workflow -Prompting | Confirm-JS7Order

Retrieves prompting orders and confirms further execution with the workflow.

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

PS > Get-JS7Order -Folder /sos -Recursive -Prompting | Confirm-JS7Order

Recursively retrieves prompting orders and confirms further execution with workflows.

  • No labels