Name

Get-JS7Workflow

SYNOPSIS

Returns workflows from the JOC Cockpit inventory

SYNTAX

Get-JS7Workflow [[-WorkflowPath] <String>] [[-WorkflowVersionId] <String>] [[-Folder] <String>] [-Recursive] [-Suspended] [-Outstanding] [-Synchronized] [-NotSynchronized] [-SkippedInstruction] [-StoppedInstruction] [[-Tag] <String[]>] [[-AgentName] <String[]>] [[-RegularExpression] <String>] [-Compact] [<CommonParameters>]

DESCRIPTION

Workflows are returned from JOC Cockpit, independently of their deployment status with specific Controller instances.
Workflows can be selected by the folder of the workflow location including sub-folders or by the workflow name or path.

Resulting workflows can be forwarded to other cmdlets for pipelined bulk operations.

The following REST Web Service API resources are used:

* /workflows

PARAMETERS

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path or name of a workflow that should be returned.

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

WorkflowVersionId

-WorkflowVersionId <String>
Deployed workflows are assigned a version identifier. This parameter allows selection of
a workflow that is assigned the specified version identifier.

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

Folder

-Folder <String>
Optionally specifies the folder for which workflows should be returned.

Required?false
Position?3
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

Suspended

-Suspended <SwitchParameter>
Filters workflows to be returned that are in suspended state. Such workflows are frozen.

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

Outstanding

-Outstanding <SwitchParameter>
Filters workflows to be returned that are in outstanding state. Such workflows are not confirmed by Agents to be successfully suspended or resumed.

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

Synchronized

-Synchronized <SwitchParameter>
Filters workflows to be returned that are in sync between JOC Cockpit inventory and Controller.

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

NotSynchronized

-NotSynchronized <SwitchParameter>
Filters workflows to be returned that are not in sync between JOC Cockpit inventory and Controller.

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

SkippedInstruction

-SkippedInstruction <SwitchParameter>
Filters workflows to be returned that include skipped instructions.

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

StoppedInstruction

-StoppedInstruction <SwitchParameter>
Filters workflows to be returned that include stopped instructions.

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

Tag

-Tag <String[]>
Filters workflows by a list of tags.

If more than one tag is specified then they are separated by comma.

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

AgentName

-AgentName <String[]>
Filters workflows by Agents that are assigned to jobs in the workflow.

If more than one Agent Name is specified, then they are separated by comma.

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

RegularExpression

-RegularExpression <String>
Limits results to workflow paths that correspond to the given regular expression.

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

Compact

-Compact <SwitchParameter>
Specifies that fewer attributes of a workflow are returned.

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

about_JS7

EXAMPLES

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

PS > $workflows = Get-JS7Workflow

Returns all workflows.

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

PS > $workflows = Get-JS7Workflow -Folder /some_folder -Recursive

Returns workflows that are available with the specified folder including any sub-folders.

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

PS > $workflows = Get-JS7Workflow -WorkflowPath workflow1

Returns the workflow "workflow1" independently from its folder location.

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

PS > $workflows = Get-JS7Workflow -Suspended

Returns workflows that are in suspended state.

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

PS > $workflows = Get-JS7Workflow -Tag ProductDemo,ScheduledExecution

Returns workflows that hold one or more of the tags specified.

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

PS > $workflows = Get-JS7Workflow -AgentName primaryAgent,secondaryAgent

Returns workflows that hold jobs assigned one of the Agents specified.

  • No labels