Page History
...
Start-JS7Order
SYNOPSIS
Starts existing orders for a workflow in the JobScheduler JS7 Controller.
SYNTAX
Start-JS7Order [-OrderId] <String> [-Workflow] <String> [[-Directory] <String>] [[-ParametersArguments] <Hashtable>] [[-At] <String>] [[-TimezoneAtDate] <String><DateTime>] [[-RunTimeTimezone] <String>] [[-State] <String>] [[-EndState] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
...
Start existing orders for a workflowthe JS7 Controller and optionally adjust the start time and arguments.
PARAMETERS
OrderId
-OrderId <String>
Optionally specifies Specifies the identifier of an the order.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Workflow
-Workflow <String>
Specifies the path and name of a workflow for which orders should be started.
...
Directory
...
Arguments
-Arguments
| Required? | false |
| Position? | 3 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Parameters
-Parameters <Hashtable>
Specifies the parameters arguments for the order. Parameters Arguments are created from a hashmap,
i.e. a list of names and values.
Example:
$orderArgs = @{ 'arg1' = 'value1'; 'arg2' = 'value2' }
| Required? | false |
| Position? | 42 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-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 value | now |
| 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. Default: now
| Required? | false | |
| Position? | 54 | |
| Default value | now | |
| 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 parameterargument.
Without this parameter argument the time zone of the JobScheduler JS7 Controller is assumed.
This parameter argument 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
| Required? | false | |
| Position? | 6 | Default value |
| Accept pipeline input? | true (ByPropertyName) | |
| Accept wildcard characters? | false |
RunTime
-RunTime <String>
| 5 | |
| Required? | false |
| Position? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-State <String>
Specifies that the order should enter the workflow at the workflow node that
is assigend the specified state.
| Required? | false |
| Position? | 86 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-EndState <String>
Specifies that the order should leave the workflow at the workflow node that
is assigend the specified state.
| Required? | false |
| Position? | 97 |
| 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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.
| Required? | false |
| Position? | 108 |
| 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 the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.
| Required? | false |
| Position? | 119 |
| 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 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.
| Required? | false |
| Position? | 1210 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-------------------------- 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 Arguments @{'param1arg1' = 'value1'; 'param2arg2' = '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.
Overview
Content Tools