Versions Compared

Key

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

...

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 ID.

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

...

-OrderId <String>
Optionally specifies the path and name unique identifier 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 <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 WorkflowPath parameter is assumed to include the full path and name of the workflow.

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

...

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

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

...

-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 <SwitchParameter>
Specifies that orders in a running state should be returned, i.e. orders for which a job ishas
been executed in a workflow.

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

...

-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.

...

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

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

...

-Failed <SwitchParameter>
Specifies that orders in a setback failed 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 Orders are considered being failed
if a job in the workflow fails.

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

...

-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 locationare blocked by a resource, e.g. if a job's task limit
is exceeded and the order has to wait for the next available task.

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

...

PS > $orders = Get-JS7Order

Returns all orders available with a JS7 Controller.

...

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

...

Returns any orders that have been suspended, e.g. due to after job failures, or that are waiting for Agents or tasks to become available for the underlying jobset back to retry execution of a job after failure.