Page History
Name
Get-JS7Workflow
SYNOPSIS
Returns workflows from the JS7 JOC Cockpit.
SYNTAX
Get-JS7Workflow [[-WorkflowPath] <String>] [[-Directory] <String>] [-Recursive] [[-RegularExpression] <String>] [-Compact] [<CommonParameters>]
DESCRIPTION
Workflows are returned from JOC Cockpit - independent of their deployment status with specific Controller instances..
Workflows can be selected either by the folder of the workflow location including sub-folders or by an individual workflow.
Resulting workflows can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
WorkflowPath
-WorkflowPath <String>
Optionally specifies the path and name of a workflow that should be returned.
If the name of a workflow is specified then the -Directory parameter is used to determine the folder.
Otherwise the -WorkflowPath parameter is assumed to include the full path and name of the workflow.
One of the parameters -Directory or -WorkflowPath has to be specified.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the folder for which workflows should be returned.
One of the parameters -Directory and -WorkflowPath has to be specified.
Required? | false |
Position? | 2 |
Default value | / |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
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 |
RegularExpression
-RegularExpression <String>
Limits result to workflow paths that correspond the given regular expression.
Required? | false |
Position? | 3 |
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 value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $workflows = Get-JS7Workflow
Returns all workflows.
-------------------------- EXAMPLE 2 --------------------------
PS > $workflows = Get-JS7Workflow -Directory /some_path -Recursive
Returns all workflows that are configured with the specified path including any sub-folders.
-------------------------- EXAMPLE 3 --------------------------
PS > $workflows = Get-JS7Workflow -WorkflowPath /test/globals/workflow1
Returns the workflow "workflow1" from the folder "/test/globals".