Page History
...
Add-JS7Order [-WorkflowPath] <String> [[-OrderName] <String>] [[-Variables] <Hashtable>] [[-At] <String>] [[-AtDate] <DateTime>] [[-Timezone] <String>] [[-BlockPosition] <String>] [[-StartPosition] <Int32><String>] [[-EndPositions] <Int32] <String[]>] [[-Tag] <String[]>] [-ForceJobAdmission] [[-ControllerId] <String>] [[-BatchSize] <Int32>] [[-RunningNumber] <Int32>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
...
-WorkflowPath <String>
Specifies the path and/or name of a workflow for which an order should be added.
...
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
BlockPosition
-BlockPosition <String>
| Required? | false |
| Position? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
StartPosition
-StartPosition <Int32><String>
Specifies the label of an instruction in the workflow that the order should enter the workflow at the workflow node that
is assigned the specified positionwill be started for.
The top-level instructions in a workflow are allowed start positions. If an instruction inside some block Instruction
should be used as the start position, then the -BlockPosition argument can be used to specify the label of the block
and the -StartPosition argument can be used to specify the label of an instruction inside the block.
| Required? | false | |
| Position? | 78 | |
| Default value | 0 | |
| Accept pipeline input? | true (ByPropertyName) | |
| Accept wildcard characters? | false |
EndPositions
-EndPositions <Int32<String[]>
Specifies that the labels of instructions in the workflow at which the order should leave the workflow at the workflow nodes that
are assigned the specified positionswill leave the workflow.
The order will not execute the related instruction.
| Required? | false |
| Position? | 9 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Tag
-Tag <String[]>
| Required? | false |
| Position? | 10 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ForceJobAdmission
-ForceJobAdmission <SwitchParameter>
Specifies that job admission times should not be considered. The order will execute all jobs in the workflow
without waiting for specified admission times.
| Required? | false |
| Position? | 8named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-ControllerId <String>
Optionally specifies the identification of the Controller to which the order is added.
| Required? | false |
| Position? | 911 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-BatchSize <Int32>
As this cmdlet accepts pipelined input a larger number of orders can be added at the same time.
This is particularly true if the Invoke-JS7TestRun cmdlet is used.
Larger numbers of orders are split into individual calls to the REST API according to the batch size.
This is required as larger batches could exceed the size of HTTP post requests that frequently
is limited to 4MB if an HTTP proxy is used.
| Required? | false |
| Position? | 1012 |
| Default value | 100 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-RunningNumber <Int32>
This parameter is implicitly used when pipelining input to the cmdlet as e.g. with
1..10 | Add-JS7Order -WorkflowPath /some_path/some_workflow
| Required? | false |
| Position? | 1113 |
| Default value | 0 |
| Accept pipeline input? | true (ByValue, 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 argument is not mandatory, however, JOC Cockpit can be configured
to enforce Audit Log comments for any interventions.
| Required? | false |
| Position? | 1214 |
| 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 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? | 1315 |
| 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 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? | 1416 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
PS > $orderId = Add-JS7Order -OrderName Test -WorkflowPath /sos/reporting/Reporting -At "2038-01-01 00:00:00" -Timezone "Europe/Berlin"
Adds the indicated order andorder for a later date that is specified for the "Europe/Berlin" time zone.
...
Adds an order to the indicated workflow. The order will start one hour later and will use the variables as specified by the -Variables parameter.
-------------------------- EXAMPLE 6 --------------------------
PS > $orderId = Add-JS7Order -WorkflowPath /ProductDemo/ParallelExecution/pdwFork -StartPosition "job2"
Adds an order to the workflow position labelled "job2" of the indicated workflow.
-------------------------- EXAMPLE 7 --------------------------
PS > $orderId = Add-JS7Order -WorkflowPath /ProductDemo/ParallelExecution/pdwFork -EndPositions "job3","job4"
Adds an order for two possible end positions with the labels "job3" and "job4" of the indicated workflow.
Overview
Content Tools