Page History

...

Start-JS7Order

SYNOPSIS

Starts orders for a workflow in the JobScheduler Controller.an existing order for the JS7 Controller

SYNTAX

Start-JS7Order [-OrderId] <String> [-Workflow] <String> [[-Directory] <String>] [[-ParametersVariables] <Hashtable>] [[-At] <String>] [[-TimezoneAtDate] <String><DateTime>] [[-RunTimeTimezone] <String>] [[-StateAuditComment] <String>] [[-EndStateAuditTimeSpent] <String><Int32>] [[-AuditCommentAuditTicketLink] <String><Uri>] [[-AuditTimeSpent] <Int32>WhatIf] [ [-AuditTicketLinkConfirm] <Uri>] [<CommonParameters>]

DESCRIPTION

Start an existing orders for a workflow.order for the JS7 Controller and optionally adjust the start time and variables.

The following REST Web Service API resources are used:

* /orders/add
* /orders/cancel

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies Specifies the identifier of an the order.

Workflow

-Workflow <String>
Specifies the path and name of a workflow for which orders should be started.

...

Directory

...

...

Variables

-Parameters Variables <Hashtable>
Specifies the parameters variables for the order. Parameters Variables are created from a hashmap,
i.e. a list of names and values.

Example:
$orderVariables = @{ 'var1' = 'value1'; 'var2' = 'value2' }

...

-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 <String>
Specifies the time zone to be considered for the start time that is indicated with the -At parameter.
Without this parameter the time zone of the JobScheduler JS7 Controller is assumed.

This parameter should be used if the JobScheduler 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

...

RunTime

-RunTime <String>

...

State

-State <String>
# .PARAMETER StartPosition
# Specifies that the order should enter the workflow at the workflow node that
# is assigend the specified stateposition.

...

EndState

-EndState <String>
#
# .PARAMETER EndPosition
# Specifies that the order should leave the workflow at the workflow node that
# is assigend the specified stateposition.
#

...

-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 enforece require Audit Log comments for any all 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 JobSchedulerJS7.

...

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

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Start-JobSchedulerOrder -Workflow /sos/reporting/Reporting

Starts an order of the specified workflow.

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

PS > Start-JobSchedulerOrder -Order 123 -Workflow /sos/reporting/Reporting

JS7Order -OrderId "#2020-11-23#T158058928-myTest03"

Starts the order with Order ID "#2020-11-23#T158058928-myTest03"Starts the order "123" of the specified workflow.

-------------------------- EXAMPLE 3 2 --------------------------

PS > Start-JobSchedulerOrder -Order 123 -Workflow /sos/reporting/Reporting -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 4 3 --------------------------

PS > Start-JobSchedulerOrder -Order 123 -Workflow /sos/reporting/Reporting -JS7Order -OrderId "#2020-11-23#T158058928-myTest03" -At "2038-01-01 00:00:00" -Timezone "Europe/Berlin"

...

-------------------------- EXAMPLE 5 4 --------------------------

PS > Start-JobSchedulerOrder -Workflow /sos/reporting/Reporting -Order 548 -JS7Order -OrderId "#2020-11-23#T158058928-myTest03" -At "now+3600" -Parameters Variables @{'param1var1' = 'value1'; 'param2var2' = 'value2'}

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