Bot Components
Welcome page
The welcome page is the first page that is displayed when you run Bot. You can activate the license by entering the license key.
Bot_install5-1
License activation
The license activation page is displayed when the license activation is complete. You can view the license type, Bot ID, and the valid period of the activated license on the license activation page. Click Start Brity RPA to move to the Bot service page.
For more information about license activation, see Activating the license.
Bot_install5-1
Home
The work plan registration status, bookmark settings, and process execution results registered on the user's PC can be easily checked.
For more information on using your home view, see The internal link is invalid..
라이선스01
Work Plan
Create and manage execution plans for the process files stored on the local PC.
For more information about creating work plans and executing them, see The internal link is invalid..
라이선스01
Process execution history
View the processes operated by bots and the operation results.
For more information about the process execution history, see The internal link is invalid..
라이선스01
Log
This page provides important logs about bot operations. You can view the current status and error messages.
For more information about Log, see Checking Log.
라이선스01
About
On this page, you can view basic installation information about Bot, including the client ID, Bot version, and the installation path.
라이선스01
Settings
On this page, you can view Bot information or change the Bot settings.
For more information about the Bot settings, see Configuring Bot settings.
Settings3
Attended License
Attended Bot is divided into Attended Bot Linked and Attended Bot Stand-Alone, depending on whether there is an orchestrator server connection. When installing a bot, you need to select and install the type according to the type you want to use, and the license key must also be issued and used with the license key of the target type.
Attended Bot Linked
Only users who subscribe to the orchestrator portal can use the bot.
Work plans can be activated after the bot logs in to the server and establishes a connection with the server. When the connection with the server is terminated, all activated work plans are put on hold.
When you create a work plan, you can refer to the projects registered on the server, and depending on your settings, you can update the project again every time you run the process before starting.
After the execution of the process is completed, the performance results can be uploaded to the server, and the performance history and detailed performance history can be checked through the orchestrator portal.
Monitor the bot's status and the results of the work plan done by the bot through the portal, but it does not support remote monitoring like the Unattended Bot.
Stand-Alone Attended Bot
The license allows standalone execution without a connection to the orchestrator server.
A server connection is required to activate and update licenses, but the main functions of the bot can be performed with or without a connection to the server.
Offline license activation is supported if the network environment cannot connect to the server.
Activating the license
To activate a Bot license, complete the following steps:
Authenticating
1. Run Bot. The Bot activation page will be displayed when you run Bot for the first time. 2. Set the license key on the login screen and click Authenticate.
Bot_install5-1
3. When the license activation is complete, view the license type, Bot ID, and the license period and click Start Brity RPA. The Bot service will start.
Bot_install5-1
Authenticating offline
If you can not connect to the authentication server, click Offline Authentication.
Bot_install5-1
2. The offline authentication screen pops up and displays the 12-digit activation request code . (request code is valid for 5 minutes)
3. You can obtain an 8-digit activation code by directly accessing the site address (www.brityworks.ai/license) or by accessing the QR code .
When accessing by entering www.brityworks.ai/license address: On the webchat screen, the user directly enters the activation menu, enters a 12-digit request code, and clicks the request button to receive an 8-digit activation code.
When accessing by QR code : Move the activation code to the screen where the 8-digit number is issued.
Bot_install5-1
4. Enter the 8-digit activation code issued to you at the bottom of the pop-up screen and click the OK button.
Bot_install5-1
5. When offline verification is complete, check the license period, Bot ID, and license type and click Start Brity RPA. The bot service is started.
Bot_install5-1
Logging In (Type Linked)
Attended bots of type Linked must log in to the server to use the bot normally. If you don't log in and connect to the server, you can view the work plan, create and edit it, and so on, but you won't be able to activate the work plan and start the automation process. Run the automation process directly through the Instant Process menu in the work plan. However, since there is no connection to the server, the results of the executed process cannot be uploaded to the server and managed.
An Attended Bot of the Stand-Alone type is used alone without a connection to a server and does not provide login and server connection functions.
You will see a login pop-upwhen you click the connection status button in the title bar area. You can log in using the ID and password of the user registered on the server. The user's username to log in must have permission to log in to the tenant where the bot is registered. Click the connection status button again to disconnect from the server.
Untitled
Log in after setting the "Auto-connect on launch" in the Bot Settings Server tab to "Enabled." You will be automatically logged in and connected to the server the next time the bot runs.
Attended bot4
Utilizing Home View
The work plan registration status, bookmark settings, and process execution results registered on the user's PC can be easily checked.
Click(Home).
WOrk Plan Step 1
No. | Description |
|---|---|
1 | Displays the total number of registered work plans and the number of active work plans. |
2 | A list of the specified bookmarked work plans is displayed in the work plan list. |
3 | You can turn off the bookmark by clicking the bookmark icon. When the bookmark is released, it disappears from the home screen list. |
4 | The activated work plan can be deactivated by clicking the Deactivate button. |
5 | The deactivated work plan can be activated by clicking the Activate button. |
6 | Displays a brief graph of statistics on the results of a process that has been run in the last week. |
7 | The history of the recently executed process is displayed up to five times. |
8 | Click the button > to go to the Process Execution History tab. |
Creating a Work Plan
Create and manage execution plans for the process files stored on the local PC.
Click(Work Plan), then create and manage execution plans.
Adding a work plan
Creating a work plan requires the following four steps:
To add a work plan, complete the following steps:
On the Work Plan page, click + or Add.
WOrk Plan Step 2
In the "General" pop-up window, enter the Plan name and Description, then click Next.
워크 플랜_기본정보
No. | Description |
|---|---|
1 | Enter the name of the work plan to add. (Up to 200 characters, required) |
2 | Enter the description of the work plan. |
In the "Process" pop-up window, specify the process and related parameters, then click Next.
워크 플랜_기본정보
No. | Description |
|---|---|
1 | Enter the file path for the process to execute. |
2 | Set the input parameters for the process. |
3 | If the process does not start within the set time, it can be treated as a failure. |
4 | If the process does not complete within the time set, it can be treated as a failure. |
5 | Select the path. |
As shown below, you will see a pop-up for Linked type to select the local process, task type, and server process. You can choose the server process to specify the process deployed to the server, and you can download the project that contains the process and specify the process path.
Attended bot
Attended bot7
If you specify the server process when selecting a process for an Attended Bot of type Linked, you will see the option "Always update to the latest version to run". If the option is checked, the process will run by downloading the latest version of the project from the server again when the process in the workplan runs.
Attended bot5
In the "Trigger" pop-up window, select whether to use a trigger and the type of the trigger to use, then click Next.
워크 플랜_기본정보
No. | Description |
|---|---|
1 | Select whether to use a trigger. A work plan using a trigger monitors the specified trigger conditions and starts the process when the conditions are satisfied. |
2 | Select one of the 7 trigger types to use. (File/Folder, Logon, Idle, E-Mail, Network, Hotkey, Process) |
Trigger type #1: File/Folder
While monitoring the files in the specified folder, run the process when the file status matches the set condition.
WOrk Plan Step 4
No. | Description |
|---|---|
1 | Specify the folder to monitor. |
2 | In the specified folder, specify the file and file extension to monitor. If not specified, “*.*” will be used by default and all the files in the folder will be monitored. |
3 | Select the file condition to generate the trigger. - Created: The process will be executed when the file is created. - Deleted: The process will be executed when the file is deleted. - Changed: The process will be executed when the file data, such as the file size, security settings, last updated time, and last accessed time, is changed. - Renamed: The process will be executed when the file name is changed. |
4 | The monitoring will stop if the set condition (Created, Deleted, Changed, or Renamed) is not met within the set time. You can select Do not use to continue monitoring without the time limit. |
5 | It is possible to set whether to repeat. The schedule is not available when the trigger repeat setting is enabled. Repeat: A trigger occurs, and the work plan remains active even after the process is executed. Do not repeat: Once the process is executed after a trigger occurs, the work plan changes to disabled. |
6 | It can be configured to continue waiting for a trigger even while the process is running. When a trigger occurs while a process is running, the triggered process waits for the previous process to terminate. |
Trigger type #2: Logon
The process is executed when the user logs in to Windows.
WOrk Plan Step 5
Trigger type #3: Idle
The Process runs when there is no keyboard or mouse input, and CPU usage remains below the set value for the specified time.
WOrk Plan Step 7
No. | Description |
|---|---|
1 | Enter the CPU usage rate to be considered idle state. |
2 | Sets how long the specified CPU usage will last, If the CPU usage remains below the set value for the specified time period, the process runs. |
3 | It is possible to set whether to repeat. The schedule is not available when the trigger repeat setting is enabled. Repeat: A trigger occurs, and the work plan remains active even after the process is executed. Do not repeat: Once the process is executed after a trigger occurs, the work plan changes to disabled. |
Trigger type #4: E-Mail
The process is executed when a mail message that meets the set condition is received.
WOrk Plan Step 8
No. | Description |
|---|---|
1 | Specify the protocol. |
2 | Specify the mail server. |
3 | Specify the mail server port. |
4 | Specify whether to use SSL. |
5 | Enter the mail account ID of the user. |
6 | Enter the mail account password of the user. |
7 | If you specify the sender’s email address, a trigger is generated to execute the process when a mail message is received from the specified sender. |
8 | If you specify the mail subject, a trigger is generated to execute the process when a mail message with the specified subject is received. |
9 | If you specify the period, mail messages will be monitored for the set conditions during the specified period. |
10 | The monitoring will end if a mail message that meets the set conditions is not received within the set period. |
Trigger type #5: Process
It is executed upon the creation or termination of a particular process.
No. | Description |
|---|---|
1 | Enter the process you want to monitor. |
2 | Select the trigger's occurrence condition. |
3 | Stop monitoring if it does not run for a set time. |
4 | Select whether the trigger is repeated. |
Trigger type #6: Hotkey
When the registered hotkey is pressed, the process is executed.
No. | Description |
|---|---|
1 | Click 'Click Here' to enter the shortcut key. |
2 | Select whether the trigger is repeated. |
It is not possible to activate the Workplan at the same time when the same key is duplicate registered in different workplans.
Trigger type #7: Network
When a connection or disconnection occurs for a particular address(Rest API), the process is executed. Large portals prevent ping due to security or network traffic, so be careful when testing.
No. | Description |
|---|---|
1 | Select the trigger condition. |
2 | Enter the network address to monitor. |
3 | Select the network service type. |
4 | Stop monitoring if it does not run for a set time. |
5 | Select whether the trigger is repeated. |
In the "Schedule" pop-up window, select whether to use the schedule and specify the frequency options. Then, click OK.
Scheduling refers to the period during which a trigger monitoring or process is started.
If the trigger is set at the start time of the set schedule, start monitoring the trigger, and if not, start the process.
When the schedule expires, it no longer starts a new trigger monitoring or process, but the started trigger monitoring or process continues to run.
The running trigger monitoring and process termination is determined by the each timeout settings, and the work plan is disabled when both the schedule and the execution of the trigger monitoring and process are completed.
WOrk Plan Step 10
No. | Description |
|---|---|
1 | Select whether to use the schedule. |
2 | Select one of the four frequency types and specify the related options, such as the start time, interval, and expiration time. (One time / Daily / Weekly / Monthly) |
Detailed schedule settings #1 - One time
Run the schedule only once, at the specified time. If the trigger is set, start trigger monitoring, and if not, start the process.
WOrk Plan Step 11
No. | Description |
|---|---|
1 | Run the schedule only once, at the specified time. |
2 | Specify the start time for the schedule |
3 | Set the expiration time for the work plan. |
4 | Set the repeat time interval at the specified time. |
5 | Set the repeat period for the schedule. |
Detailed schedule settings #2 - Daily
Run the schedule daily, at the specified time on the specified date. If the trigger is set, start trigger monitoring, and if not, start the process.
WOrk Plan Step 12
No. | Description |
|---|---|
1 | Run the work plan daily. |
2 | Set the interval to run the work plan. |
3 | Specify the start time for the work plan. |
4 | Set the expiration time for the work plan. |
5 | Set the repeat time interval at the specified time. |
6 | Set the repeat period for the schedule. |
Detailed schedule settings #3 - Weekly
Run the schedule weekly, at the specified time on the specified date. If the trigger is set, start trigger monitoring, and if not, start the process.
WOrk Plan Step 13
No. | Description |
|---|---|
1 | Run the schedule weekly. |
2 | Set the weekly interval and the days of the week to run the schedule. |
3 | Specify the start time for the schedule. |
4 | Set the expiration time for the schedule. |
5 | Set the repeat time interval at the specified time. |
6 | Set the repeat period for the schedule. |
Detailed schedule settings #4 - Monthly
Run the schedule monthly, at the specified time on the specified date. If the trigger is set, start trigger monitoring, and if not, start the process.
WOrk Plan Step 14
No. | Description |
|---|---|
1 | Run the schedule monthly. |
2 | Set the months, dates, and the days of the week to run the schedule. - Months: Set the months to run the schedule. - Days: Set the dates to run the schedule. (Ex.: 1, 2, 3) - On: Set the days of the week to run the schedule. (Ex.: First Monday) |
3 | Specify the start time for the schedule. |
4 | Set the expiration time for the schedule. |
5 | Set the repeat time interval at the specified time. |
6 | Set the repeat period for the schedule. |
Managing a work plan
Work plan management page
A newly generated work plan is not activated by default, and you can click the Run button to activate it. While the work plan is not active, the(Run),
(Edit), and
(Delete) icons will be displayed when you hover the mouse pointer over the work plan. While the work plan is active (running),
(View Details) and
(Stop) icons are displayed when you hover the mouse pointer over the work plan.
WOrk Plan Step 15
Import/Export Work Plans
You can add a workplan by exporting the generated workplan to a file, or by importing the exported file.
WOrk Plan Step 16
1You can import and add workplans created on other PCs.
2You can export a workplan created from a bot on my PC to a file.
Workplan bookmark setting
You can set bookmarks for frequently used work plans among the created work plans. When a mouse pointer is raised on the work plan, a bookmark icon () is displayed. You can set up and release bookmarks by clicking on the icon
. The icon
represents the bookmarked work plan. The list of bookmarked work plans can also be checked on the home screen and can be activate/deactivate.
WOrk Plan Step 17
Running a work plan
When you run the work plan, it will be operated according to the scenarios A through D, as shown in the following table:
Settings | Operation procedures |
|---|---|
A. If both the trigger and schedule options are used | ① The scheduling will begin when the work plan is run. ② The trigger will be activated at the specified time during the scheduling. ③ The process begins to operate when the set conditions are met while the trigger is activated. (If another process is already running at the time of the process operation, the process operation will fail.) ④ When the process operation ends, the scheduling will continue to run. ⑤ When the scheduling expires, the work plan becomes inactive. |
B. If only the schedule options are used | ① The scheduling will begin when the work plan is run. ② The process begins to operate at the specified time during the scheduling. (If another process is already running at the time of the process operation, the process operation will fail.) ③ When the process operation ends, the scheduling will continue to run. ④ When the scheduling expires, the work plan becomes inactive. |
C. If only the trigger options are used | ① The trigger is activated when the work plan is run. ② The process begins to operate when the set conditions are met while the trigger is activated. (If another process is already running at the time of the process operation, the process operation will fail.) ③ When the process operation ends, the work plan becomes inactive. |
D. If neither of the options are used | ① The process begins to operate when the work plan is run. (If another process is already running, a message is displayed to ask you to end the ongoing process and run the work plan again.) ② When the process operation ends, the work plan becomes inactivated. |
The following explains the detailed procedures of the scenario “A. If both the trigger and schedule options are used.”
On an inactive work plan, click(Run). Then, in the schedule confirmation pop-up window, click ACTIVATE to start the scheduling. (1)
Work plannnnneeeee
When it is in the schedule waiting state, the color of the schedule status display on the work plan card changes to light blue, and the remaining time until the start of waiting for the trigger is displayed at the bottom of the plan.
WOrk Plan Step 18
The trigger will be activated at the specified time during the scheduling. (2)
WOrk Plan Step 19
The process begins to operate when the set conditions are met while the trigger is activated. (3)
(If another process is already running at the time of the process operation, the process operation will fail.)WorkPlan11
When the process is running, the Pause button and Stop button are displayed. A pause does not occur immediately, and will pause before executing the next step after completing the currently running step. After the process is paused, the Resume button is displayed. Pressing the Stop button stops the running process completely.
Short Cut
- Stop : Ctrl + Alt + Shift + F12
- Pause : Ctrl + Alt + Shift + F11
- Resume : Ctrl + Alt + Shift + F10
WOrk Plan Step 20
When the process operation ends, the scheduling will continue to run. (4)
WOrk Plan Step 18
When the scheduling expires, the work plan becomes inactive. (5)
WOrk Plan Step 21
Checking the Schedule
You can see the schedule of tasks scheduled in your bot. Each work plan is displayed in the same color, and if you double-click the work plan, you can check the detailed work plan information.
Click (Schedule).
Day
Click Day to check the daily schedule.
Week
Click Week to check the weekly schedule.
Month
Click Month to check the Monthly schedule.
Viewing process execution history
View the processes operated by bots and the operation results.
Click(Process execution history).
BotProcessExecutionHistory
No. | Description |
|---|---|
1 | Run Designer and view the execution history of activity cards on Designer screen. |
2 | Open the folder where the execution history files are stored. |
Opening a report
Click Open next to the process to view the report. The Designer will be launched, and the execution history of activity cards will be displayed on the Designer screen.
To view the report, the designer must also be installed for the bot.
The maximum number of step results must be set in the engine settings .
WOrk Plan Step 22
Viewing log files
Click Open folder next to the process to view the log (execution history) to open the folder where the execution history files are stored.
Designer Project view
In the folder, log files (bot_agent.log, bot_engine.log, result.rpt) and screenshot files (*.PNG) are stored.
Checking Log
This screen shows the log bot operation. 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.
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. |
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.
Configuring Bot settings
You can configure the Bot environment by changing the settings. Click(Settings) and view or change the settings on the Basic, Engine, System, Server, and License tabs.
Basic settings
View or change basic Bot settings, such as the language, and default folder to save projects.
Click(Settings) > Basic tab.
라이선스01
No. | Description |
|---|---|
1 | Select a language to use. (Korean and English are available.) |
2 | View the specified path and modify it if required. |
3 | Check to make sure that the specified path is available. |
4 | Restore all settings to the default settings. The license information and server address will be retained after the restoration. |
5 | Save the changes. |
Engine settings
Set options related to the process execution engine.
Click(Settings) > Engine tab.
라이선스01
No. | Description |
|---|---|
1 | Select whether to allow InputBox and MessageBox activities when running a process. |
2 | Select whether to include the image of the execution result in the report when a process utilizing the Chrome library has been executed. The browser screen will blink during the process execution if you select to include the image in the report. |
3 | Select whether to display the debug log in the output viewer. |
4 | Select whether to close all apps on the screen when the process execution is complete. |
5 | After the process execution, close all apps launched during the process execution by the activity cards that can run apps, such as the OpenApp and OpenBrowser activities. |
6 | Set exceptions for the Clean Up ALL and Clean Up NEW settings by specifying the apps that will not be closed after the process execution. Enter the app (program) name(s) without the file extension (.exe). For example, enter " |
7 | Set the maximum number of the process execution history items (execution results, log files, and the screenshots for the execution results) to be saved in the “History” folder under the base folder. |
8 | Set the maximum number of results for each step, which will be included in the execution report. In the report, most recent results for each executed step will be included. If a process executes an excessively large number of steps, adjust the setting to save the memory and storage required for the report. |
9 | Set the number of full screenshot images to back up before executing each step, regardless of the maximum number of the allowed step results. Screenshots for the steps are saved in the “Screenshot” folder under the execution history log folder for each process. |
10 | Executes the process after receiving packages and execution requests from remote requestors. Activate the plan for Remote Bot Service. |
Add Remote Job Plan
While creating a remote bot service plan for the first time, change the option to use remote bot service to enabled, the Add Remote Job Plan pop-up appears, and you can create a remote plan as shown below.
No. | Description |
|---|---|
1 | Enter the plan name. |
2 | A six-digit connection code to be used to confirm the connection request is automatically generated. Request process execution by inputting the connection code and the request IP address from a remote location. |
System settings
View or change settings related to the Bot system.
Click(Settings) > System tab.
라이선스01
No. | Description |
|---|---|
1 | Set the time to restart the bot. When the set time is reached, wait for no job to be executed, then restart the bot. It helps with bot memory management. |
2 | Select whether to automatically unlock the screen at the start of an automation task. When using, the ID/PW for unlocking the screen must be registered with the orchestrator in advance. |
3 | Select to log on to Windows automatically. It is enabled when using Auto Screen Unlock. |
4 | Select whether to prevent remote and user inputs (mouse and keyboard inputs) while automated processes are executed. |
5 | Set up a list of schedules to exclude from your plan. When there are two or more exception dates, separate them with a semicolon ;(). |
License settings
View information about the currently activated license, deactivate the active license, or initialize the license status.
Click(Settings) > License tab.
라이선스01
No. | Description |
|---|---|
1 | View the currently activated client ID, client name, and license key, license period information. |
2 | If you reset the license, the license setting screen will be displayed so you can enter the license information again, and the license key will be initialized to the unused status on the certification server. You can use this feature to return or transfer the license. |
3 | You can deactivate the license without a server connection. |
Deactivate
1. Click the deactivate button. The "Confirm" message box is displayed.
Deactivation confirm
2. Click Ok. The license is deactivated and the bot is shut down.
Offline Deactivation is only possible for Attended Bots that have been authenticated offline.
Deactivate Offline
Click Deactivate Offline button. The below message box will be displayed.
Attended Bot Deactivation step 2
2. Click OK. The Offline Deactivation pop-up window with a 12-digit deactivation request code is displayed at the top of the pop-up screen. (request code is valid for 5 minutes)
If five minutes have elapsed without deactivation, you can reissue the deactivation request code by clicking the refresh button to the right of the request code.
3. Directly access the site address (www.brityworks.ai/license) or access via QR code to complete the deactivation process.
When accessing www.brityworks.ai/license address: On the web chat screen, the user directly enters the deactivation menu, enters the 12-digit request code, and clicks the request button to complete deactivation.
When accessing with a QR code: Deactivation is completed immediately.
4. Click Ok; after deactivation is completed, the message box below is displayed.
Attended Bot Deactivation step 4
5. Click OK, the bot is shut down, and the deactivated license can be used on another PC.