Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

-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 from 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
#

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

StartPosition

-StartPosition <Int32>
Specifies that the order should enter the workflow at the workflow node that
# is assigned the specified position.
#
# .PARAMETER EndPosition
#

Required?false
Position?7
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

EndPositions

-EndPositions <Int32[]>
Specifies that the order should leave the workflow at the workflow node nodes that
# is are assigned the specified position.
# positions.

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

ControllerId

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

Required?false
Position?69
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?710
Default value100
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?811
Default value0
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?912
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?1013
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?1114
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...