Orchestrator library

Overview

Overview

You can control process flows using the features provided by the Orchestrator library.
You can specify different tasks according to the conditions.

The features provided by the Orchestrator library are as follows:

The CallProcess, WaitEmail, and WaitHttp activities are functions that request events to the Orchestrator server. They are functions within the library activated when a process is executed using a bot after the project has been distributed to the server.

When running these activity cards on Designer, the Simulation Result value is used instead of the actual server.

Use Designer or File Explorer to refer to the samples of the Orchestrator library.

• On Designer: Menu > Help > Sample > Sample > Orchestra

• On File Explorer: C:\Users\user\AppData\Roaming\Brity RPA Designer\samples\Orchestra


[Orchestrator sample project names and related activity cards]

OrchestratorSamples: WaitEmail, WaitForMultipleEvent, WaitHttp, WakeUp, QueueOpenChannel, QueueCloseChannel, QueueSendData, QueueReceiveData, QueueClearData

Common Properties

Common Properties

MAIL

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Check Mail

Combination box

N

-

Y

Select a method to check email.

- Contains: Emails that include the keyword

- EndsWith: Emails that end with the keyword

- StartWith: Emails that start with the keyword

- Equals: Emails with the matching keyword

- RegExp: Use regular expressions

Receiver

Text

Y

-

Y

Enter the email address of the recipient.

Sender

Text

Y

-

Y

Enter the email address of the sender.

Subject

Text

Y

-

Y

Enter the name of the email to import within single quotation marks.

Begin Time

Text

Y

YYYY-MM-DD HH:MM:SS

Y

Enter the start time to import email.

End Time

Text

Y

YYYY-MM-DD HH:MM:SS

Y

Enter the end time to import email.

SIMULATION RESULT

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Status

Combination box

N

-

Y

Select the value to use as the “status” value of the returned simulation result.

- SUCCESS: Successful

- FAIL: Failed

- SUSPENDED: Job has been forcibly terminated by the user.

Error

Text

N

-

N

Enter the value to use as the “error” value of the returned simulation result.

ExpireTime(Sec)

Number

N

Second

Y

Enter the time for generating the simulated event in seconds.

Result

Script

N

-

Y

Enter the value to use as the “status” value of the returned simulation result within “{}.”

REST

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Method

Combination box

N

-

Y

Select the call type for the HTTP method (RESTful Service).


※ HTTP method call types

- GET: Read

- POST: Create

- PUT: Update/Replace

- DEL: Delete

ContextType

Combination box

N

-

Y

Select the type of content to call REST API.


※ Content types to call

- Text

- text/plain

- application/json

- application/xml

- multipart/form-data

URL

Text

Y

-

N

Enter the address to call REST API.

Authorization

Text

N

-

N

Enter the API key.

Headers

Script

N

-

Y

Enter the header information.

Body

Script

N

-

N

Enter the body information.

MORE OPTIONS

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

Timeout(Min)

Number

N

Minute

N

Enter the waiting time for the specified actions.

DataExpirationTime

Number

N

Minute

N

Displays the time to maintain the data (minutes).

On Error

Combination box

N

-

N

Specify an action to carry out when an error occurs at the time of execution.

- If not specified: Output errors and exit the task.

- --Ignore--: Ignore the error.

- --Retry--: Try the activity one more time.

- --GoTo--: Try the scenario for the specified time if the activity fails,

- --Event--: Select an event created within the project.

DESCRIPTION

Card properties

Properties

Type

Required

Unit

Auto-setting

Description

DESCRIPTION

Text

N

-

N

Enter the description for the activity card.

The description entered in the DESCRIPTION field is used as the description of the activity. A representative value will be displayed in the absence of the DESCRIPTION input.

WaitForMultipleEvents

WaitForMultipleEvents

Overview

This activity card waits for the multiple specified events to be over.

Application procedures

Ensure that events, such as Email or Http connection, have been specified.

  1. In the [Output] Result field, specify the variable to store the results of selected events.

  2. Set the Wait All property to select the waiting type for the events.

  3. Set the Wait For property to select the events to wait for (the variable to store the result of the events).

Card output properties

Property

Type

Additional comments

Description

Example

Result

One-dimensional array(List<class>)

Variable type in class

  • eventId : string

  • status : string

  • result : JToken

  • eventType : string

  • error : object

Returns information about the outcome of a specified event.

[

{ 'eventId' : '...',

'status': 'SUCCESS',

'result' : {

'exam1': 'val1',

'exam2': 'val2'

},

'eventType': 'mail',

'error': 'This is error message' },

...

]

Card input properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

Wait All

Toggle button

N

-

Y

Select whether to wait until all events are generated (On) or wait until at least one event is generated (Off).

For example, if this option is set to “False (Off) when waiting for five processes to be performed, the next process will be proceeded when one of the five processes is complete.

N

Wait For

Other

N

-

Y

Select the event to wait for (the variable to store the result of the event). Click Click here to add new item to add the event to wait for. Click to delete.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Wait for an email and a HTTP request to be received, then output the result in a message box.
This activity card waits until events that simultaneously meet multiple conditions for a process are complete.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

WaitEmail, WaitHttp

WaitEmail

WaitEmail

Overview

This activity card waits after fetching a specific email message. This feature sends a request to the Orchestrator server to set an event to wait for a specific email reception.

Application procedures

  1. In the [Output] Result field, specify the variable to store the event to wait for.

  2. In the Server URL field, enter the URL of the server where the email message is stored within minor quotation marks.

  3. In the Receiver Password field, enter the password for the recipient’s account.

  4. In the Receiver field, enter the ID (email address) of the recipient.

  5. In the Sender field, enter the ID (email address) of the sender.

  6. In the Subject field, enter the email message's subject to be fetched in minor quotation marks.

  7. In the Begin Time field, enter the time to start fetching the email message.

  8. In the End Time field, enter the time to end fetching the email message.

  9. Set the SIMULATION RESULT in properties to select required conditions.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Result

Variable

N

-

Y

Specify the variable to store the event (email reception) to wait for. (Default: RESULT)

You can enter the specified variable in the Wait For field of the WaitForMultipleEvents activity card to wait for the email recipient.

N

Server URL

Text

Y

-

Y

Enter the server URL where the email is located within single quotation marks.

N

Receiver Password

Other

Y

-

N

Enter a password of the account to receive mail.

If you selected Asset, enter the asset variable of the saved password. If you selected Input, manually enter the password of the account.

N

Locale

Combination box

N

-

Y

Select the locale to be used as the base time.

Y

MAIL

-

-

-

-

Common property of the Orchestrator library.

Y

SIMULATION RESULT

-

-

-

-

Common property of the Orchestrator library.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Wait for the reception of the specific email message for the specified time. Then, output the message content in a message box if the email message has been received.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Remarks

Use the WaitForMultipleEvents activity card to wait for the specified events. When running this activity card on Designer, the Simulation Result value is used instead of the actual server.

Related/Similar activities

WaitForMultipleEvents, WaitHttp

WaitHttp

WaitHttp

Overview

This activity card waits after fetching a specific Http request. This feature sends a request to the Orchestrator server to set an event to wait for a particular Http reception.

Application procedures

  1. In the [Output] Result field, specify the variable to store the event to wait for.

  2. Set the SIMULATION RESULT properties to select required conditions.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Result

Variable

N

-

Y

Specify the variable to store the event (Http reception) to wait for. (Default: RESULT)

You can enter the specified variable in the Wait For field of the WaitForMultipleEvents activity card to wait for the Http reception.

Y

SIMULATION RESULT

-

-

-

-

Common property of the Orchestrator library.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Wait for the reception of the specific HTTP request for the specified time. Then, output the reception result in a message box if the HTTP request has been received.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Remarks

Use the WaitForMultipleEvents activity card to wait for the specified events. When running this activity card on Designer, the Simulation Result value is used instead of the actual server.

Related/Similar activities

WaitForMultipleEvents, WaitEmail

WakeUp

WakeUp

Overview

This activity card generates a trigger at a specified time.

Application procedures

  1. In the [Output] Result field, specify the variable to generate a trigger at a specified time.

  2. In the Time field, enter the time for the trigger to be generated.

  3. Set the Locale property to select the locale to use as the base time.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Result

Variable

N

-

Y

Specify the variable to generate trigger at specified time. (Default: RESULT)

You can enter the specified variable in the Wait For field of the WaitForMultipleEvents activity card to wait for the mail reception.

N

Time

Text

Y

-

Y

Enter the time for the trigger to be generated.

N

Locale

Combination box

N

-

Y

Select local time to use as base time.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Generate a trigger at a specified time and output the result in a message box.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Remarks

Use the WaitForMultipleEvents activity card to wait for the specified events.

Related/Similar activities

WaitForMultipleEvents

UploadResource

UploadResource

Overview

This activity card uploads resources (files) to the server.

Application procedures

  1. In the [Output] Output field, specify the variable to store the resource ID registered on the server.

  2. In the ID field, enter the ID of the resource to upload to the server.

  3. In the RetentionPeriod field, enter the period for the server to retain the file.

  4. In the FilePath field, enter the path and name of the file to upload to the server.

Card output properties

Property

Type

Additional comments

Description

Example

Output

String

-

Returns the ID registered with the server.※If ID is set, the same ID is returned. Otherwise, the ID created by the server is returned.

'TestUploadResource'

Card input properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

ID

Text

Y

-

N

The specified ID value is saved. (Overwrite) If not entered, the ID will be automatically generated.

N

RetentionPeriod

Text

Y

-

Y

Enter the period of time to keep files on the server.

N

FilePath

Text

Y

-

N

Enter the path for the file to upload to the server between single quotation marks.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Upload the specified resource file (suji.gif) to the server.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Remarks

The resource ID is returned from the resource (file) uploaded to the server, and you can update or download the resource (file) again with this ID. The resource ID can be automatically created, or the user can enter it. The resource (file) has a retention period and cannot be downloaded from the server after the retention period.

Related/Similar activities

DownloadResource

DownloadResource

DownloadResource

Overview

This activity card downloads resources (files) from the server.

Application procedures

  1. In the [Output] FilePath field, specify the variable to assign the path for the downloaded resource.

  2. In the ID field, enter the ID of the resource to download from the server.

Card output properties

Property

Type

Additional comments

Description

Example

Output

String

-

The path to the downloaded file is returned.

'C: \ IPA_Test_UploadResource \ suji.gif'

Card input properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

ID

Text

Y

-

N

Enter the ID of the resource (file) to download.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Download a resource file whose ID is “TestUploadResource” from the server.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Remarks

The resource ID of the resource to download must be entered to download the resource. The downloaded resource (file) is saved in the “SharedResources” folder under the project folder. If the download is successful, the file path is returned.

Related/Similar activities

UploadResource

QueueOpenChannel

QueueOpenChannel

Overview

This activity card opens a specified queue to use it.

Application procedures

The queue generation must be performed on the Portal. Before you can start using a queue, you must log in to the server.

  1. In the [Output] Output field, specify the variable to store the connection information of the opened queue.

  2. Set the ChannelName property to select the name of the queue to use.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Output

Variable

Y

-

Y

Enter the variable to store the connection information of the opened queue.

N

ChannelName

Combination box

Y

-

Y

Select the name of the queue to use.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Open the specified queue to use it.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

QueueCloseChannel

QueueCloseChannel

QueueCloseChannel

Overview

This activity card closes the specified queue on the server. The close queue cannot be used again before it is reopened.

Application procedures

Before you can start using a queue, you must log in to the server.

In the [Input] Input field, specify the variable for the connection information of the currently opened queue.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Input

Variable

Y

-

Y

Enter the connection information of the queue to close. The information about the opened queue is specified in the [Output] Output field of the QueueOpenChannel activity card.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Close the opened queue to stop using it.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

QueueOpenChannel

QueueSendData

QueueSendData

Overview

This activity card transmits string or file data to the specified queue on the server.

Application procedures

Before you can start using a queue, you must log in to the server.

  1. In the [Output] Output field, enter the variable to store the result of the data transmission.

  2. In the [Input] Input field, enter the connection information of the opened queue.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Output

Variable

Y

-

Y

Enter the variable to store the data transmission result.

“True” is returned if the transmission is successful. “False” is returned otherwise. Contact the server administrator if the data transmission fails.

N

[Input] Input

Variable

Y

-

N

Enter the connection information of the opened queue.

N

DataType

Combination box

N

-

Y

Specify the data type for the transmission.


※ Data types

- Data, File

N

Data

Text

N

-

N

Enter the data to transmit to the queue.

This property is provided when the DataType property has been set as Data. If the DataType property has been set as File, the FilePath property will be provided instead.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Transmits data to the specified queue and output the result in a message box.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

QueueReceiveData

QueueReceiveData

QueueReceiveData

Overview

This activity card receives data from the specified queue on the server.

Application procedures

Before you can start using a queue, you must log in to the server.

  1. In the [Output] Output field, enter the variable to store the result of the data reception.

  2. In the [Output] IsFile field, Enter the variable to store the verification result of whether the received data is a file.

  3. In the [Input] Input field, enter the connection information of the opened queue.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Output

Variable

Y

-

Y

Enter the variable to store the data reception results.

“True” is returned if the transmission is successful. “False” is returned otherwise. Contact the server administrator if the data transmission fails.

N

[Output] IsFile

Variable

Y

-

N

Enter the variable to store the verification result for whether the received data is a file.

“True” is returned if the received data is a file. “False” is returned otherwise.

N

[Input] Input

Variable

Y

-

N

Enter the connection information of the opened queue.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Receive data from the specified queue and output the result in a message box.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Remarks

Once the data is received properly, the corresponding data will be deleted from the queue.

Related/Similar activities

QueueSendData

QueueGetDataCount

QueueGetDataCount

Overview

This activity card fetches the number of data items in the specified queue on the server.

Application procedures

Before you can start using a queue, you must log in to the server.
  1. In the [Output] Output field, specify the variable to store the number of data items.

  2. In the [Input] Input field, enter the information of the opened queue.

Card output properties

Property

Type

Additional comments

Description

Example

Output

Int

-

Returns the number of data in the queue.

10

Card input properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Input

Variable

Y

-

N

Enter the queue connection information returned when the queue was opened.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Receive data from the queue and verify the reception.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

QueueSendData, QueueReceiveData, QueueClearData

QueueClearData

QueueClearData

Overview

This activity card deletes text strings or data from the specified queue on the server.

Application procedures

Before you can start using a queue, you must log in to the server.

  1. In the [Output] Output field, specify the variable to store the remaining number of data in the queue after deleting data.

  2. In the [Input] Input field, enter the connection information of the currently opened queue.

  3. In the DataCount field, enter the number of data to delete.

Card output properties

Property

Type

Additional comments

Description

Example

Output

Int

-

Returns the number of data remaining in the queue after deleting data.※ If deletion fails, an error or -1 is returned.

10

Card input properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Input

Variable

Y

-

N

Enter the connection information of the opened queue.

N

DataCount

Text

Y

-

Y

Specify the amount of data to delete.

- Positive number: Number of data items to delete

- Negative number: Number of all data in the queue

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Example of utilization

Delete data from the specified queue and output the number of remaining data items in a message box.

Excel_NewExcel_1K

Sample file

Used variables

Used properties

Related/Similar activities

QueueSendData, QueueReceiveData

HttpRequest

HttpRequest

Overview

This activity card calls a REST API on the Orchestrator server.

Application procedures

  1. In the [Output] Response field, enter the variable to store the message response.

  2. In the URL field, enter the address to call.

  3. In the REST properties fields, enter the call type, call content type, API key, and the header and body information.

Card properties

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Response

Variable

Y

-

Y

Enter the variable to store the data reception result.

“True” is returned if the transmission is successful. “False” is returned otherwise. Contact the server administrator if the data transmission fails.

Y

REST

-

-

-

-

Common property of the Orchestrator library.

Y

MORE OPTIONS

-

-

-

-

Common property of the Orchestrator library.

Y

DESCRIPTION

-

-

-

-

Common property of the Orchestrator library.

Related/Similar activities

WaitHttp