Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Remove-JS7DailyPlanOrder

SYNOPSIS

Removes the daily plan orders for from a number of JS7 ControllerControllers

SYNTAX

Remove-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-SchedulePath] <String>] [[-DailyPlanDate] <DateTime>] [[-Folder] <String>] [-Recursive] [[-ControllerId] <String>] [-Late] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

...

Removes daily plan orders from a number of JS7 ControllerControllers.

PARAMETERS

OrderId

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

...

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

Required?false
Position?3
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Folder

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

Required?false
Position?4
Default value/
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Recursive

-Recursive <SwitchParameter>
When used with the -Folder parameter then any sub-folders of the specified folder will be looked up.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

ControllerId

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

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

Required?false
Position?5
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

DailyPlanDate

Late

-Late <SwitchParameter>
Specifies that daily plan orders are removed that are late or that started later than expected.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

DateFrom

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

Default: Current Begin 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

-DateTo <DateTime>
Optionally specifies the date until which daily plan orders should be removed.
Consider that a UTC date has to be provided.

Default: End of the current day as a UTC date

Required?false
Position?7
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

RelativeDateFrom

-RelativeDateFrom <String>
Specifies a relative date starting from which daily plan orders should be removed, 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 removed, 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?9
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

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 the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.

Required?false
Position?611
Default value0
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 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.

Required?false
Position?712
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

PS > Remove-JS7DailyPlanOrder -DailyPlanDate DateFrom "2020-12-31"

Removes any daily plan orders for the given daydate.

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

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

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

...

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

Removes the order with the given order ID from the daily plan.

...