Name
Suspend-JS7Workflow
SYNOPSIS
Suspends a workflow in the JS7 Controller
SYNTAX
Suspend-JS7Workflow [[-WorkflowPath] <String>] [[-Folder] <String>] [-Recursive] [-All] [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet suspends a workflow in a JS7 Controller.
Suspended workflows can later on be resumed by use of the Resume-JS7Workflow cmdlet.
If a workflow is suspended and if a job is executed for an order then the workflow
will wait for the job to complete before suspending the workflow.
The following REST Web Service API resources are used:
* /workflows/suspend
PARAMETERS
WorkflowPath
-WorkflowPath <String>
Specifies the identifier of the workflow.
The path includes the folder, sub-folders and the name of the workflow.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
Folder
-Folder <String>
Specifies the folder and optionally sub-folders from which workflows will be suspended.
| Required? | false |
| Position? | 2 |
| 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 value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
All
-All <SwitchParameter>
Optionally specifies tha all workflows should be suspended.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Optionally specifies the identification of the Controller for which to suspend workflows.
| 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 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? | 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 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? | 5 |
| 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? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Suspend-JS7Workflow -WorkflowPath /ProductDemo/WorkflowSuspension/pdwWorkflowSuspension
Suspends the workflow with the given path.
-------------------------- EXAMPLE 2 --------------------------
PS > Suspend-JS7Worfklow -Folder /some_workflow_path -Recursive
Suspends workflows that are available with the path /some_workflow_path and any sub-folders.
-------------------------- EXAMPLE 3 --------------------------
PS > Suspend-JS7Workflow -All
Suspends all workflows.
Overview
Content Tools