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. In designer Lite you can create or open only general projects. See Project, Process flow, and Headless project.
Project screen overview
The following explains the Designer screen layout. A project consists of the following components:
Menu and toolbar
Library
Canvas
Variables, Output
Properties
No. | Description |
---|---|
1 | Menu and toolbar |
2 | Library |
3 | Canvas |
4 | Variables, and Output |
5 | 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.
No. | Description |
---|---|
1 | Create a new project or process flow. |
2 | Open a saved project or process flow. |
3 | You can launch the designer to open the project or process flow. |
4 | Open most recently used file. |
5 | Save the file you are currently working on. |
6 | View the execution results and times of recently executed processes. |
7 | Import projects or process flows from the server or package. |
8 | Distribute projects or process flows to the server or export a copy of the project or process flow as a package. |
9 | Design a project with the recording feature. Provides the same feature as the record button on the toolbar. |
10 | Run or stop a designed project. |
11 | You can select tabs to display on the screen, such as projects, library views, etc. |
12 | Check and scan CPU and memory usage. |
13 | Change the Designer, Server, and License settings. |
14 | View the user manual, samples, open source license, logs, or Designer information. |
15 | View the designer's open source license, log, version and update package information. |
16 | Close Designer. |
Limited features in Dodge Honor Lite
Limited features in Designer Lite are marked as locked.
The following pop-up is displayed when you click the menu with a lock mark.
Settings
To configure Designer settings in the menu, you can click Settings, including the View, Assign Object, Record, and Language options.
No. | Description |
---|---|
1 | Basic Tab: Set up default settings such as designer language. |
2 | View Tab: Set up viewing settings, such as popups that occur during designer use. |
3 | Assign Object Tab: Set up settings for designating automated objects. |
4 | Record Tab: Set up settings related to automatic scenario recording. |
5 | Engine Tab: Set up settings for the engine used in running automation. |
6 | Server Tab : Set up settings associated with a server associated with a designer. |
7 | License Tab: Set up the settings related to the license. |
Basic
No. | Description |
---|---|
1 | [Language] Select a language for Designer. |
2 | [Auto Save Interval (min)] Set the intervals for automatic saving when editing a process or task. |
3 | [Login Browser] Set the browser type for SSO login. |
4 | [Base Folder] Set the default path to store projects. You can click Check to ensure that you have the permission to access the folder. |
View
No. | Description |
---|---|
1 | [Show Play Popup] Display a pop-up asking whether to minimize the Designer while a process or task is executed. |
2 | [Minimize in Play] Set whether to minimize Designer while a process or task is executed. |
3 | [Trace Execution] Track the current step of the process and indicate it on the Designer screen. |
4 | [Show Execution Report] Automatically display the execution report when the process is complete. |
5 | [Show Extension Notification] Set whether to provide a notification when an extension program is added. |
6 | [Show Property Guide] Display descriptions for each property item in a library. |
7 | [MessageBox Auto Close (Sec)] Set the delay time before message boxes are automatically closed. Message boxes will not be automatically closed if “0” is entered as the setting value. |
8 | [Use Chrome result image] Display the Chrome library target image in the report. When this option is enabled, the browser window will blink while the image is saved. This option is always enabled for Headless Chrome projects regardless of this setting. |
9 | [Close all opened tabs] Close all open tabs after executing a process or task. |
10 | [Show Debug Log] Display the debug log in the output viewer. |
11 | [Use Step Recommendation] When creating the scenarios, use step recommendations. |
Assign Object
No. | Description |
---|---|
1 | [Show CheckOption Popup] Display the pop-up window for check options to locate objects. |
2 | [Use Auto CheckOption] When performing an automation, Designer automatically enables the check option to search for objects. |
3 | [Show Indexing Popup] Display the indexing option pop-up window. |
4 | [Use Auto Indexing] Automatically specify the index (order) of objects sharing the same property. |
5 | [Show Assign-Tip Popup] Display the tips for assigning objects in a pop-up window. |
6 | [Show Tooltip for object information] Displays information about object in which mouse is located. |
7 | [Show sub-object bounds] Display the boundary of sub-objects when an object is selected. |
8 | [Use Invoke as Default] Set to use “Invoke” as the default value. |
9 | [Hide Capture image] Set whether to hide the captured image that is the target of an activity. While this option is enabled, the captured image will not be displayed when the target object is selected in an activity card. |
Record
No. | Description |
---|---|
1 | [Show Record-Tip Popup] Display tips for recording in a pop-up window. |
2 | [Disable steps before automatic conversion (delete when unchecked)] Set whether to keep the recording before an automatic conversion in a diagram in a disabled status or to delete the recording. |
3 | [Display stepname as detailed event info] Set whether to display the name of recorded steps as detailed event information. This option will be applied only to the projects that have been recorded with Recorder. |
Engine
No. | Description |
---|---|
1 | [Clean Up ALL] Close all applications executed by a process to reliably execute automation. |
2 | [Clean Up NEW] Close all applications executed by Bot to reliably execute automations. |
3 | [Clean Up Ignore List] Set the items that will be excluded from clean-up operations. Separate each item with a semicolon (;). (Ex.: notepad.exe;mspaint.exe) |
4 | [Step Image Max Count] Set the maximum number of execution screen images that will be stored. For example, if there are 10 steps and the maximum number to be stored is 3, the last three screens, 8th, 9th, and 10th, will be stored when the steps are executed. |
5 | [History Backup Count] Set the number of execution history entries that will be backed up. |
6 | [Step Result Max Count] Set the maximum number of steps that will be stored in report. The report will not be created if “0” is entered as the setting value. |
7 | [Validate Variable Type] Check if the variable types declared during the execution are assigned with different types of values. |
8 | [Use Old Version Library] Set to use old versions of libraries, such as the Web library. |
9 | [Use DirectX Screen Capture] Enables capture using DirectX technology when capturing a screen. |
10 | [Chrome Default Latency(ms)] Set the required default waiting time according to the performance of the execution environment if the execution result of the chrome library is unstable. |
11 | [Debug Mode] Store the variable values from the previous execution if an error occurs while performing a process. |
12 | [Use Variable Monitoring] When used with the debug mode, you can monitor the values of variables at the time of the currently executing step in real-time. The variable value is displayed just before the current step is executed. |
13 | [Use Remote BOT] Set the scenario to run the remote BOTs. Set the IP of the bot to use.Enabled: When a process is executed, a pop-up to enter information from a remote location is displayed. The process is executed in the remote bot set by the user. |
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.
No. | Description |
---|---|
1 | [Server Address] Set the server address |
2 | [Server Port] Set the server port |
3 | [User System Proxy] Select whether to use a proxy on the system or not |
4 | When deploying a project with [Export > Deploy to Server], set the maximum capacity of the compressed package for the project. The capacity limit is determined by the server's settings or network policy. |
5 | Set the path to download the file. |
Help
Sample
You can check the library samples provided by Designer. In the menu, click Help > Sample.
Sample files are not included in the installation file. You can download the sample files to a specified path to view them. For more information about viewing sample files, see Using Samples.
Home screen
You can check the home screen by clicking the icon on the designer title bar.
Home
No. | Description |
---|---|
1 | Displays the New Project popup. |
2 | Displays a list of recent files. |
3 | Displays a list of recommended tutorials. |
4 | Displays a list of samples. |
5 | Go to https://brityworks.ai/solution/casestudies/list. |
6 | Go to https://www.youtube.com/c/BrityRPA. |
7 | Go to https://brityworks.ai/community/forum. |
learning
No. | Description |
---|---|
1 | Viewing the designer configuration again. |
2 | Displays a pop-up list of recommended tutorials. |
3 | Displays the New Process Flow popup. |
4 | Displays a sample list popup. |
5 | Go to https://brityworks.ai/community/learn. |
6 | Go to https://www.samsungsdsbiz.com/help/RPA_User_2_5_0#3909fad467fcc826 page. |
7 | Go to the https://brityworks.ai/community/forum?board_id=1&category=109&offset=1&limit=6&pageType=list&isPrivate=false&isGroup=false&selectedAll=false&moreClickFlag=true. |
8 | Go to https://brityworks.ai/solution/marketplace. |
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.
No. | Description |
---|---|
1 | [Run] Run the currently open process or task. |
2 | [Record] Record the screen control on a PC to automatically design a process. |
3 | [Save] Save the currently open process or task. |
4 | [Save All] Save all open processes or tasks. |
5 | [Undo] Cancel the last action executed on the canvas. |
6 | [Redo] Run the canceled action again. |
7 | [Cut] Cut the selected node. |
8 | [Copy] Copy the selected node. |
9 | [Paste] Paste the copied or cut node. |
10 | [Copy History] Copy the history. |
11 | [Delete] Delete the selected node. |
12 | [Create Block] Create a block that surrounds the selected activities. Blocks are useful when you design a long, complicated process because they can be collapsed and expanded. |
13 | [Small View] Decrease activity card size. By decreasing the activity card size, you can utilize the canvas screen more effectively. |
14 | [Collapse] Select vertically connected nodes and collapse them. |
15 | [Disable] Deactivate the selected activity. Deactivated activities will not be executed during a run. |
16 | [Reverse] Select all activities other than the currently selected ones. |
17 | [Search] You can search activity name, variable name, description, etc. |
18 | [Navigate Forward] Moves to the activity card in front of the currently selected activity card. |
19 | [Navigate Back] Moves to the activity card behind the currently selected activity card. |
20 | [Move Mode] You can use a move mode that allows you to move the chart. |
21 | [Show Overview] Display a preview screen at the bottom of the canvas. |
22 | [Maximize] Maximize the canvas screen and hide the Project, Library, and Properties panes. |
23 | [Init Layout] Initialize the screen to the default layout that is provided when Designer is run for the first time after installation. |
24 | [Open Activity Grid View] View the activities on the canvas in grid view. |
25 | [View Recent Reports] Click or double-click this icon to view the reports of recently executed processes or tasks in a tab or pop-up window. |
26 | [View scale] Adjust the view scale to magnify or shrink the canvas screen. |
27 | [Login/Logout] Log in to or log out from the server. |
28 | [Notice] It is used for receiving notice from the RPA portal if any. |
Library
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.
Libraries not available in Designer Lite are marked with a lock icon.
Activities from libraries with lock marks cannot be added to the canvas. The following pop-up is displayed if you double-click the library or drag and drop it onto the canvas.
For more information about individual activity cards in each library, see Library Details
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 .
No. | Description |
---|---|
1 | Displays the full library list. You can add/remove libraries by selecting/deselecting them from the list. |
2 | Displays a list of selected libraries. You can remove a library by clicking the X button in the selected list. |
3 | You can change the library view. |
4 | You can change the sort criteria for activities within a group. |
Canvas
The canvas area is where you can create a flow chart by placing the activities included in the libraries by drag-and-drop.
Variables, output
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
No. | Description |
---|---|
1 | [Name] Set the variable name. |
2 | [Initial Value] Set the initial value of the variable. After the initial value has been set, you can allow the variable to carry the set value without assigning one. You can click , select Any or Script as the editor type, and enter the initial value. |
3 | [Type] Select one of the eight data types that matches the type of data. - Any: All data types that can be supported in Designer, including String, String Format (DateTime, DirectoryPath, ...), Integer, Double, etc. - String: Supports text string values. Enter the value between two single quotation marks (‘’). - Boolean: Supports one of the two values - true or false. - Integer: Supports integer number values. - Double: Supports numbers with decimal points. - Date: Supports date-type values. The date format must be entered as YYYY-MM-DD. - Array1D: Supports one-dimensional array. (Ex.: ['a', 'b', 'c']) - Array2D: Supports two-dimensional array. (Ex.: [[1,2], [3,4], [5,6]]) |
4 | [Scope] On the drop-down list, select one of the four options that matches the scope and purpose of the data. - Normal: This variable can only be used within the same process or task and can be called in - Input: This variable is used as a parameter for transmitting a value between processes or tasks. It stands for the input value received before executing a process or task and can be called in - Output: This variable is used as a parameter for transmitting a value between processes or tasks. It stands for the output value received after a process or task has been executed and can be called in - Global: This variable can be used in all processes or tasks in the project and can be called in |
5 | [Description] You can add descriptions of variables. |
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
By clicking the setting icon on the right side of the output window, you can select whether to specify color for each log type, designate keywords, or use debug log view.
No. | Description |
---|---|
1 | Change the INFO log color |
2 | Change the NOTICE log color. |
3 | Change the WARN log color. |
4 | Change the ERROR log color. |
5 | Specify keywords. |
6 | You can change the color of the specified keyword. |
7 | You can select whether to view the debug log or not. When Enabled is selected, DEBUG, TRACE log buttons are displayed on the right side of the log window. |
8 | You can change the maximum number of total log entries to display in the output window. |
Log search
Enter Ctrl+F in the log screen, and the search window is displayed; you can search by entering the search term.
No. | Description |
---|---|
1 | Enter search term. |
2 | Browse your search terms. |
3 | Previous search. |
4 | Find the next one. |
5 | Exit search bar. |
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.).
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.
If no sub-activity card is selected in the Libraries tab, a library description is displayed in the Properties window. If a sub-activity card is selected, you can check the library description in the properties window by selecting another library and then selecting the library again.
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.
Different attribute information is displayed for each activity card. For details, refer to the properties screen of each card.
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.
See Property Assistant for more details.
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.
If [Use variable (user-created value)] is displayed only in the input of properties, it is not displayed when inputting the variable's initial value.
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.
Process Flow Screen Overview - Compatibility Mode
If you open a general project other than a project created in Designer Lite or open a project through Menu>Help>Run Sample , it runs in compatibility mode and consists of the following screen elements.
Menu and toolbar
Project, library
Canvas
Variables, public resources, and outputs
Properties
In compatibility mode, you can additionally check the project and common resource windows.
No. | Description |
---|---|
1 | Menu, Home and Toolbar |
2 | Project, Library |
3 | Canvas |
4 | Variables, public resources, and outputs |
5 | Properties |
Menu
In compatibility mode, limited functionality exists.
If the project is not created in Designer Lite, it runs in compatibility mode, and the following three functions are unavailable in the menu.
1. Menu > Save > Make a copy 2. Menu > Export > Deploy to Server 3. Menu > Export > Export Package
Project
The designer in a hierarchical structure created the project. It consists of processes, tasks, shared tasks, events, custom libraries, and resources. In [Compatibility Mode], the total number of steps stored in the project is displayed. The maximum number of steps that can be executed is 200. Therefore, it cannot be executed if it exceeds 200 steps.
The project cannot be executed in the following scenarios:
1. When the total number of steps saved in the project exceeds 200. 2. If the project includes shared work. 3. If the project contains public resources. 4. If the project includes a server-linked library not supported by Designer Lite (Orchestrator, KnoxPortal, Abby, PushMessage).
See Project Components for a detailed description of each component of the Project.
Public Resources
Lists the public resources contained in the project. You cannot add or refresh public resources in Designer Lite.
Designer Lite does not support public resources, so the below message is displayed when you try to run a project that contains public resources. You can run it after deleting all public resources.
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
Designer Lite only supports a single process.
Creating a project
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.
[Precautions for entering project names]
- Spaces are not allowed.
- The first letter cannot be a number.
- Special characters (!,@,#,$,(), ...) are not allowed.
- "-" (bar) cannot be used; use "_" (underbar) instead.
3. A list of default library groups used in an empty project is displayed on the right. To add/remove a library to use, click Set Library.
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
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.
Example of creating a Project - Create from Template
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.
[Precautions for entering project names]
- Spaces are not allowed.
- The first letter cannot be a number.
- Special characters (!,@,#,$,(), ...) are not allowed.
- "-" (bar) cannot be used; use "_" (underbar) instead.
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 Library Settings.
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.
Help Option: Start the activity assistant automatically. If you click the Create button after checking , Activity Assistant starts automatically after project creation. See the Activity Assistant page for details.
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.
In the Designer lite, up to 200 steps can be used. The number of steps designed on the canvas is displayed below.
A notification message is displayed when more than 200 steps are added, as shown below.
In [Compatibility Mode], the total number of steps saved in the project so far is displayed at the top of the project window.
If the total number of steps exceeds 200, press the Execute button to display a message that cannot be executed, as shown above.