JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Name

Remove-JS7DailyPlanOrder

SYNOPSIS

Removes the daily plan orders for a JS7 Controller

SYNTAX

Remove-JS7DailyPlanOrder [[-OrderId] <String>] [[-WorkflowPath] <String>] [[-SchedulePath] <String>] [[-DailyPlanDate] <DateTime>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

Removes daily plan orders from a JS7 Controller.

PARAMETERS

OrderId

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

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

WorkflowPath

-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

SchedulePath

-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

DailyPlanDate

-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 day as a UTC date

Required?false
Position?4
Default value(Get-Date (Get-Date).ToUniversalTime() -Format 'yyyy-MM-dd')
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?5
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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.

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

about_JS7

EXAMPLES

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

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

Removes any daily plan orders for the given day.

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

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

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

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

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

Removes the given order ID from the daily plan.

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

PS > Remove-JS7DailyPlanOrder -WorkflowPath /some_folder/some_workflow

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

  • No labels