JS7 JobScheduler

Space shortcuts

Page tree

Name

Start-JS7Order

SYNOPSIS

Starts an existing order for the JS7 Controller

SYNTAX

Start-JS7Order [-OrderId] <String> [[-Variables] <Hashtable>] [[-At] <String>] [[-AtDate] <DateTime>] [[-Timezone] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Start an existing 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>
Specifies the identifier of the order.

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

Variables

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

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

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

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.

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

AtDate

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

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

Timezone

-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 JS7 Controller is assumed.

This parameter 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

# .PARAMETER StartPosition
# Specifies that the order should enter the workflow at the workflow node that
# is assigend the specified position.
#
# .PARAMETER EndPosition
# Specifies that the order should leave the workflow at the workflow node that
# is assigend the specified position.
#

Required?false
Position?5
Default value
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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

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

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

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

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

WhatIf

-WhatIf <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

Confirm

-Confirm <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

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" -Variables @{'var1' = 'value1'; 'var2' = '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.

  • No labels