Overview

Control process flows using the features provided by the FlowControl library. You can perform repetitive tasks, set another task depending on the condition, delay, or end process flows using specific conditions.

The features provided by the FlowControl library are as follows:

Decision-making: IfElse, IfThen, SwitchCase
Repetition: Loop, For, Foreach, While, DoWhile
Assigning variables: Assign
Writing user scripts: ExecuteScript, ExecuteLibrary
Process control: Delay, TerminateFlow, TerminateAll, Break, Continue
Debugging and logging: Debugger, Log, DumpScreen
Testing: AssertExpression, AssertEquals, AssertNull, AssertEmpty, AssertContains1D, AssertContains2D, AssertNumberRange, AssertDataType
Other: RetryTask, Reboot, TryCatch, DataConverter, Block

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

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

• On Windows Explorer: Access C:\Users\user\AppData\Roaming\Brity RPA Designer\samples\FlowControl

[FlowControl sample projects and related libraries]

• FlowControl: IfElse, IfThen, Loop, For, Foreach, While, DoWhile, Block, SwitchCase, Delay, Assign, Break, Continue, TerminateFlow, TerminateAll

• Customized Script: ExecuteScript, ExecuteLibrary

• Debug: RetryTask, Reboot, Log, Debugger, DumpScreen

• Assert: AssertExpression, AssertEquals, AssertNull, AssertEmpty, AssertContains1D, AssertContains2D, AssertNumberDataTypeRange, Assert

Common Properties

DataConverter

Configure settings related to the data type conversion.

Card properties
Properties	Type	Required	Unit	Auto-setting	Description
Type	Combination box	N	-	Y	Select the conversion type of the input data. ※ Data types - String, Number, Date, Json, Xml, Point, Rect
Method	Combination box	Y	-	Y	Select the type of method that can be used. For more information, see “Available method by data type” below.
Args	Text	N	-	N	Enter additional arguments required for the method.

Available method by data type

Method by data type
Type	method	Description	Use case
String	ToString	Convert the data input in the [Input] Input field into a text string.
	Format	Enter the input value in the Args field to the format string in the [Input] Input field and return it.	Input: 'This is {0}' Args: 'Sample' Output > 'This is Sample'
	Trim	Convert the text string in the [Input] Input field to “String” type and delete the spaces before and after the string.
	ReplaceAll	Find a specific text string in the text string in the [Input] Input field and replace them with a different text string.	Args: 'aa', 'bb' (replace all “aa” to “bb”)
	Split	Divide the text string in the [Input] Input field with a specific text string in the Args field and store the result as an array.	Args: ':' (Divide the string with “:”)
	SplitTable	Divide the text string in the [Input] Input field with a specific text string or text array in the Args field and store the result as a two-dimensional array.
	ExtractByRegex	Extract the text string that matches the regular expression in the Args field from the text string in the [Input] Input field and return it.
	IsMatch	Verify whether the text string in the [Input] Input field matches the regular expression in the Args field and return the result as “True” or “False.”
Number	ToNumber	Convert the data input in the [Input] Input field into the “Number” type.
	Max	Compare the data in the [Input] Input field with the number in the Args field and return the larger value.
	Min	Compare the data in the [Input] Input field with the number in the Args field and return the smaller value.
	Round	Round off the value in the [Input] Input to a specific place. When a number is an input in the Args field, the value will be rounded at the corresponding place.
	Ceil	Round down the value in the [Input] Input and return the nearest integer.
	Floor	Round up a number is input in the [Input] Input field and return the nearest integer.
	Abs	Return the absolute number of the value in the [Input] Input field.
Date	ToDateTime	Convert the date format string in the [Input] Input field into a DateTime string. When a date format is entered in the Args field, a string in the given format will be returned.
	ToUTCDateTime	Convert the date format string in the [Input] Input field into UTC Date Time. When a date format is entered in the Args field, a string in the given format will be returned.
	FromExcelDate	Convert the Date string fetched from an Excel document and entered in the [Input] Input field to UTC Date Time. When a date format is entered in the Args field, a string in the given format will be returned.
	AddYears, AddMonths, AddDays, AddHours, AddMinutes, AddSeconds	Add or subtract the number for the time (hour, minute, second) or date (year, month, day) in the Args field from the DateTime value in the [Input] Input field.
	DateFormat	Return a text string according to the date format in the [Input] Input field.
Json	ToString	Convert the Json object in the [Input] Input field to a text string and return it.
	ToJsonObject	Convert the Json text string in the [Input] Input field to a Json object and return it.
	GetValueByKey	Find the value that match the key value entered in the Args field in the Json text string entered in the [Input] Input field, and then return it.
Xml	ToString	Convert the Xml object in the [Input] Input field to a text string and return it.
Xml	GetValueByXpath	Find the value that match the xpath entered in the Args field in the Xml-type text string entered in the [Input] Input field, and then return it.
Point	ToPoint	Convert the Point-type text string in the [Input] Input field to Point object and return it.
Point	Offset	Add the offset value in the Args field to the Point object in the [Input] Input field and return it.
Rect	ToRect	Convert the Rect-type text string in the [Input] Input field to a Rect object and return it.
	Center	Convert the center coordinates of a Rect object in the [Input] Input field to Point object and return it.
	Offset	Add the offset value in the Args field to the Rect object in the [Input] Input field and return it.

RESTART POSITION

Configure settings related to the restarting of processes.

Card properties
Properties	Type	Required	Unit	Auto-setting	Description
Position Type	Combination box	N	-	Y	Select the method for specifying a restart position. (ErrorStep: Relative position, StepNo: Absolute position)
Position	Script	Y	-	Y	Enter the restart position.

Assert

Configure settings related to data consistency.

Card properties
Properties	Type	Required	Unit	Auto-setting	Description
Variable	Variable	Y	-	Y	Specifies the variable to be examined.
Assert Message	String	N	-	N	Specifies the error message that is outputted when the condition is not met.

MORE OPTIONS

Card properties
Properties	Type	Required	Unit	Auto-setting	Description
Interation Variable	Variable	N	-	N	Enter the variable to store the index value which starts from the Start Index and increases by one after loop.
Start Index	Number	N	-	Y	Enter the Start Index. (Default: 0) If not specified, it will be automatically set to “0.”
Show Message Box	Toggle button	N	-	N	Set to display a message box.
Screenshot	Toggle button	N	-	N	Set to capture the screen.
On Error	Combination box	N	-	N	Set the processing method for an error. - 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 description for the activity. The entered DESCRIPTION will be displayed in the description field of the activity. A representative value will be displayed in the absence of the DESCRIPTION.

IfElse

Overview

By utilizing a True/False branching, this activity card creates a junction to operate the following activity in different ways according to the condition (Identical to "if/else" in JavaScript).
It can be used in flow charts for processes, tasks, or events.

Application procedures

Enter the condition in the Condition field.
If additional conditions are required, click + Add Conditions to add conditions.
In the flow chart, specify the commands for TRUE and FALSE conditions.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Condition	Conditional expression	Y	-	Y	Enter conditional statement. (Default: RESULT==true) To enter multiple conditions, you can select the + Add Conditions property and add conditions or use the "&&"(and), and "\|\|"(or) operators in the expression.
N	Add Conditions	Other	N	-	-	Add conditions.
N	Combine Condition	Button	N	-	N	Select the type of the operator for the additional condition from And or Or.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Open the Google or Amazon website according to the input value of the variable.

If the input value of the "inputValue" variable is “1,” the OpenBrowser activity opens the “www.google.com” page. Otherwise, it opens the “www.amazon.com” page.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_If_Test

Used variables

inputValue = The input value

Used properties

Condition = this.inputValue == 1 || this.inputValue == 2

Related/Similar activities

IfThen, SwitchCase

IfThen

Overview

This activity card creates a branching statement that operates only when specific conditions are met  (Identical to "if” in JavaScript).

Application procedures

Enter the condition in the Condition field.
If additional conditions are required, click + Add Conditions to add conditions.
In the flow chart, specify the commands for a True condition.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Condition	Conditional expression	Y	-	Y	Enter conditional statement. (Default: RESULT==true) To enter multiple conditions, you can select the + Add Conditions property and add conditions or use the "&&"(and), and "\|\|"(or) operators in the expression.
N	Add Conditions	Other	N	-	-	Add conditions.
N	Combine Condition	Button	N	-	N	Select the type of the operator for the additional condition from And or Or.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Open the Google website if the value of the input variable matches the condition.

If the input value of the "inputValue" variable is “1,” the OpenBrowser activity opens the “www.google.com” page.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_IfThen_Test

Used variables

inputValue = The input value

Used properties

Condition = this.inputValue == 1

Related/Similar activities

If, SwitchCase

Loop

Overview

This activity card repeats the same operation a specified number of times.
If the Loop Type is set as "Count," the operation is repeated for the set number of times.
If the Loop Type is set as "List," it fetches the items in a list one by one according to the list order of the items.

Application procedures

Select Count or List for the Loop Type property.
Set the properties for the selected Loop type.
- When "Count" is selected: Set the number of repetitions in the Iteration Count field.
- When "List" is selected: Set the List Variable (list type variable), Item Variable (variable to store the item fetched from the list type variable), Start Index (start index number), and Iteration Count (number of repetitions) properties.
Add the process to repeat within the loop.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Loop Type	Button	Y	-	Y	Select the Loop Type. (Default: Count) - Count: Starts operation from the Start Index, for the specified time. - List: Fetch the items one by one, from the list type variable.
N	[Count] Iteration Count	Number	Y	Positive numbers	Y	Enter the number of repetitions. (Default: 1) This value is required when the Loop Type is set as Count. When the Loop type is List, the operation will be repeated for the number of items in the selected list.
N	[List] List Variable	Variable	Y	-	N	Select a list type variable.
N	[List] Item Variable	Variable	Y	-	N	Specify the variable to store the items fetched from the list type variable.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Repeat the loop for the time set at the Count property or for the number of items in the List-type variable.

Run Notepad and enter the items for the number of times equal to the number of items in the list. Then, output the last list item in a message box and close Notepad.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_Loop_Test

Used variables

openApp1 = Variable to specify the launched Notepad
index = Variable to store the number of repetitions (Count type)
list = An array variable that stores the input content (List type)
item = the list item value that matches the relevant operation (List type)

Used properties

Loop Type = Count
Iteration Count = 5 (Count type)
Iteration Variable = this.index (Count type)

Loop Type = List
List Variable = this.list (List type)
Item Variable = this.item (List type)

Related/Similar activities

For, Foreach, While, DoWhile

For

Overview

This activity card repeats the operation according to the user-defined conditions (Identical to "for loop" in JavaScript).

Application procedures

In the Initialize field, enter the initial value of the Index where the repeating statement will begin.
In the Condition field, enter the condition for the Index to end the repeating statement.
In the Update field, enter the increment for the Index.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Initialize	Script	Y	-	Y	Enter the initial value of the Index. (Default: this.i = 0)
N	Condition	Script	Y	-	Y	Enter the condition of the Index. (Default: this.i < 1)
N	Update	Script	Y	-	Y	Enter the updated content of the Index. (Default: this.i++)
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Until the “this.i” variable changes from “0” to “less than 5,” increase the value by “1” and run the repeating statement five times.

Run Notepad, utilize the For statement to input 0 to 4. If the last number is 4, close Notepad. Otherwise, output "Run error" in a message box.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_For_Test

Used variables

openApp1 = The variable to specify the launched Notepad

Used properties

Initialize = this.i = 0
Condition = this.i < 5
Update = this.i ++

Related/Similar activities

Loop, Foreach, While, DoWhile

Foreach

Overview

This activity card generates a repeating statement that fetches data from a list item (array) one by one in the list order of the items (Identical to "foreach" in JavaScript).

To utilize this activity card, knowledge of JavaScript statements, such as "for-of," "for-in," and "foreach," is required.

Application procedures

In the For List field, enter a list-type variable.
In the Each Item field, enter the variable to assign the items after fetching them one by one from the list type variable.
Select For-of or For-in.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	For List	Variable	Y	-	N	Enter a variable of the list type with data.
N	Each Item	Variable	Y	-	N	Enter the variable to assign the items after fetching them one by one from the list-type variable.
N	For-of / For-in	Button	Y	-	Y	Use for the same purpose as JavaScript syntax. (Default: For-of)
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Repeat the statement for the number of times that match the number of the "forList" variable values.

Repeat operation for the number of times that match the number of List Items (array). Each operation runs Notepad and outputs the content of the corresponding array to the operation in a message box. All open Notepad instances will be closed when the repeating ends.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_Foreach_Test

Used variables

openApp1 = Variable to specify the launched Notepad
eachItem = The forList value corresponding to the order
forList = The entire data

Used properties

For List = this.forList
Each Item = this.eachItem
For-of / For-in = For-Of

Related/Similar activities

For, Loop, While, DoWhile

While

Overview

This activity card creates a repeating statement to perform an operation up to specific conditions (Identical to "while" in JavaScript).

Application procedures

In the While Condition field, enter the condition.
If additional conditions are required, click + Add Conditions to specify conditions.
Add the process to repeat between the while diagrams.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	While Condition	Conditional expression	Y	-	N	Enter conditional statement. To enter multiple conditions, you can select the + Add Conditions property and add conditions or use "&&"(and), and "\|\|"(or) operators in the expression.
N	Add Conditions	Other	N	-	-	Add conditions.
N	Combine Condition	Button	N	-	N	Select the type of the operator for the additional condition from And or Or.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Add “1” to the specified "leftValue" variable value and repeat the operation until the value becomes less than "5," and then show the resulting value in a message box.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_While_Test

Used variables

leftValue = Increased value
startValue = Initial value (0)

Used properties

While Condition = this.leftValue < 5
Combine condition = And
Condition = this.leftValue < 5

Related/Similar activities

For, Foreach, Loop, DoWhile

DoWhile

Overview

This activity card creates a repeating statement to perform an operation up to specific conditions (Identical to “do-while” in JavaScript).

Application procedures

Enter the condition in the Condition field.
If additional conditions are required, click +Add Conditions to specify conditions.
Add the process to repeat between the "DoWhile" diagrams.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Condition	Conditional expression	Y	-	N	Enter conditional statement. To enter multiple conditions, you can select the +Add Conditions property and add conditions or use "&&"(and), and "\|\|"(or) operators in the expression.
N	Add Conditions	Other	N	-	-	Add conditions.
N	Combine Condition	Button	N	-	N	Select the type of the operator for the additional condition from And or Or.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Add "1" to the entered variable value and repeat the operation until the value becomes less than "3," and show "This is message No. + the resulting value" in a message box.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_DoWhile_Test

Used variables

count = The increased value

Used properties

Condition = this.count <= 3

Related/Similar activities

For, Foreach, Loop, While

Block

Overview

This activity card binds specific sections as blocks on Designer and allows you to collapse or expand them.

Application procedures

Select the activity cards to bind as a block and move them into the block.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Title	Text	N	-	N	Specify the title of the block.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Collapse or expand the blocked activity cards by double-clicking the block.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_Block_Test

Used variables

None

Used properties

None

SwitchCase

Overview

This activity card performs a multiple branching based on specific conditions.

Application procedures

After clicking the SwitchGroup (“Switch” part of the card), in the Condition field, enter the condition for a branching.
In the Case field that appears when you click “Case” on the activity card, specify the values to compare with the branching conditions in the Condition field.
Double click “Case” on the activity card and enter the operation command. (You can double-click “+” that appears when you hover the pointer over “Case” to add a new case phrase.)

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Condition	Text	Y	-	N	Enter the condition for branching.
N	Case	Text	Y	-	N	Enter the conditional value to compare with the branching condition.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the operation commands for each specific condition. Check the input value in the InputBox. If the value is “1,” display “Banana,” if the value is “2,” display “Apple,” if the value is “3,” display “Orange,” and for any other values, display “You didn't choose a value between 1 and 3.”

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_SwitchCase_Test

Used variables

Case = Case number

Used properties

Condition = this.Case
First case = '1'
Second case = '2'
Third case = '3'

Delay

Overview

This activity card delays an operation for the time defined by the user.

Application procedures

Enter the delay time in the Second and Millisecond fields.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Second	Number	Y	sec	Y	Enter time in seconds. (Default: 1)
N	Millisecond	Number	Y	ms	Y	Enter time in milliseconds. (Default: 0)
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Open a browser and wait for 3 seconds before entering "RPA" in the search window and perform a search.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_Delay_Test

Used variables

None

Used properties

Second = 3

Assign

Overview

This activity card assigns a value to a specified variable.

Application procedures

In the [Output] Variable field, enter the variable to assign a value.
In the Value field, enter the value to be assigned to the variable.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Variable	Variable	M	-	Y	Specify the variable to assign the value. (Default: RESULT)
N	Value	Text	Y	-	-	Enter the value to be assigned to the variable. - Normal: The password input is saved as a plain text. - Secure: The input value is encrypted before it is saved. Select this option for values requiring encryption, such as passwords.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

In Notepad, enter the value assigned to the “leftValue” variable ('Assign Test').

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_Assign_Test

Used variables

openApp1 = Variable to specify the launched Notepad
leftValue = Variable to which the value will be assigned

Used properties

[Output] Variable = this.leftValue

DataConverter

Overview

This activity card returns the data in the desired format by converting or extracting the specific data type.

Application procedures

in the [Output] Output field, enter the variable to assign a value.
In the [Input] Input field, enter the value to convert.
Refer to the DataConverter common properties table to configure the conversion properties.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Output	Variable	Y	-	Y	Specify the variable to store the value returned from the DataConverter. (Default: RESULT)
N	[Input] Input	Variable	Y	-	N	Enter the data to be entered to DataConverter.
Y	DataConverter	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Remarks

For more information about the setting details and available methods by type, see Common properties.

Related/Similar activities

To find more activity cards that handle each specific conversion task, see DataConveter library.

ExecuteScript

Overview

This activity card allows users to compose JavaScript script.

Application procedures

In the SCIRPT field, enter the user-defined script. Double-click the text box to use ScriptEditor.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	SCRIPT	Script	Y	-	N	Enter the user defined script. Double-click the text box to use ScriptEditor.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Compose a script that displays today’s date.

Run Notepad and utilize the "currentdate" script to enter the month and date for today.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample >Flow Control > Customized Script > P_ExecuteScript_Test

Used variables

var1 = Variable for today
mMonth = Variable for the current month
mDate = Variable for the current date
openapp = Variable to specify the Notepad app

Used properties

User-defined script in the SCIRPT field

this.var1 = new Date(); 
this.mMonth = this.var1.getMonth() + 1; 
this.mMonth = this.mMonth; 
this.mDate = this.var1.getDate();

Related/Similar activities

ExecuteLibrary

Overview

This activity card executes script functions users have written in JavaScript.

Application procedures

Prepare a script written in JavaScript syntax.

In the [Output] Result field, specify the variable to store the execution result.
Set the Library and Function properties to select the library function type and method.
In the Arguments field, enter the property value to execute the script function.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Result	Variable	N	-	Y	Specify the variable to store the execution result of the script function. (Default: RESULT)
N	Library	Combination box	Y	-	N	Select the type of library function. ※ Library function types - Bot, Datetime, Hotkey, Math, String
N	Function	Combination box	Y	-	N	Select the method of the selected library function.
N	Arguments	Text	N	-	N	Enter the property values to execute the script function.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Execute a script function that calculates the maximum value and output the result in a message box.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Customized Script > P_ExecuteLibrary_Test

Used variables

outValue = Variable to store the result of the script function execution
num1 = Number
num2 = Number

Used properties

[Output] Result = this.outValue
Library = Math
Function = Max
Arguments = this.num1, this.num2

Remarks

Write the script in one of the following formats:

Script.filen ame = new function(){

this.function name = function(parameter list){}

}

Default script functions are provided upon program installation. See the JavaScript files (.js) in the Libraries folder in the program installation path.

Create the “Libraries” folder within the project folder in the Documents folder and save the completed script function file.

Related/Similar activities

ExecuteScript

Break

Overview

This activity card terminates a loop at the point specified by the user in a loop syntax such as a “for” statement (Identical to "break" in JavaScript).

Application procedures

This activity may be applicable to a loop syntax, such as a "For" syntax.

Place the Break activity card at the point where the loop will be terminated.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Terminate a loop at a specified point.

While a loop is executed 10 times with a "For" syntax, if "1" is input to the InputBox, terminate the loop. If any other value is input, close Notepad and terminates the process.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_Break_Test

Used variables

inputValue = Value to be input
openApp1 = Variable to specify the launched Notepad

Used properties

None

Related/Similar activities

Continue

Overview

This activity card executes the next step of a loop at the point specified by the user in a loop syntax (Identical to "break" in JavaScript).

Application procedures

This activity may be applicable to a loop syntax, such as a "For" syntax.

Place the Continue activity card at the point where the loop will proceed to the next step.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

In a loop, proceed to the next step at the specified point.

While a loop is executed 10 times with a "For" syntax, if "1" is input to the InputBox, proceed to the next step. If any other value is input, close Notepad and terminates the process.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_Continue_Test

Used variables

inputValue = Value to be input
openApp1 = Variable to specify the launched Notepad

Used properties

None

Related/Similar activities

Break

TerminateFlow

Overview

This activity card terminates an ongoing task or flow (Identical to "return" in JavaScript).

Application procedures

Place the TerminateFlow activity card at the point where the flow will be terminated.
In the Result field, enter the return value when the operation is terminated.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Result	Text	N	-	N	Enter return value when the task or flow is terminated.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Terminate an ongoing flow at a specified point.

While a loop is executed 10 times with a "For" syntax if "1" is input to the InputBox, open and close Notepad, if any other value is input, terminate the ongoing task.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_TerminateFlow_Test

Used variables

inputValue = Value to be input
openApp1 = Variable to specify the launched Notepad

Used properties

None

Related/Similar activities

TerminateAll

Overview

This activity card terminates an ongoing process (Identical to “Exit” in JavaScript).

Application procedures

Set the Job Result property to select one of the results (Pass, Fail, Stop) that will be displayed on the Orchestrator server when the process is terminated.
In the Exit Message field, enter the message displayed when the process is terminated.
In the Exit Code field, enter the return value at the time of process termination.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Job Result	Button	Y	-	Y	Select one of the results from Pass, Fail, or Stop that will be displayed on the Orchestrator server. (Default: Fail)
N	Exit Message	Text	N	-	N	Enter the message to display when the flow is terminated.
N	Exit Code	Script	N	-	N	Enter the return value when the process is terminated.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Terminate an ongoing process at a specified point.

While a loop is executed 10 times with a "For" syntax if "1" is input to the InputBox, open and close Notepad, if any other value is input, terminate the ongoing process.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > FlowControl > FlowControl > P_TerminateAll_Test

Used variables

inputValue = Value to be input
openApp1 = Variable to specify the launched Notepad

Used properties

Job Result = Fail

Related/Similar activities

TerminateFlow

TryCatch

Overview

This activity card handles exceptions during script execution (Similar to the onError event property of other activity cards and identical to the “TryCatch” in JavaScript).

Application procedures

Place the activity cards to handle exceptions between the TryCatch activities.
In the [Output] ErrorMessage field, enter the message to display when an error occurs.
Set the onError property to specify the action for an exception.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] ErrorMessage	Variable	N	-	N	Select a variable for the error message output.
N	onError	Combination box	N	-	Y	Set the processing method for an exception. (Default: '--Ignore--') --Ignore--: Ignore the error. --Event--: Select an event created within the project.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Related/Similar activities

RetryTask

Overview

When there is an error, this activity card restarts the ongoing task with the OnError event.

RetryTask returns the variable value information of the Output type of the target task after restarting the target task from the specified position.
If RetryTask does not set the Result property, after the target task is completed, the task's return value is returned as the task that is called the event. The activity defined after RetryTask is not executed.
Suppose a variable to store the result of the task is set in the Result property. In that case, the activity is defined after RetryTask is executed. Still, if the output type variable of the target task exists, the scenario must be configured to return the task result before the event ends explicitly. Do.
Returning the task result can be returned by entering the Result variable of RetryTask into the Result property of TerminateFlow.

Application procedures

Place the RetryTask activity card after the activity card to handle the on-error exception.
Enter the message to display when an error occurs.
Set the Position Type item of the RESTART POSITION property to select the type to specify the restart point (ErrorStep: Relative position, StepNo: Absolute position).
In the Position field of the RESTART POSITION property, enter the restart position.(Default: 0)

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Result	Variable	N	-	N	Enter the variable to store the execution result.
Y	RESTART POSITION	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Related/Similar activities

TryCatch

Reboot

Overview

This activity card reboots a computer. Processes that are in progress will be terminated before the reboot.

Application procedures

Place the Reboot activity card where a reboot of the PC is required.
Set the Job Result property to select one of the results (Pass, Fail, or Stop) that will be displayed on the Orchestrator server when the process is terminated.
In the Exit Code field, enter the return value at the time of process termination.
In the Exit Message field, enter the message that will be displayed when the process is terminated.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Job Result	Button	Y	-	Y	Select one of the results from Pass, Fail, or Stop, which will be displayed on the Orchestrator server when the process is terminated. (Default: Fail)
N	Exit Code	Script	N	-	N	Enter the return value when the process is terminated.
N	Exit Message	Text	N	-	N	Enter the message to display when the flow is terminated.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Reboot a PC at a specified point. If "1" is input in the InputBox, all processes will be terminated, and the computer will reboot.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Debug > P_Reboot_Test

Used variables

None

Used properties

None

Log

Overview

This activity card outputs a user log to a specified file. Or it can be output in the form of a screenshot or message box.

Application procedures

In the Message field, enter a message to display.
In the File Path field, enter the path to save the log file.
Set the Append property to specify whether to append the content to an existing log or create a new log.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Message	Text	N	-	N	Enter the message to output as a file or display in a message box.
N	File Path	Text	Y	-	N	Specify a download path and file to save log file.
N	Append	Toggle button	N	-	Y	When enabled, the content will be appended to an existing log. When disabled, only the current content will be saved as a new log file. (Default: Append to an existing log)
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Output the log to a specified file.

Enter user-defined script, run Notepad and enter text, and then save the log file. Close Notepad and output a message in a message box.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Debug > P_Log_Test

Used variables

None

Used properties

Message = 'Log Test'
File Path = 'C:\\Log_Test.txt'
Append = False
ScreenShot = True

SetPlayOption

Overview

This activity cards sets global options that are always applied to all steps.

Application procedures

Select an option to set in Option Name .
When the properties for the selected option are displayed, select or enter the settings for that option.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Option Name	Text	N	-	N	Select the properties for options to be set.
N	Step Interval	Number	Y	ms	Y	Enter the delay in milliseconds to set between each step when the process is running.
N	Disable DrawBounds	Toggle button	Y	-	Y	Set not to display the box indicating the searched area when searching for an object or image.
N	Invoke First	Toggle button	Y	-	Y	When clicking an object, the Invoke API of the Automation service is used in preference to the Mouse Event API. This is because invoke allows you to simulate a click without moving the mouse.
N	Allow upload of DumpScreen results	Toggle button	Y	-	Y	When the option is enabled, when a job is executed using a bot, the image created with the DumpScreen activity is uploaded to the server after execution. Uploaded images can be checked using the result screen function on the Job Report screen of the portal. [Caution] Frequent use of this function can quickly consume the file storage capacity of the bot and server, so caution is required.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

You can turn off Draw Bounds for all steps with SetPlayOption, even if you don't disable the Draw Bounds property in the individual step's properties. In addition, since options are applied to all steps after they are set, if you want to apply them only to some sections, you can deactivate and reactivate the options by adding SetPlayOption to the start and end points of the sections you need.

Setplayoption

Sample file

Menu > Help > Samples > Sample > Flow Control > Debug > P_SetPlayOption_Test

Used variables

Used properties

Step Interval (ms) = 1000
Disable DrawBoudns = true
Invoke First = true

Debugger

Overview

This activity card runs the debugging console.
In the debug console, you can input the current variable status and check the current progress.

Application procedures

In the Message field, enter the message to display on the debug console.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Message	Text	N	-	Y	Enter the message to display on the debug console window. (Default: RESULT)
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the user-defined script and enter the message to display in the debug console window.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Debug > P_Debugger_Test

Used variables

None

Used properties

Message = 'Run the debugger.'

DumpScreen

Overview

This activity card saves the error dump screenshot image of the relevant moment in the Histories\Logs folder under the project folder.

Application procedures

Select whether to save the dump file in the Histories\Logs folder (Pass) or transmit it to the server (Fail) with the Pass or Fail property.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Pass or Fail	Button	Y	-	Y	Select whether to locally save the dump file or to send it to the server. (Default: Fail) - Pass: Save the file in the Histories\Logs folder under the project folder. - Fail: Sends the file to the server.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Create a dump file and save it in a specified location.

After entering user-defined script, run Notepad and enter text.
Save the dump file in the relevant project folder, close Notepad, and output a message in the message box.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Debug > P_DumpScreen_Test

Used variables

None

Used properties

Pass of Fail = Pass

AssertExpression

Overview

If the script to check is true, PASS, false, the exception will occur.

Application procedures

Enter the script that AssertExpression can be True or False.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Expression	String	Y	-	N	Please enter the script to be validated.
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the script you want to check and enter the message you want to print when it does not meet your criteria.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertExpression

Used variables

var1, var2

Used properties

Expression : this.var1 == this.var2
Assert Message : 'Assertion is failed : this.var1 == this.var2'

AssertEquals

Overview

If the variable to check and the specified value is the same, PASS, if different, causes an exception.

Application procedures

Enter the test variable and test value to verify the consistency of the variable values.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Assert Value	Any	Y	-	N	Specifies the value for checking the target.
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the variables and values you want to check, and then enter the message you want to print when they do not meet your criteria.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertEquals

Used variables

var1

Used properties

Assert Value : 1
Assert Message : 'Assertion is failed : this.var1 not 1'

AssertNull

Overview

If the variable to check is Null, PASS, if different, causes an exception.

Application procedures

Enter the variable to be tested and verify the consistency of the variable values.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the variable you want to examine and enter the message you want to print when it does not meet the conditions.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertNull

Used variables

var1

Used properties

Assert Message : 'Assertion is failed : this.var1 is not null'

AssertEmpty

Overview

If the variable to be checked is empty, PASS, if different, causes an exception.

Application procedures

Enter the variable to be tested and verify the consistency of the variable values.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the variable you want to examine and enter the message you want to print when it does not meet the conditions.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertEmpty

Used variables

var1

Used properties

Assert Message : 'Assertion is failed : this.var1 is not empty'

AssertContains1D

Overview

If a specified value exists in the one-dimensional array variable to be examined, PASS, if different, causes an exception.

Application procedures

Enter the test target one-dimensional array variables and test values and ensure the test values are included in the one-dimensional array.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Assert Value	Array 1D	Y	-	N	Specifies the value for checking targets included in a one-dimensional array.
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the variables and values you want to check, and then enter the message you want to print when they do not meet your criteria.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertContains1D

Used variables

var1

Used properties

Assert Value : b
Assert Message : 'Assertion is failed : b is not in the array'

AssertContains2D

Overview

If a specified value exists in the two-dimensional array variable to be examined, PASS, if different, causes an exception.

Application procedures

Enter the test target two-dimensional array variables and test values and ensure the test values are included in the one-dimensional array.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Assert Value	Array 2D	Y	-	N	Specifies the value for checking targets included in a two-dimensional array.
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the variables and values you want to check, and then enter the message you want to print when they do not meet your criteria.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertContains2D

Used variables

var1

Used properties

Assert Value : c
Assert Message : 'Assertion is failed : c is not in the array'

AssertNumberRange

Overview

If the variable to be examined is numeric and within the minimum, maximum range, PASS or an exception is generated.

Application procedures

Enter the test target variable, minimum, and maximum values, and make sure the value of the variable is within the input range.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Min Value	Integer	Y	-	N	Specifies the minimum value for the assert
N	Max Value	Integer	Y	-	N	Specifies the maximum value for the assert
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the variable, minimum, and maximum values to check, and then enter the message you want to output when the conditions do not match.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertNumberRange

Used variables

var1

Used properties

Min Value : 0
Max Value : 10
Assert Message : 'Assertion is failed : out of range'

AssertDataType

Overview

If the variable to be examined matches the specified data type, PASS or an exception is generated.

Application procedures

Enter the variable and variable type to be tested, and verify that the type of variable matches the entered type.

Card properties

Card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	Assert Type	Select	Y	-	N	Specifies the test type for the test target. The types that can be inspected are as follows. - number: integer type - string: string type - boolean: Bool type - Object: Object type - Undefined: Undefined type
Y	ASSERT	-	-	-	-	Common property of the FlowControl library.
Y	MORE OPTIONS	-	-	-	-	Common property of the FlowControl library.
Y	DESCRIPTION	-	-	-	-	Common property of the FlowControl library.

Example of utilization

Enter the variable and test type to check, and then enter the message you want to display when it does not meet the conditions.

Excel_NewExcel_1K

Sample file

Menu > Help > Sample > Sample > Flow Control > Assert_Sample > P_AssertDataType

Used variables

var_undefined
var_number : 1
var_string : 'sample'
var_array : [1,2]
var_bool : false

Used properties

Assert Message : 'Assertion is failed. : type is different'