You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Name

Start-JS7Order

SYNOPSIS

Starts orders for a workflow in the JobScheduler Controller.

SYNTAX

Start-JS7Order [-OrderId] <String> [-Workflow] <String> [[-Directory] <String>] [[-Parameters] <Hashtable>] [[-At] <String>] [[-Timezone] <String>] [[-RunTime] <String>] [[-State] <String>] [[-EndState] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

Start existing orders for a workflow.

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies the identifier of an 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.

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

Directory

-Directory <String>
Optionally specifies the folder where the workflow is located. The directory is determined
from the root folder, i.e. the "live" directory.

If the -Workflow parameter specifies the name of workflow then the location specified from the
-Directory parameter is added to the workflow location.

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

Parameters

-Parameters <Hashtable>
Specifies the parameters for the order. Parameters are created from a hashmap,
i.e. a list of names and values.

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

At

-At <String>
Specifies the point in time when the order should start:

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

Default: now

Required?false
Position?5
Default valuenow
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

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 JobScheduler Controller is assumed.

This parameter should be used if the JobScheduler 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>

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

State

-State <String>
Specifies that the order should enter the workflow at the workflow node that
is assigend the specified state.

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

EndState

-EndState <String>
Specifies that the order should leave the workflow at the workflow node that
is assigend the specified state.

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

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

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

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

Required?false
Position?11
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 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?12
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_jobscheduler

EXAMPLES

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

Starts the order "123" of the specified workflow.

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

PS > Start-JobSchedulerOrder -Order 123 -Workflow /sos/reporting/Reporting -At "now+1800"

Starts the specified order for a start time 30 minutes (1800 seconds) from now.

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

PS > Start-JobSchedulerOrder -Order 123 -Workflow /sos/reporting/Reporting -At "2038-01-01 00:00:00" -Timezone "Europe/Berlin"

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

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

PS > Start-JobSchedulerOrder -Workflow /sos/reporting/Reporting -Order 548 -At "now+3600" -Parameters @{'param1' = 'value1'; 'param2' = 'value2'}

Starts an order of the specified workflow. The order will start one hour later and will use the parameters from the specified hashmap.

  • No labels