New-RayFlowOrder

<< Click to Display Table of Contents >>

RayFlow PowerShell API > 7.3 > Implementation Guide > Cmdlet Reference 

New-RayFlowOrder

Description

Creates a new stub for RayFlow order, to ba later published by Publish-RayFlowOrder.

 

Parameters

Name

Type

Mandatory

Description

Project

PsRayFlowProject

Yes

The project in which a new task is to be created.

Category

string

No

The name of the task category (for example Complex). If not provided, the default category will be used.

Schedule

string

No

The name of the task schedule. If not provided, the default schedule will be used.

Type

String

No

The name of the task type (for example Package). If not provided, the default type will be used.

Datafields

PSObject

No

The object containing pairs of name and value, matching the properties to be set. Usually, it is much easier not to provide this object, and instead define task properties later, using indexer syntax (see Remarks section).

 

Remarks

The purpose of this command let is to create a stub of a task, with proper definition of parent project, selected category, schedule and type. In the next step you should set up the data fields by using the indexer syntax. Example code would be:

 

$rayflowOrder = New-RayFlowOrder -Project $rayflowProject -Category REGULAR

$order["Application name"] = "My name"

$order["Application vendor"] = "My vendor"

$order["Application language"] = "ENG"

$order["Application version"] = "2.0"

 

The result of this command let is not yet a published task. You have to use another command let (Publish-RayFlowOrder) to actually send it to the server.

 

Returns

Type

Description

PsRayFlowTaskOrder

The stub containing basic meta data.