Page History

Name

Get-JS7Order

SYNOPSIS

Returns orders from the JS7 Controller

SYNTAX

Get-JS7Order [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowVersionId] <String>] [[-Folder] <String>] [-Recursive] [[-DateTo] <DateTime>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-RegularExpression] <String>] [-Compact] [-Pending] [-InProgress] [-Running] [-Suspended] [-Waiting] [-Failed] [-Blocked] [-IgnoreFailed] [<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 ID.

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

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies the identifier of an order that should be returned.

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which orders should be returned.

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

WorkflowVersionId

-WorkflowVersionId <String>
Deployed workflows can be assigned a version identifier. This parameters allows to select
workflows that are assigned the specified version.

Folder

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

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

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.

DateTo

-DateTo <DateTime>
Specifies the date until which orders should be returned.
Consider that a UTC date has to be provided.

Default should no order ID be provided: End of the current day as a UTC date

RelativeDateTo

-RelativeDateTo <String>
Specifies a relative date until which orders should be returned, e.g.

* 1s, 2s: one second later, two seconds later
* 1m, 2m: one minute later, two minutes later
* 1h, 2h: one hour later, two hours later
* 1d, 2d: one day later, two days later
* 1w, 2w: one week later, two weeks later
* 1M, 2M: one month later, two months later
* 1y, 2y: one year later, two years later

Optionally a time offset can be specified, e.g. 1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using 1d+TZ, that is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone to which a relative date specified with the -RelativeDateTo parameter should be converted.
A timezone can e.g. be specified like this:

Get-JS7Order -Timezone (Get-Timezone -Id 'GMT Standard Time')

All dates in JS7 are UTC and can be converted e.g. to the local time zone like this:

Get-JS7Order -Timezone (Get-Timezone)

Default: Dates are converted to UTC.

RegularExpression

-RegularExpression <String>
Specifies that a regular expession is applied to the order IDs to filter results.

Compact

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

Pending

-Pending <SwitchParameter>
Specifies that orders in a pending state should be returned. Such orders are scheduled
for a later start.

InProgress

-InProgress <SwitchParameter>
Specifies that orders in progress should be returned, i.e. orders that started but that
are currently not executing jobs.

Running

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

Suspended

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

Waiting

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

Failed

-Failed <SwitchParameter>
Specifies that orders in a failed state should be returned. Orders are considered being failed
if a job in the workflow fails.

Blocked

-Blocked <SwitchParameter>
Specifies that orders should be returned that are 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.

IgnoreFailed

-IgnoreFailed <SwitchParameter>
Specifies that errors relating to orders not being found are ignored.
An empty response will be returned.

RELATED LINKS

about_JS7

EXAMPLES

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

PS > $orders = Get-JS7Order

Returns all 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" including 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. after job failures, or that are waiting to retry execution of a job after failure.