PowerShell CLI 2.0 - Cmdlets - Submit-JS7DailyPlanOrder

Name

Submit-JS7DailyPlanOrder

SYNOPSIS

Submits daily plan orders to a number of JS7 Controllers

SYNTAX

Submit-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-WorkflowFolder] <String>] [[-SchedulePath] <String>] [[-ScheduleFolder] <String>] [-Recursive] [[-ControllerId] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

Submits daily plan orders to a number of JS7 Controllers.

The following REST Web Service API resources are used:

* /daily_plan/orders/submit

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies the Order ID of the daily plan order that should be submitted.

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow for which daily plan orders should be submitted.

WorkflowFolder

-WorkflowFolder <String>
Optionally specifies the folder with workflows for which daily plan orders should be submitted.

SchedulePath

-SchedulePath <String>
Optionally specifies the path and name of a schedule for which daily plan orders should be submitted.

ScheduleFolder

-ScheduleFolder <String>
Optionally specifies the folder with schedules for which daily plan orders should be submitted.

Recursive

-Recursive <SwitchParameter>
When used with the -WorkflowFolder or -ScheduleFolder parameters then any sub-folders of the specified folder will be looked up.

ControllerId

-ControllerId <String>
Specifies the Controller to which daily plan orders should be submitted.

Without this parameter daily plan orders are submitted to any Controllers that are deployed the
workflows that are indicated with the respective parameters.

DateFrom

-DateFrom <DateTime>
Optionally specifies the date starting from which daily plan orders should be submitted.
Consider that a UTC date has to be provided.

Default: Beginning of the current day as a UTC date

DateTo

-DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be submitted.
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 daily plan orders should be submitted, 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.

RelativeDateTo

-RelativeDateTo <String>
Specifies a relative date until which daily plan orders should be submitted, 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.

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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

AuditTimeSpent

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

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

AuditTicketLink

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

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

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Submit-JS7DailyPlanOrder -DateFrom "2020-12-31"

Submits any daily plan orders for the given date.

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

PS > Submit-JS7DailyPlanOrder -DateTo (Get-Date).AddDays(3)

Submits any daily plan orders starting from today until a date three days from now.

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

PS > Submit-JS7DailyPlanOrder -OrderId "#2020-11-19#P0000000498-orderSampleWorfklow2a"

Submits the order with the given Order ID to the daily plan.

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

PS > Submit-JS7DailyPlanOrder -WorkflowPath /some_folder/some_workflow

Submits the daily plan orders for the indicated workflow in today's daily plan.