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

Compare with Current View Page History

Version 1 Next »

Name

Get-JS7Order

SYNOPSIS

Returns orders from the JS7 Controller.

SYNTAX

Get-JS7Order [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowVersionId] <String>] [[-Folder] <String>] [-Recursive] [[-RegularExpression] <String>] [-Compact] [-Pending] [-Running] [-Suspended] [-Waiting] [-Failed] [-Blocked] [<CommonParameters>]

DESCRIPTION

Orders are selected from the JS7 Controller

* by the folder of the order location including sub-folders,
* by the workflow that is assigned to an order,
* by an individual order.

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

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies the path and name of an order that should be returned.
If the name of an order is specified then the -Folder parameter is used to determine the folder.
Otherwise the -Order parameter is assumed to include the full path and name of the order.

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

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which orders should be returned.
If the name of a workflow is specified then the -Folder parameter is used to determine the folder.
Otherwise the -Workflow parameter is assumed to include the full path and name of the workflow.

One of the parameters -Folder, -WorkflowPath or -Order has to be specified if no pipelined order objects are provided.

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

WorkflowVersionId

-WorkflowVersionId <String>

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

Folder

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

One of the parameters -Folder, -WorkflowPath or -Order has to be specified if no pipelined order objects are provided.

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

Recursive

-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up if the -Folder parameter is used.
By default no sub-folders will be searched for orders.

Required?false
Position?named
Default valueFalse
Accept pipeline input?false
Accept wildcard characters?false

RegularExpression

-RegularExpression <String>
Specifies that any sub-folders should be looked up if the -Folder parameter is used.
By default no sub-folders will be searched for orders.

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

Compact

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

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

Pending

-Pending <SwitchParameter>
Specifies that orders in a pending state should be returned. Such orders are scheduled
for a later start. This state can apply to permanent orders and to ad hoc orders.

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

Running

-Running <SwitchParameter>
Specifies that orders in a running state should be returned, i.e. orders for which a job is
executed in a workflow.

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

Suspended

-Suspended <SwitchParameter>
Specifies that orders in suspended state should be returned. An order can be suspended
e.g. in case of failure of the underlying job or when being affected by the
Suspend-JobSchedulerOrder cmdlet or the respective manual operation from the GUI.

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

Waiting

-Waiting <SwitchParameter>
Specifies that orders in a setback state should be returned. Such orders make use of an interval
- specified by the underlying job - for which they are repeated in case that the job fails.

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

Failed

-Failed <SwitchParameter>
Specifies that orders in a setback state should be returned. Such orders make use of an interval
- specified by the underlying job - for which they are repeated in case that the job fails.

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

Blocked

-Blocked <SwitchParameter>
Specifies that orders should be returned that represent incoming files that a Controller or Agent
is watching for and for which errors occurred when moving the incoming file from its location.

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

about_jobscheduler

EXAMPLES

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

PS > $orders = Get-JS7Order

Returns orders available with a JS7 Controller.

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

PS > $orders = Get-JS7Order -Folder /some_path -Recursive

Returns all orders that are configured for workflows with the folder "some_path" inclluding any sub-folders.

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

PS > $orders = Get-JS7Order -WorkflowPath /test/globals/workflow1

Returns the orders for workflow "workflow1" from the folder "/test/globals".

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

PS > $orders = Get-JS7Order -OrderId 2020-11-19#P0000000498-orderSampleWorfklow2a

Returns the order with the respective identifier

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

PS > $orders = Get-JS7Order -Suspended -Waiting

Returns any orders that have been suspended, e.g. due to job failures, or that are waiting for Agents or tasks to become available for the underlying job.

  • No labels