Versions Compared

Key

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

...

Removes an order that completed a workflow either with a cancelled or finished state.

SYNTAX

Remove-JS7CompletedOrder [-OrderId] <String> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

...

Orders in a worklfow by default are automatically removed upon completion. However, it is possible
to make cause orders to remain in a workflow after completion. Such orders are either in a cancelled state
or in a finished state.

The cmdlet causes orders to be removed after completion.

The following REST Web Service API resources are used:

* /orders/remove_when_terminated

PARAMETERS

OrderId

-OrderId <String>
Specifies the identification of an order.

...

-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 argument is not mandatory, however, JOC Cockpit can be configured
to enforce Audit Log comments for any interventions.

...

-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 JS7.

...

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

...