PowerShell CLI 2.0 - Cmdlets - Get-JS7OrderHistory

Name

Get-JS7OrderHistory

SYNOPSIS

Returns the order execution history for workflows.

SYNTAX

Get-JS7OrderHistory [[-OrderId] <String>] [[-WorkflowId] <PSObject>] [[-WorkflowPath] <String>] [[-Folder] <String>] [-Recursive] [[-ExcludeOrder] <String[]>] [[-RegularExpression] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-Limit] <Int32>] [-Successful] [-Failed] [-InProgress] [<CommonParameters>]

DESCRIPTION

History information is returned for orders from a JobScheduler Controller.
Order executions can be selected by workflow, order ID, folder, history status etc.

The history information retured includes start time, end time, return code etc.

PARAMETERS

OrderId

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

WorkflowId

-WorkflowId <PSObject>

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which history information is returned.
If the name of a workflow is specified then the -Folder 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 -OrderId -Folder or -WorkflowPath has to be specified.

Folder

-Folder <String>
Optionally specifies the folder for which jobs should be returned. The folder is determined
from the root folder.

Recursive

-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up when used with the -Folder parameter.
By default no sub-folders will be looked up for jobs.

ExcludeOrder

-ExcludeOrder <String[]>
This parameter accepts a single workflow path or an array of workflow paths that are excluded from the results.
Optionally the workflow path can be appended an order ID separated by a semicolon.

RegularExpression

-RegularExpression <String>
Specifies a regular expression that filters orders to be returned.
The regular expression is applied to the order ID.

DateFrom

-DateFrom <DateTime>
Specifies the date starting from which history items should be returned.
Consider that a UTC date has to be provided.

Default: Begin of the current day as a UTC date

DateTo

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

Default: End of the current day as a UTC date

RelativeDateFrom

-RelativeDateFrom <String>
Specifies a relative date starting from which history items should be returned, e.g.

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

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.

This parameter takes precedence over the -DateFrom parameter.

RelativeDateTo

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

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

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.

This parameter takes precedence over the -DateFrom parameter.

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted from the history information.
A timezone can e.g. be specified like this:

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

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

Get-JS7OrderHistory -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

Limit

-Limit <Int32>
Specifies the max. number of history items for order executions to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.

Successful

-Successful <SwitchParameter>
Returns history information for successfully completed orders.

Failed

-Failed <SwitchParameter>
Returns history information for failed orders.

InProgress

-InProgress <SwitchParameter>
Specifies that history information for running orders should be returned.

RELATED LINKS

about_JS7

EXAMPLES

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

PS > $items = Get-JS7OrderHistory

Returns today's order execution history for any orders.

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

PS > $items = Get-JS7OrderHistory -RegularExpression '^/sos'

Returns today's order execution history for any orders from the /sos folder.

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

PS > $items = Get-JS7OrderHistory -RegularExpression 'report'

Returns today's order execution history for orders that contain the string 'report' in the order's path.

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

PS > $items = Get-JS7OrderHistory -Timezone (Get-Timezone)

Returns today's order execution history for any orders with dates being converted to the local timezone.

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

PS > $items = Get-JS7OrderHistory -Timezone (Get-Timezone -Id 'GMT Standard Time')

Returns today's order execution history for any orders with dates being converted to the GMT timezone.

-------------------------- EXAMPLE 6 --------------------------

PS > $items = Get-JS7OrderHistory -WorkflowPath /sos/dailyplan/CreateDailyPlan

Returns today's order execution history for a given workflow.

-------------------------- EXAMPLE 7 --------------------------

PS > $items = Get-JS7OrderHistory -ExcludeOrder /sos/dailyplan/CreateDailyPlan, /sos/notification/SystemNotifier:MonitorSystem

Returns today's order execution history for any orders excluding orders from the specified workflow paths. The workflow path '/sos/notification/SystemNotifier' is appended the order ID 'MonitorSystem' separated by a semicolon to indicate that the specified order ID only is excluded from the results.

-------------------------- EXAMPLE 8 --------------------------

PS > $items = Get-JS7OrderHistory -Successful -DateFrom "2020-08-11 14:00:00Z"

Returns the order execution history for successfully completed orders that started after the specified UTC date and time.

-------------------------- EXAMPLE 9 --------------------------

PS > $items = Get-JS7OrderHistory -Failed -DateFrom (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(-7).ToUniversalTime()

Returns the order execution history for any failed orders for the last seven days.

-------------------------- EXAMPLE 10 --------------------------

PS > $items = Get-JS7OrderHistory -RelativeDateFrom -7d

Returns the order execution history for the last seven days. The history is reported starting from midnight UTC.

-------------------------- EXAMPLE 11 --------------------------

PS > $items = Get-JS7OrderHistory -RelativeDateFrom -7d+01:00

Returns the order execution history for the last seven days. The history is reported starting from 1 hour after midnight UTC.

-------------------------- EXAMPLE 12 --------------------------

PS > $items = Get-JS7OrderHistory -RelativeDateFrom -7d+TZ

Returns the order execution history for the last seven days. The history is reported starting from midnight in the same timezone that is used with the -Timezone parameter.

-------------------------- EXAMPLE 13 --------------------------

PS > $items = Get-JS7OrderHistory -RelativeDateFrom -1w

Returns the order execution history for any jobs for the last week.

-------------------------- EXAMPLE 14 --------------------------

PS > $items = Get-JS7OrderHistory -Folder /sos -Recursive -Successful -Failed

Returns today's order execution history for any completed orders from the "/sos" folder and any sub-folders recursively.