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

Compare with Current View Page History

« Previous Version 10 Next »

Name

Resume-JS7Workflow

SYNOPSIS

Resumes a workflow in the JS7 Controller

SYNTAX

Resume-JS7Workflow [[-WorkflowPath] <String>] [[-Folder] <String>] [-Recursive] [-All] [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet resumes a workflow in a JS7 Controller.

Any orders in a resumed workflow will continue.

The following REST Web Service API resources are used:

* /workflows/resume

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 should be resumed.

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 valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

All

-All <SwitchParameter>
Optionally specifies tha all workflows should be resumed.

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

ControllerId

-ControllerId <String>
Optionally specifies the identification of the Controller from which to resume 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 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 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

about_JS7

EXAMPLES

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

PS > Resume-JS7Workflow -WorkflowPath /ProductDemo/WorkflowSuspension/pdwWorkflowSuspension

Resumes the workflow with the given path.

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

PS > Resume-JS7Worfklow -Folder /some_workflow_path -Recursive

Resumes suspended workflows that are available with the path /some_workflow_path and any sub-folders.

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

PS > Resume-JS7Workflow -All

Resumes all suspended workflows.

  • No labels