Page History
...
Start-JS7Order [-OrderId] <String> [[-ArgumentsVariables] <Hashtable>] [[-At] <String>] [[-AtDate] <DateTime>] [[-Timezone] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
...
Start an existing order for the JS7 Controller and optionally adjust the start time and arguments.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
-Arguments Variables <Hashtable>
Specifies the arguments variables for the order. Arguments Variables are created from a hashmap,
i.e. a list of names and values.
Example:
$orderArgs $orderVariables = @{ 'arg1var1' = 'value1'; 'arg2var2' = 'value2' }
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-Timezone <String>
Specifies the time zone to be considered for the start time that is indicated with the -At argumentparameter.
Without this argument parameter the time zone of the JS7 Controller is assumed.
This argument 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 <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 enforce require Audit Log comments for any all interventions.
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-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.
| Required? | false |
| Position? | 7 |
| Default value | 0 |
| 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 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? | 8 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
PS > Start-JS7Order -OrderId "#2020-11-23#T158058928-myTest03"
Starts the order with order Order ID "#2020-11-23#T158058928-myTest03".
...
PS > Start-JS7Order -OrderId "#2020-11-23#T158058928-myTest03" -At "now+3600" -Arguments Variables @{'arg1var1' = 'value1'; 'arg2var2' = 'value2'}
Starts the order with the specified order Order ID. The order will start one hour later and will use the arguments from the specified hashmap.
Overview
Content Tools