PowerShell CLI 2.0 - Cmdlets - Add-JS7Order

Name

Add-JS7Order

SYNOPSIS

Adds an order to a workflow in the JS7 Controller

SYNTAX

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

DESCRIPTION

Creates a temporary order for execution with the specified workflow.

PARAMETERS

WorkflowPath

-WorkflowPath <String>
Specifies the path and name of a workflow for which an order should be added.

OrderName

-OrderName <String>
Specifies the name of an order. The JOC Cockpit web service will consider the order name
when creating unique order iDs from the pattern #<YYYY-MM-DD>#<qualifier><timestamp>-<order-name>
such as with #2020-11-22#T072521128-Some_Order_Name.

* YYYY-MM-DD: Date for which the order is scheduled
* qualifier: one of T(emporary), P(lan), F(ile)
* timespan: time specified in milliseconds
* order-name: the value of the -OrderName parameter

Variables

-Variables <Hashtable>
Specifies the variables for the order. Variables are created from a hashmap,
i.e. a list of names and values. Values have to be specified according to the
variables declaration of the workflow and include use of the data types:

* string: $orderVariables = @{ 'arg1' = 'value1' }
* number: $orderVariables = @{ 'arg2' = 3.14 }
* boolean: $orderVariables = @{ 'arg3' = $true }

Example:
$orderVariables = @{ 'var1' = 'value1'; 'var2' = 3.14; 'var3' = $true }

Consider that a workflow can declare required variables that have to be added to an order.

At

-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.
* never
** specifies that the order is added without a desired start time. Users have to manually modify the start time
of such orders to make them start.

AtDate

-AtDate <DateTime>
Specifies the date when the order should start. The time zone is used from the date provided.

Timezone

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

BatchSize

-BatchSize <Int32>
[Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
[string] $StartPosition,
[Parameter(Mandatory=$False,ValueFromPipeline=$False,ValueFromPipelinebyPropertyName=$True)]
[string] $EndPosition,

RunningNumber

-RunningNumber <Int32>
This parameter is implicitely used when pipelining input to the cmdlet as e.g. with

1..10 | Add-JS7Order -WorkflowPath /some_path/some_workflow

AuditComment

-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 argument is not mandatory, however, JOC Cockpit can be configured
to enforce Audit Log comments for any interventions.

AuditTimeSpent

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

AuditTicketLink

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

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Add-JS7Order -WorkflowPath /sos/reporting/Reporting -OrderName Test

Adds an order to the indicated workflow.

-------------------------- EXAMPLE 2 --------------------------

PS > $orderIds = 1..10 | Add-JS7Order -WorkflowPath /sos/reporting/Reporting -OrderName Test

Adds 10 orders to the indicated workflow.

-------------------------- EXAMPLE 3 --------------------------

PS > $orderId = Add-JS7Order -OrderName Test -WorkflowPath /sos/reporting/Reporting -At "now+1800"

Adds the indicated order for a start time 30 minutes (1800 seconds) from now.

-------------------------- EXAMPLE 4 --------------------------

PS > $orderId = Add-JS7Order -OrderName Test -WorkflowPath /sos/reporting/Reporting -At "2038-01-01 00:00:00" -Timezone "Europe/Berlin"

Adds the indicated order for a later date that is specified for the "Europe/Berlin" time zone.

-------------------------- EXAMPLE 5 --------------------------

PS > $orderId = Add-JS7Order -WorkflowPath /sos/reporting/Reporting -At "now+3600" -Variables @{'var1' = 'value1'; 'var2' = 3.14; 'var3' = $true}

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.