Designer Screen Layout

A process is an automation scenario used with Brity RPA. There are three types of upper-level objects that can possess processes:

① New Regular project
② New Headless project
③ New Process flow

The three object types above may be classified depending on how they are executed by Bot.
For more information about each object type, see Project, Process flow, and Headless project.

For regular and headless projects, the same Designer screen layout is provided. However, the Designer screen layout is different for process flows.
The following explains the different screen layouts and provides information about how to use them.

Project screen overview

The following explains the Designer screen layout for regular and headless projects. A project consists of the following components:

• Menu and toolbar

• Project

• Library

• Canvas

• Shared Resource, Variables, and Output

• Properties

Menu and Home

Menu

 You can check the menu by clicking the icon on the designer title bar.

A set of menus that provide Designer features for creating, opening, and saving projects or processes, and configuring the settings.

Settings

To configure Designer settings in the menu, you can click Settings,  including the View, Assign Object, Record, and Language options.

Basic

View

Assign Object

Record

Engine

Server

To change designer server settings, including whether to use system proxy, server IP, and OCR server URL, click Settings > Server Settings from the menu.

Help

Sample

You can check the library samples provided by Designer.
In the menu, click Help > Sample.

Update Manager

In the menu, click Help > Update Manager

Home screen

You can check the home screen by clicking the icon on the designer title bar.

Home

Learning

Open

Click Open, and Windows Explorer pops up. After selecting the selected project file, click the Open button to open the selected project.

Toolbar

The toolbar includes tool buttons required to utilize Designer, such as Record and Run, and icons for the save, copy, delete, collapse, and expand features.

Project

The hierarchy structure of a project created on Designer is displayed in this area. The structure consists of process, task, shared task, event, custom libraries, and resources.

For more information about each component of a project, see Project components, Process flow components, or Headless project components.

Library

You can design automation tasks by dragging and dropping activities from the library onto the canvas.

Library view

Activities used to create automated processes are displayed in this area, classified by target apps or features. Libraries are grouped into 25 categories. You can drag the activities under a library and drop them on the canvas to design automated processes.

Automated Task Type

It is classified by the type of task that includes the automation task.

Library Search

You can find a library by entering a search term at the top library search bar. You can still search through search terms if you are not using the library.

Library Settings

You can configure library settings by clicking on the Library tab .

Canvas

The canvas area is where you can create a flow chart by placing the activities included in the libraries by drag-and-drop.

Chart Movement Menu

Click the menu button located at the bottom right of the chart view.

Usually, it is collapsed, but when you click it, it expands to reveal a menu with choices.

Each button operates as a toggle. You can select Horizontal Scroll (Shift+Scroll), Move mode, and Mini-Map.

Shared Resource, Variables, Output

Shared Resource

The list of shared resources that can be used in projects is displayed here.

After distributing frequently used files or text strings to the Orchestrator server, you can allow all users to use them in their projects. Shared resources are shared across users within the same tenant, and are created, edited, and managed by administrators on the Admin Portal.

Normal users can import shared resources on Designer to use them. However, shared resources can be imported only when you are logged in on Designer because access to the Orchestrator server is required to use them.

While logged in to the server, you can click Click here to add new item to display the list of shared resources as shown below. You can select a shared resource from the list and import it.

Shared resource features

• Shared resources imported from the server cannot be edited on Designer.

• On Designer, you can use shared resource with variables by calling then in the form of "Asset.VariableName.”

• Shared resources are dependent upon the tenant. If you log in to the server with another tenant, the previously imported shared resources will be indicated as #REMOVED# and become unavailable.

Categories and encryption types of shared resources

Classification of shared resources (category)

• File

• String

Application of security policy

Encryption types - difference between “Secure” and “Credential”

For “Credential” data, a stronger encryption module than the encryption module used for the “Secure” data is applied. Therefore, it is recommended that you apply the “Credential” encryption for essential data that must be secured, such as passwords.

• Secure: In the [App] MessageBox activity card, assign Asset.'SharedResourceName' to Arguments, one of the MessageBox activity card properties, to view the decrypted string.

• Credential: Because it is impossible to view the decrypted string, the “Credential” encryption is used to protect data that must not be exposed externally. Only four activity cards can utilize the credential strings by calling them with variables. ([App]CredentialSetText, [App]CredentialTextInput, [SAP]CredentialSetText, [Chrome]ChromeCredentialSetText)

Variables

This area is where you can define the variables used in the project you are creating.
Each time you add a new variable, the variable name will be automatically created as var+number.

Log

This screen shows the outputs log when the process or task is run.

You can view the current progress and error messages.

Log Type

You can click and view the INFO, NOTICE, WARN, and ERROR entries in the logs.

Log Settings

You can click the Setting icon on the right side of the screen; It specifies the color for each log type, designates keywords, and select whether to use the debug log view.

Log Search

Enter Ctrl+F in the log screen, and the search window is displayed; you can search by entering the search term.

Copy, Select All, Clear All Log

You get the option to Copy/Select All/Clear All Log by right-clicking on the log screen.

View Log Files

Click the View Log File icon on the right of the output window to open the file where the log is currently written in a text editor connected to your system.

Properties

Properties screen allows you to view or specify the detailed information of an object selected on Designer. Different properties are displayed depending on the selected object (project, process, task, event, activity card, etc.).

Project properties screen

Process properties screen

Library properties screen

Activity card properties that must be filled in are marked with “*.” If the required fields are not filled, the property fields will be indicated with red borders.

Activity card properties screen

Activity card properties that must be filled in are marked with “*.” If the required fields are not filled, the property fields will be indicated with red borders.

If the required fields of an activity card are not filled, the activity card will also be displayed in a red box on the canvas.

Activity card's properties screen: quick setup with minimal input

While entering the properties of the activity card, check Quickly set with minimal input; only the main properties that the user needs to check are displayed, and you can easily enter the property values.

The text is displayed in red at the top in the incomplete property state, as shown below.

When all required properties are entered, and in an executable state, the text at the top of the properties window changes to blue, as shown below.

Variable and Attribute Input Assistant

The variable and attribute input assistant helps you enter the initial value or attribute value of a variable.
Various value editors are provided according to the value format of a variable or property, and variable or property values ​​can be entered at once without using the DataConverter activity by using variables and built-in variables and value conversion functions. In addition, you can write JavaScript code directly through the script editor to generate and input the necessary values.

Enter values ​​according to the format

If you select [Enter a value according to the format], a list of available [Value input format] is provided according to the value format of a variable or property, and the value input screen changes according to the selected [Value input format]. The value's format is checked when the user enters a value, and an error message is displayed if the input is abnormal.

Using Variables (User Generated Values)

If you select [Use variable (value created by the user)], you can use the [created variable] created in the variable window as an input value. You can use the selected variable directly or select [Available Functions] to convert the value of the variable to use. Depending on the selected function, you may need to enter additional parameters.

Using built-in variables (default values ​​provided by the bot)

Select [Use built-in variable (default value provided by bot)]; you can use the default value provided by the bot in the same way as a variable.

Entering values ​​directly into the script

If you select [Enter a value directly in the script], you can enter the value of a variable or property by writing a JavaScript code that generates the desired value.

Pattern

A pattern is a collection of library activities that can be reused
The user can directly compose a flowchart within the project and use it as an activity card.
Flowcharts in library patterns can be configured using processes, tasks, shared tasks, libraries, and other library patterns.
Library patterns have the same components as tasks (tasks), but unlike tasks (tasks), declared can bring variables in regardless of scope (Normal/Global/Input/Output).

Creating custom patterns

There are two different ways to create a pattern.

1In the Pattern Repository tab, create a new pattern and complete a flow chart.

1. In the Pattern window, right-click User Patterns and click New Pattern.

2. In the New Pattern pop-up window, enter a pattern name and description and then click OK .

2 In the existing flow chart, select the area and create a pattern.

1. In the flow chart, select the area to create a pattern and right-click the selection.

2. In the context menu, Click Convert to Pattern.

3. In the New Pattern pop-up window, enter a pattern name and description and click OK .

Using patterns

Add the desired user pattern into the process by dragging and dropping the mouse.

Process flow screen overview

A process flow allows you to design by combining a number of processes published to the server. A process flow consists of the following components:

• Menu and toolbar

• Process flow

• Process search

• Library

• Canvas

• Shared Resource, Variables, and Output

• Properties

Menu and toolbar

You can create, open, and save process flows and configure the designer settings.
Unlike projects, process flows can only be executed on the server after it has been distributed to the server. Process flows cannot be executed on Designer because the Designer works in a client environment.
You can execute process flows on the User Portal provided by the server.

Menu

Because process flows cannot be executed on Designer, the Recent Report, Record, and Run features are disabled in the menu.

Toolbar

Features of the toolbar buttons are identical to those of the project screen toolbar.
However, the Run and Record buttons are disabled in the toolbar because process flows cannot be executed on Designer.

Process flow

Process flows can only have processes.
Processes under a process flow project are displayed on a list with a hierarchy, as shown below.

Add Remote Process

Right-click on a remote process and select Add Remote Process; you can search for processes deployed on the server in the import window. You must be logged in to the Designers to connect to the server. 
The discovered process can be added as a child of the working process flow.

1. Right-click on the remote process and select Add Remote Process menu.

2. In the import screen, enter the search term 'purchase'. Processes with 'purchase' in the process name are searched. Select the process you want to add to the process flow and click the Import button . The process is then added as a child of the process flow.
3. In this case, select the execution type. Then you can search by execution type.

Library

While a process can utilize many libraries, a process flow can utilize only the “'ProcessFlow” library. For more information about libraries dedicated to process flows, see The internal link is invalid..

Canvas

The canvas area is where you can create a flow chart by placing the activities included in the libraries by drag-and-drop.

Shared Resource / Variables / Output

The features of these windows are identical to those of the Shared Resource, Variable, and Output windows on a project screen. For more information, see Project components.

Properties

Properties screen allows you to view or specify the detailed information of an object selected on Designer. Different properties are displayed depending on the selected object (project, process, task, event, activity card, etc.).

CallProcess activity card property window

Below is the window for the process flow-dedicated CallProcess activity card. In the following example, it calls a process named “BaseProcess.”

Project

Project overview

Project is a unit that binds components for process automation.
A project consists of the following seven components:

• Process

• Task

• Shared task

• Event

• Custom libraries

• Resources

Creating a project

1. In the menu, click New > New Project.

2. In the "New Project" pop-up window, enter the project name and description, select Start from an empty project, and then click Next.

3. You can select a library view to use in an empty project. If you select the library group view, the default library group list is displayed on the right, and if you select the task type view, the automation task type list is displayed on the right side list.

4. You can add/delete libraries by selecting or deselecting libraries in the library settings pop-up. Click Ok after completing the library settings. For more information about library settings, see the Library page.

5. Click the Create button after completing the library settings.

6. An empty project is created, and only the selected library group is displayed in the library view.

7.   The library view is configured if you select the Automated Task Type View, as shown below.

Example of creating a Project - Create from Template

1. In the menu, click New > New Project.

2. In the New Project pop-up window, enter a project name and description, select Start from Template Project, and click the Next button.

3. Click Next, and select the template you want to use.

4. A list of library groups set in the selected template project is displayed on the right. To add/remove a library to use , click Set Library .

5. You can add/delete libraries by selecting or deselecting libraries in the library settings pop-up. After completing the library settings, click the OK button. For more information about library settings, see library settings.

6. Click the Create button. After checking on Automatically start the activity helper in the Assist option.

7. A project is created based on the selected template; only the selected library group is displayed in the library view.

Project components

Process

A process is an automation scenario, which is the unit of the tasks performed by Bot.

When you create a new process, a process named “MyProcess” will be automatically created.

Creating a process

1. In the Project window, right-click PROCESS and click New Process.

2. In the "New Process" pop-up window, enter the process name and description, and then click CREATE.

Example of creating a process - create from template

1. Right-click Processes in the Projects screen and select New Process .

2. In the "New Process" pop-up window, enter the process name and description, Check Create from Templates and then click Next.

3. Select the template you want to use and click the Create button.

Example of process configuration

Processes can import and organize other processes, tasks, and libraries .

Task

Task is a module of a process in operation.
A process is a unit of automation that is performed by Bot. On the other hand, tasks cannot be performed by Bot.

Creating a task

Create a new task in the lower left task tab of the project and complete the flowchart.

1. In the Project window, right-click Task and click New Task.

2. In the "New Task" pop-up window, enter the task name and description, and then click CREATE.

Creating a Task - Creating from Template

Use the template to create new tasks and complete flowcharts.

1. In the Project window, right-click Task and click New Task

2. In the "New Task" pop-up window, enter the process name and description, Check Create from Templates and then click Next.

3. Select the template you want to use and click the Create button.

Creating a Task - Creating from Flowchart

Select the area you want to create as a task from the already created flowchart and create it.

1. Select the area created as a task in the flowchart and right-click.

2. Click Convert to Task in the shortcut menu that appears

Example of creating a task

As it is with a project, you can create a task by utilizing processes, import and organize processes, other tasks, and libraries.

Shared task

You can import shared processes or tasks distributed to Orchestrator into Designer and use them as modules of automation processes.

Use cases of shared tasks

Shared tasks can be used to address the following cases:

• Duplicated tasks by different users: When two or more users within the same tenant need to utilize the same process or task.

• Duplicated tasks by different processes: When two or more processes within the same tenant need to utilize the same process or task.

Importing a shared task

1. Log in to the server on Designer.

2. In the Project window, you can right-click SHARED TASK and click Import From Server.

3. In the "Import" pop-up window, select a process or task under a searched project and click IMPORT. You can select two or more processes or tasks while pressing the Ctrl or Shift key to import multiple shared tasks at once.

Example of shared task utilization

Shared tasks are used when you create a flow chart with processes or tasks on Designer. Shared tasks can be used in the same manner as ordinary tasks. Therefore, when you utilize the shared tasks after importing them, they are described as "Task" regardless of the original types of the shared tasks.

Event

You can utilize events in a flow chart, just like you utilize processes or tasks, and have them called at a specific time point while the process, task, or activity is performed, as shown in the following table.

Creating an event

1. In the Project window, right-click EVENT and click New Event.

2. In the "New Event" pop-up window, enter the event name and description, and then click CREATE.

Example of event utilization

Events are called to perform a specific action before or after an automation process, or when an error occurs while an automation process is performed.
In the Project window, when you double-click a process or task to call an event, the onBefore, onAfter, and onError combination boxes will be displayed in the Properties window.
Also, in a flow chart, you can double-click a process, task, or activity to display the onError combination box.

Each combination box is used to set a different time point to call the event, as follows:
· onBefore: Before a run
· onAfter: After a run
· onError: When an error occurs during a run

1. Create an event and configure it to display a message box saying "This is a test" on the flow chart.

Custom library

The custom library feature allows you to refer to external libraries.

The available external libraries are as follows:

• JavaScript library

• MS Workflow activity library

• MS.NET library

Resource

You can register frequently used files within the project as resources and call them via the specified paths.

Adding a Resource

1. In the Project window, right-click RESOURCES and click Add Resource.

2. On File Explorer, select the file to register as a resource and click Open.

Utilizing resources

You can utilize the specified paths via variables to call resources.
Global.ResourcesDir + 'ResourceName.extension'

Group

When there are many sub-components under a project, you can group them in different folders according to their purpose.
A group can also include multiple subordinate groups.
Project components that can create folders are as follows:

• Process

• Task

• Custom library

• Library template

To create a new group, complete the following steps:

1. On the project screen, right-click TASK and click New Group.

2. In the "New Group" pop-up window, enter the name for the new group you want to create and click CREATE.

A new group is created.

Navigating between groups

You can navigate between the processes, tasks, custom libraries, and library templates in the groups or navigate between the groups.
Select a task to move and drag-and-drop it to the desired position.

Process flow

Process flow overview

Process flows are used to implement automation of process flows.
One process flow can call multiple processes and control the flows between the processes.

Difference between a regular process and a process flow

[Regular process - Automation of tasks]
In regular processes, one process works as the unit of performing an automation process.
The automated individual tasks stand for task units that can be completed without human intervention.

[Process flow - Automation of process flows]
You can combine existing processes to compose the order and flow of processing.
You can also control the process flows that require human interactions on the process flow server.

Process flow features

• [Creation/Execution]: Process flows can be created on Designer, but can be executed only on the server. (※ Scheduled tasks are executed based on the server time [UTC].)

• Library: Process flows have the “FlowControl” library which is dedicated to process flows.

• Management: After distribution to a server, process flows are activated, executed, and monitored separately from normal processes.

Adding Waiting Action

A process flow is an asynchronous method that is not performed in order. 
If a process must be performed in order, an action of waiting until the previous process ends must be applied. 

For example, if a mail writing process must be performed after completing a login process, add the  WaitForMultipleEvents activity card between these two processes.

Creating a process flow

1. In the menu, click New > New Process Flow.

2. In the "New Process Flow" pop-up window, enter the process flow name and description, and then click CREATE.

Process flow components

You can compose a process flow with processes that have been distributed to the server and automate the process flow by combining the processes imported from the server with the dedicated process flow library.

Process

Before you can add processes to a process flow, two prerequisites must first be satisfied.
1 The process to add must be distributed to the server and approved in advance.
 - You can view the list of process flows and the approval information on the User Portal.
2 You must be logged in to the server on Designer.
 - At the top-right corner of Designer screen, click the user profile icon to log in to the server.

Process flow library

The key activities of the process flow library are as follows:

Headless project

Headless project overview

What does “headless” stand for?

The “headless” design allows for parallel, background operations of multiple tasks without occupying the screen.
Utilizing the headless design, you can enhance the processing speed and make better use of your bots because it allows one bot to execute multiple tasks. Also, because errors related to unexpected actions resulting from occupying the screen can be eliminated, you can ensure reliable operation of the automated processes.

Headless project features

Headless projects do not support the following libraries for recognizing objects or images:

• Image recognition library

• App library

• SAP library

Before you can start creating headless projects, the following settings must be preceded.

• The project must be created as a “headless project.”

• In the Bot Client Setting pop-up window, the Headless Mode checkbox must be selected on the Server tab.

Creating a headless project

1. In the menu, click New > New Headless Process.

2. In the "New Headless Project" pop-up window, enter the headless project name and description, and then click CREATE.

Headless project components

Headless projects have the same components as regular projects.
However, they have different libraries and operate in different ways.