Page History
...
Returns the daily plan orders for workflows scheduled for a number of JS7 ControllerControllers
SYNTAX
Get-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowFolder] <String>] [[-SchedulePath] <String>] [[-FolderScheduleFolder] <String>] [-Recursive] [[-ControllerId] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [-Late] [-SuccessfulPlanned] [-FailedSubmitted] [-InProgress] [-PlannedFinished] [<CommonParameters>]
DESCRIPTION
The daily plan orders for workfows workflows of a number of JS7 Controllers are returned.
The following REST Web Service API resources are used:
* /daily_plan/orders
PARAMETERS
OrderId
-OrderId <String>
| 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 daily plan orders should be returned.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WorkflowFolder
-WorkflowFolder <String>
| Required? | false |
| Position? | 31 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-SchedulePath <String>
Optionally specifies the path and name of a schedule for which daily plan orders should be returned.
| Required? | false |
| Position? | 24 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
ScheduleFolder
-Folder <String>
Optionally specifies the folder with workflows for which daily plan orders should be returned. ScheduleFolder <String>
| Required? | false |
| Position? | 35 |
| Default value/ | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateFrom
-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan orders should be returned.
Consider that a UTC date has to be provided.
Default: Begin Beginning of the current day as a UTC date
| Required? | false |
| Position? | 47 |
| Default value | (Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be returned.
Consider that a UTC date has to be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | 58 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateFrom <String>
Specifies a relative date starting from which daily plan orders should be returned, e.g.
* -1d, -2d: one day ago, two days ago
* +1d, +2d: one day later, two days later
* -1w, -2w: one week ago, two weeks ago
* +1w, +2w: one week later, two weeks later
* -1M, -2M: one month ago, two months ago
* +1M, +2M: one month later, two months later
* -1y, -2y: one year ago, two years ago
* +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.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 69 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RelativeDateTo <String>
Specifies a relative date until which daily plan orders should be returned, e.g.
* -1d, -2d: one day ago, two days ago
* +1d, +2d: one day later, two days later
* -1w, -2w: one week ago, two weeks ago
* +1w, +2w: one week later, two weeks later
* -1M, -2M: one month ago, two months ago
* +1M, +2M: one month later, two months later
* -1y, -2y: one year ago, two years ago
* +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.
This parameter takes precedence over the -DateFrom DateTo parameter.
| Required? | false |
| Position? | 710 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Timezone <TimeZoneInfo>
Specifies the timezone to which dates should be converted in the daily plan information.
A timezone can e.g. be specified like this:
Get-JSDailyPlan JSDailyPlanOrder -Timezone (Get-Timezone -Id 'GMT Standard Time')
All dates in JobScheduler JS7 are UTC and can be converted e.g. to the local time zone like this:
Get-JSDailyPlan JSDailyPlanOrder -Timezone (Get-Timezone)
Default: Dates are returned in UTC.
| Required? | false |
| Position? | 811 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | falsetrue (ByPropertyName) |
| Accept wildcard characters? | false |
...
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Planned
-Successful Planned <SwitchParameter>
Specifies that daily plan orders are returned completed successfullythat have not been submitted.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Submitted
-Failed Submitted <SwitchParameter>
Specifies that daily plan orders are returned that completed with errors.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
InProgress
-InProgress <SwitchParameter>
Specifies that daily plan orders are returned for jobs, orders, job streams that did not yet completeare submitted to a Controller for scheduled execution.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Finished
-Planned Finished <SwitchParameter>
Specifies that daily plan orders are returned that did not yet startcomplete.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Returns today's daily plan orders for any jobs workflows with dates being converted to the local timezone.
...
Returns today's daily plan orders for any jobs workflows with dates being converted to the GMT timezone.
...
PS > $orders = Get-JS7DailyPlanOrder -Failed Submitted -Late
Returns today's daily plan orders for jobs that failed or that have been submitted but are late, i.e. that did not start at the expected point in time.
...
Returns the daily plan orders for the given indicated workflow.
Overview
Content Tools