Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Get-JS7DeployableItem

SYNOPSIS

Returns deployable configuration objects such as workflows from the JOC Cockpit inventory.

SYNTAX

Get-JS7DeployableItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [<CommonParameters>]

DESCRIPTION

This cmdlet returns deployable configuration objects from the JOC Cockpit inventory.

PARAMETERS

Path

-Path <String>
Specifies the folder, sub-folder and name of the object, e.g. a workflow path.

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

Type

-Type <String[]>
Specifies the object type which is one of:

* FOLDER
* WORKFLOW
* JOBCLASS
* LOCK
* JUNCTION
* FILEORDERSOURCE

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

Folder

-Folder <String>
Optionally specifies the folder for which included inventory objects should be returned.
This parameter is used alternatively to the -Path parameter that specifies to return an individual inventory object.

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

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

about_JS7

EXAMPLES

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

PS > Get-JS7DeployableItem -Path /TestCases/sampleWorkflow_001 -Type 'WORKFLOW'

Returns the specified workflow from the indicated path.

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

PS > Get-JS7DeployableItem -Folder /TestRuns -Type 'FOLDER'

Returns deployable objects such as workflows from the specified folder recursively.