Name
Suspend-JS7Job
SYNOPSIS
Suspends one or more jobs at their position in a workflow
SYNTAX
Suspend-JS7Job [-Path] <String> [[-VersionId] <String>] [-Labels] <String[]> [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Jobs are suspended from labels that indicate their occurrence in a workflow.
Suspended jobs can be resumed using the Resume-JS7Job cmdlet.
The following REST Web Service API resources are used:
* /workflow/stop
PARAMETERS
Path
-Path <String>
Specifies the workflow from its name or path in which jobs should be suspended.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
VersionId
-VersionId <String>
A number of versions of a workflow can co-exist when orders are assigned the related workflow version.
The parameter specifies the workflow version to be used. If the parameter is not specified then the latest version is used.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Labels
-Labels <String[]>
Specifies the labels assigned the positions of jobs in the workflow that should be suspended. A job can occur any number of times in a workflow.
| Required? | true |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Specifies the identification of the Controller for which jobs in workflows should be suspended.
| Required? | false |
| Position? | 4 |
| 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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.
| Required? | false |
| Position? | 5 |
| 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 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.
| Required? | false |
| Position? | 6 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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.
| Required? | false |
| Position? | 7 |
| 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 |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Suspend-JS7Job -Path /myFolder/testStandaloneAgents -Labels job1
Suspends the job at the indicated label in the workflow.
-------------------------- EXAMPLE 2 --------------------------
PS > Suspend-JS7Job -Path /myFolder/testStandaloneAgents -Labels job1,job2
Suspends the jobs at the indicated labels in the workflow.
Overview
Content Tools