Name
New-JS7DailyPlanOrder
SYNOPSIS
Create the daily plan orders for a JS7 Controller
SYNTAX
New-JS7DailyPlanOrder [[-SchedulePath] <String>] [[-Folder] <String>] [-Recursive] [[-ControllerId] <String>] [[-DailyPlanDate] <DateTime>] [-Submit] [-Overwrite] [<CommonParameters>]
DESCRIPTION
Creates daily plan orders for a JS7 Controller. Orders are submitted to any
JS7 Controllers that are deployed the respective workflows.
PARAMETERS
SchedulePath
-SchedulePath <String>
Optionally specifies the path and name of a schedule for which daily plan orders should be created.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Folder
-Folder <String>
Optionally specifies the 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 |
Recursive
-Recursive <SwitchParameter>
Optionally specifies that schedules are looked up in any sub-folders recursively
if used with the -Folder parameter.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-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 the
workflows that are indicated with the respective schedules.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DailyPlanDate
-DailyPlanDate <DateTime>
Specifies the date for which daily plan orders should be created.
Consider that a UTC date has to be provided.
Default: current day as a UTC date
| Required? | false |
| Position? | 4 |
| Default value | (Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd') |
| 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? | 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 | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > New-JS7DailyPlanOrder -DailyPlanDate "2020-12-31"
Creates daily plan orders from any schedules for the given day.
-------------------------- EXAMPLE 2 --------------------------
PS > New-JS7DailyPlanOrder -DailyPlanDate "2020-12-31" -Submit -Overwrite
Creates daily plan orders from any schedules for the given date and submits them to the
-------------------------- EXAMPLE 3 --------------------------
PS > New-JS7DailyPlanOrder -DailyPlanDate (Get-Date).AddDays(3) -SchedulePath /daily/eod
Creates daily plan orders from the indicated schedule for a date three days from now.
-------------------------- EXAMPLE 4 --------------------------
PS > New-JS7DailyPlanOrder -DailyPlanDate "2020-12-31" -Folder /daily -Recursive
Creates daily plan orders for the given date from schedules that are available with the indicated folder and any sub-folders recursively.
Overview
Content Tools