Page History
...
New-JS7DailyPlanOrder
SYNOPSIS
Create the Creates daily plan orders for a number of JS7 ControllerControllers
SYNTAX
New-JS7DailyPlanOrder [[-WorkflowPath] <String>] [[-WorkflowFolder] <String>] [[-SchedulePath] <String>] [[-FolderScheduleFolder] <String>] [-Recursive] [[-ControllerId] <String>] [-Submit] [-Overwrite] [[-DateFrom] <DateTime>] [[-DailyPlanDateDateTo] <DateTime>] [[-SubmitRelativeDateFrom] <String>] [[-OverwriteRelativeDateTo] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates daily plan orders for a number of JS7 ControllerControllers. Orders are can be submitted to any
JS7 Controllers that are deployed the respective workflows.
The following REST Web Service API resources are used:
* /daily_plan/orders/generate
PARAMETERS
WorkflowPath
-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which daily plan orders should be created.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WorkflowFolder
-WorkflowFolder <String>
Optionally specifies a folder with schedules for which daily plan orders should be created.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
SchedulePath
-SchedulePath <String>
Optionally specifies the path and name of a schedule for which daily plan orders should be created.
| Required? | false |
| Position? | 13 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
ScheduleFolder
-Folder ScheduleFolder <String>
Optionally specifies the a folder with schedules for which daily plan orders should be created.
| Required? | false | |
| Position? | 24 | |
| Default value | / | |
| Accept pipeline input? | true (ByPropertyName) | |
| Accept wildcard characters? | false |
...
-Recursive <SwitchParameter>
Optionally specifies that schedules are looked up in When used with the -WorkflowFolder or -ScheduleFolder parameters then any sub-folders recursively
if used with the -Folder parameterare looked up recursively
for workflows or schedules for which to create orders.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-ControllerId <String>
Specifies the Controller to which daily plan orders are submitted should the -Submit switch be used.
Without this parameter daily plan orders are submitted to any Controllers that are deployed together with the
workflows that are indicated with the respective schedulestheir respective schedules.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Submit
-Submit <SwitchParameter>
Specifies to immediately submit the daily plan orders to a JS7 Controller.
| Required? | false | ||
| Position? | 3 | ? | named |
| Default value | False | ||
| Accept pipeline input? | true (ByPropertyName) | ||
| Accept wildcard characters? | false |
Overwrite
-Overwrite <SwitchParameter>
Specifies to overwrite daily plan orders for the same date and schedule.
If such orders exist with a Controller and the -Submit parameter is used then they are cancelled and re-created.
| Required? | false |
| Position? | named |
| Default value | FalseDefault value |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
DateFrom
-DailyPlanDate DateFrom <DateTime>
Specifies Optionally specifies the date for starting from which daily plan orders should be created.
Consider that a UTC date has to be provided.
Default: Beginning of the current day as a UTC date
| Required? | false |
| Position? | 46 |
| Default value | (Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
DateTo
-Submit <SwitchParameter>
Specifies to immediately submit the DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be created.
Consider that a UTC date has to a JS7 Controller. be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | named7 |
| Default valueFalse | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
RelativeDateFrom
-Overwrite <SwitchParameter>RelativeDateFrom <String>
Specifies to overwrite daily plan orders for the same date and schedule.
If such orders exist with a Controller and the -Submit parameter is used then they are cancelled and re-createda relative date starting from which daily plan orders should be created, 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.
This parameter takes precedence over the -DateFrom parameter.
| Required? | false |
| Position? | 8 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RelativeDateTo
-RelativeDateTo <String>
Specifies a relative date until which daily plan orders should be created, 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.
This parameter takes precedence over the -DateTo parameter.
| Required? | false | |
| Position? | named9 | |
| Default value | False | |
| Accept pipeline input? | true (ByPropertyName) | |
| Accept wildcard characters? | false |
...
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of the JOC Cockpit.
This parameter is not mandatory. However, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.
| Required? | false |
| Position? | 510 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.
| Required? | false |
| Position? | 611 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobSchedulerJS7.
This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.
| Required? | false |
| Position? | 712 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WhatIf
-WhatIf <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Confirm
-Confirm <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
...
PS > New-JS7DailyPlanOrder -DailyPlanDate DateFrom "2020-12-31" -ControllerId Controller
Creates daily plan orders from any schedules for the given day that make use of workflows deployed to the indicated Controller.
-------------------------- EXAMPLE 2 --------------------------
PS > New-JS7DailyPlanOrder -DailyPlanDate -DateFrom "2020-12-15" -DateTo "2020-12-31" -Submit -Overwrite
Creates daily plan orders from any schedules for the given date range and submits them to any Controllers that are deployed the respective workflows.
-------------------------- EXAMPLE 3 --------------------------
PS > New-JS7DailyPlanOrder -DailyPlanDate DateTo (Get-Date).AddDays(3) -SchedulePath /daily/eod
Creates daily plan orders from the indicated schedule for starting from today until a date three days from now.
...
PS > New-JS7DailyPlanOrder -DailyPlanDate DateFrom "2020-12-31" -Folder /daily -Recursive
...
Overview
Content Tools