PowerShell CLI 2.0 - Cmdlets - New-JS7DailyPlanOrder

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] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<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.

Folder

-Folder <String>
Optionally specifies the a folder with schedules for which daily plan orders should be created.

Recursive

-Recursive <SwitchParameter>
Optionally specifies that schedules are looked up in any sub-folders recursively
if used with the -Folder parameter.

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.

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

Submit

-Submit <SwitchParameter>
Specifies to immediately submit the daily plan orders to a JS7 Controller.

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.

AuditComment

-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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any interventions.

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.

AuditTicketLink

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.

This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.

RELATED LINKS

about_JS7

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.