Versions Compared

Key

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

...

Removes daily plan orders from a number of JS7 ControllersController

SYNTAX

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

...

Removes daily plan orders from a number of JS7 ControllersController.

The following REST Web Service API resources are used:

* /daily_plan/orders/delete

PARAMETERS

OrderId

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

...

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

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

WorkflowFolder

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

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

...

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

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

...

ScheduleFolder

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

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

...

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

...

-ControllerId <String>
Specifies the Controller to from 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?56
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

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

Default: Begin Beginning of the current day as a UTC date

Required?false
Position?67
Default value(Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd')
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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?78
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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?89
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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?910
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

Required?false
Position?1011
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 shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.

Required?false
Position?1112
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 JobSchedulerJS7.

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

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

...

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

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

...