PowerShell CLI 2.0 - Cmdlets - Set-JS7DailyPlanOrder

Name

Set-JS7DailyPlanOrder

SYNOPSIS

Updates daily plan orders

SYNTAX

Set-JS7DailyPlanOrder [-OrderId] <String> [[-ControllerId] <String>] [[-ScheduledFor] <DateTime>] [[-RelativeScheduledFor] <String>] [[-Period] <PSObject>] [[-Variables] <Hashtable>] [[-RemoveVariables] <String[]>] [[-StartPosition] <String>] [[-EndPositions] <String[]>] [[-BlockPosition] <String>] [-ForceJobAdmission] [-KeepDailyPlanAssignment] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The daily plan orders are updated for absolute or relative start times

The following REST Web Service API resources are used:

* /daily_plan/orders/modify

PARAMETERS

OrderId

-OrderId <String>
Specifies the Order ID of an existing daily plan order that should be updated.

ControllerId

-ControllerId <String>
Specifies the identification of the Controller to which orders will be submitted.

ScheduledFor

-ScheduledFor <DateTime>
Optionally specifies the date and time that the order should start. The date can be specified in any time zone.

One of the -ScheduledFor or -RelativeScheduledFor arguments has to be used.

RelativeScheduledFor

-RelativeScheduledFor <String>
Specifies a relative period for which the daily plan order should be started, e.g.

* now: start immediately
* now+HH:MM[:SS]: start with the given delay of hours, minutes, seconds
* now+SECONDS: start with the given delay in seconds
* cur+HH:MM[:SS]: start the number of hours, minutes, seconds after the current start time
* cur+SECONDS: start the number of seconds after the current start time
* cur-HH:MM[:SS]: start the number of hours, minutes, seconds before the current start time
* cur-SECONDS: start the number of seconds before the current start time

The argument is used alternatively to the -ScheduledFor argument.

Period

-Period <PSObject>
Specifies the period if a cyclic order should be updated. In addition to the order's start time, such orders hold a period definition.

The value for the -Period argument is returned when invoking the Get-JS7DailyPlanOrder cmdlet.
When used with the -RelativeScheduledFor argument, the period will be moved forward/backward accordingly:

Get-JS7Order -Folder /ProductDemo -Recursive -Scheduled | Get-JS7DailyPlanOrder -Cyclic | Set-JS7DailyPlanOrder -RelativeScheduledFor 'cur+03:00:00'



The value for the -Period argument can be created individually like this:

$Period = New-Object PSCustomObject
Add-Member -Membertype NoteProperty -Name 'begin' -value '15:30:00' -InputObject $Period
Add-Member -Membertype NoteProperty -Name 'end' -value '18:45:00' -InputObject $Period
Add-Member -Membertype NoteProperty -Name 'repeat' -value '00:30:00' -InputObject $Period

Variables

-Variables <Hashtable>
Optionally specifies a hashtable of Variables

A hashtable object holds pairs of names and values. It can be created like this:
$variables = @{ 'var_1'='some string'; 'var_2' = 23; 'var_3' = true}

RemoveVariables

-RemoveVariables <String[]>
Optionally specifies a list of variables that should be removed from the order.

StartPosition

-StartPosition <String>
Optionally specifies the label of the first instruction in the workflow that the order should execute.

EndPositions

-EndPositions <String[]>
Optionally specifies the list of labels corresponding to instructions in the workflow that the order should terminate with.

BlockPosition

-BlockPosition <String>
Optionally specifies the label of a block instruction in the workflow that the order should be started for.
The order will terminate with the end of the block instruction.

If the -StartPosition argument is used then the order will start from the indicated position in the block instruction.
If end positions are specified then the order will terminate with one of the end positions inside the block instruction.

ForceJobAdmission

-ForceJobAdmission <SwitchParameter>

KeepDailyPlanAssignment

-KeepDailyPlanAssignment <SwitchParameter>
Specifies that orders will remain assigned the original daily plan date in case that their start time is modified for
a date and time different from the original daily plan date.

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.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JS7

EXAMPLES

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

PS > $orders = Get-JS7DailyPlanOrder -WorkflowFolder /ProductDemo -Recursive -NoCyclic -DateFrom 2025-02-25
$orders | Set-JS7DailyPlanOrder -RelativeScheduledFor 'cur+03:00:00' -KeepDailyPlanAssignment

Moves the start time of non-cyclic orders of the indicated daily plan date 3 hours ahead.

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

PS > $orders = Get-JS7DailyPlanOrder -WorkflowFolder /ProductDemo -Recursive -Cyclic -DateFrom 2025-02-25 | Get-JS7Order -Scheduled | Get-JS7DailyPlanOrder
$orders | Set-JS7DailyPlanOrder -RelativeScheduledFor 'cur+03:00:00'

Moves the start time of scheduled, cylic orders of today's daily plan date 3 hours ahead.

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

PS > Get-JS7DailyPlanOrder -DateFrom 2025-02-25 | Set-JS7DailyPlanOrder -RelativeScheduledFor 'cur-03:00:00'

Moves the start time of all orders of the indicated daily plan date 3 hours earlier.