PowerShell CLI 2.0 - Cmdlets - Start-JS7Order

Name

Start-JS7Order

SYNOPSIS

Starts an existing order the JS7 Controller

SYNTAX

Start-JS7Order [-OrderId] <String> [[-Arguments] <Hashtable>] [[-At] <String>] [[-AtDate] <DateTime>] [[-Timezone] <String>] [[-StartPosition] <String>] [[-EndPosition] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

Start an existing order for the JS7 Controller and optionally adjust the start time and arguments.

PARAMETERS

OrderId

-OrderId <String>
Specifies the identifier of the order.

Arguments

-Arguments <Hashtable>
Specifies the arguments for the order. Arguments are created from a hashmap,
i.e. a list of names and values.

Example:
$orderArgs = @{ 'arg1' = 'value1'; 'arg2' = 'value2' }

At

-At <String>
Specifies the point in time when the order should start. Values are added like this:

* now
** specifies that the order should start immediately
* now+1800
** specifies that the order should start with a delay of 1800 seconds, i.e. 30 minutes later.
* yyyy-mm-dd HH:MM[:SS]
** specifies that the order should start at the specified point in time.

AtDate

-AtDate <DateTime>
Specifies the date when the order should start. The time zone is used from the date provided.

Timezone

-Timezone <String>
Specifies the time zone to be considered for the start time that is indicated with the -At argument.
Without this argument the time zone of the JS7 Controller is assumed.

This argument should be used if the JS7 Controller runs in a time zone different to the environment
that makes use of this cmdlet.

Find the list of time zone names from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

StartPosition

-StartPosition <String>
Specifies that the order should enter the workflow at the workflow node that
is assigend the specified position.

EndPosition

-EndPosition <String>
Specifies that the order should leave the workflow at the workflow node that
is assigend the specified position.

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 enforece Audit Log comments for any interventions.

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.

AuditTicketLink

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

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Start-JS7Order -OrderId "#2020-11-23#T158058928-myTest03"

Starts the order with order ID "#2020-11-23#T158058928-myTest03".

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

PS > Start-JS7Order -OrderId "#2020-11-23#T158058928-myTest03" -At "now+1800"

Starts the specified order for a start time 30 minutes (1800 seconds) from now.

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

PS > Start-JS7Order -OrderId "#2020-11-23#T158058928-myTest03" -At "2038-01-01 00:00:00" -Timezone "Europe/Berlin"

Starts the indicated order for a later date that is specified for the "Europe/Berlin" time zone.

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

PS > Start-JS7Order -OrderId "#2020-11-23#T158058928-myTest03" -At "now+3600" -Arguments @{'arg1' = 'value1'; 'arg2' = 'value2'}

Starts the order with the specified order ID. The order will start one hour later and will use the arguments from the specified hashmap.