Page History

...

Add-JS7Order [-WorkflowPath] <String> [[-OrderName] <String>] [[-Variables] <Hashtable>] [[-At] <String>] [[-AtDate] <DateTime>] [[-Timezone] <String>] [[-StartPositionBlockPosition] <String>] <Object[[-StartPosition] ><String>] [[-EndPositions] <Object<String[]>] []>-ForceJobAdmission] [[-ControllerId] <String>] [[-BatchSize] <Int32>] [[-RunningNumber] <Int32>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

...

BlockPosition

-BlockPosition <String>

StartPosition

-StartPosition <Object[]><String>
Specifies the position label of an instruction in the workflow that the order will be started for.

The first top-level instructions in a workflow are allowed start positions.
The position is specified by the numeric index of the instruction in the workflow:
* 0: first instruction
* 1: second instruction
* ...
The Get-JS7OrderAddPosition cmdlet returns available positions for adding ordersIf 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.

EndPositions

-EndPositions <Object<String[][]>
Specifies that the labels of instructions in the workflow at which the order should will leave the workflow before the workflow nodes that
are assigned the specified positions.
* 1: second instruction
* 2: third instruction
* ...
The Get-JS7OrderAddPosition cmdlet returns available positions for adding orders.
The order will not execute the related instruction.

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.

...

-ControllerId <String>
Optionally specifies the identification of the Controller to which the order is added.

...

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

...

-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

...

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

...

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

...

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

...

PS > $orderId = Add-JS7Order -WorkflowPath /ProductDemo/ParallelExecution/pdwFork -StartPosition 1"job2"

Adds an order to the second position (index: 1) workflow position labelled "job2" of the indicated workflow.

-------------------------- EXAMPLE 7 --------------------------

PS > $positions = Get-JS7OrderAddPosition -WorkflowPath /ProductDemo/ParallelExecution/pdwFork
$orderId = Add-JS7Order -WorkflowPath /ProductDemo/ParallelExecution/pdwFork -StartPosition $positions[2].position

Adds an order to the third position (index: 2) of the indicated workflow.

----- --------------------- EXAMPLE 8 --------------------------

PS > $orderId = Add-JS7Order -WorkflowPath /ProductDemo/ParallelExecution/pdwFork -EndPositions 1,2"job3","job4"

Adds an order for two possible end positions with the second (index: 1) and third (index: 2) position of the indicated workflow.

-------------------------- EXAMPLE 9 --------------------------

PS > $positions = Get-JS7OrderAddPosition -WorkflowPath /ProductDemo/ParallelExecution/pdwFork
$orderId = $orderId = Add-JS7Order -WorkflowPath /ProductDemo/ParallelExecution/pdwFork -EndPositions @( $positions[2].position, $positions[3].position )

Adds an order for two possible end positions with the third (index: 2) and fourth (index: 3) position labels "job3" and "job4" of the indicated workflow.