By going through this chapter, you will understand the Tenant Portal’s features for each menu category, the tasks that an administrator can perform on the Tenant Portal, and how to perform such tasks.
“Using the Tenant Portal” explains the following topics:
Starting the Tenant portal
Monitoring
Managing Users
Managing Tenants
Managing Tenant Users
Managing Data Sources
Viewing Reports
Managing Notices
Managing Licenses
Managing Configurations
Managing API Keys
Starting the Tenant Portal
This part explains the basic procedures you must take before using the Tenant Portal.
“Starting the Tenant Portal Server” explains the following topics:
Browser Requirements
Logging In
Editing Personal Information
Logging Out
Checking Server Status
Browser Requirements
The Tenant Portal is optimized to Chrome browser.
Logging In
You can log into the Tenant Portal by entering the account ID and password on the login page. For your first login, contact the system administrator in advance to issue your account ID and password.
The account information of the main system administrator is provided upon installing the RPA Solution.
To log into the Tenant Portal, complete the following steps:
Go to the login page of Tenant Portal on your web browser. For the exact address of the login page, contact your system administrator.
Enter your account ID and password.
To have your browser remember your account ID for the next login, select the Save ID checkbox.
Click Login.
If you have forgotten your account ID or password, click Find ID/Password.
Find ID
Enter your name and email address to find the account ID you have forgotten.
Find Password
Enter your account ID and email address to find your forgotten password.
When you log in successfully, the main page will be displayed.
2-Factor Authentication
Two-factor authentication is possible according to the server settings (Using Tenant Portal - 10. Manage Settings) option (Administration Policy - 2-Factor Authentication).
Email is provided as the primary authentication method. SMS and KakaoTalk are displayed depending on the settings and whether the mobile phone is authenticated.
The session timeout is set to 30 minutes by default. You can change the set timeout on Tomcat.
To use 2-Factor Authentication, SMTP linkage setting is absolutely necessary.
If you use 2-Factor Authentication when SMTP is not set, you cannot log in.
Editing Personal Information
You can change your personal information, such as name, position, phone number, and password.
To change your personal information, complete the following steps:
Click in the bottom-left corner of the Tenant Portal main page.
Click Personal Info. The “Personal Info” pop-up window will be displayed.
Edit information you want to change.
To change photo click, Change photo, Change Password respectively.
Click Save.
Click OK on the save confirmation pop-up window.
Click OK on the save complete pop-up window.
Your personal information has been updated.
If you do not fill in the mandatory fields indicated with an asterisk (*), a notification pop-up window will be displayed and the changes you have made will not be saved.
Change phone
Depending on the server settings, authentication may be required when entering a mobile phone. (For the setting method, refer to the setting management of the tenant portal)
The input part is deactivated with text showing whether the mobile phone is verified or not.
Mobile phone authentication via SMS is possible.
Messaging Service
To change and manage the Brity RPA messaging service, follow these steps:
Click on the Tenant Portal main page at the bottom left.
Click on Personal Info. The "Personal Info" pop-up window will be displayed.
Click the Update button at the bottom of the details area to display the Edit Personal Info pop-up window.
Click the Change (Messaging Service) button. The Change Messaging Service pop-up window is displayed.
No. | Description |
---|---|
1 | Check whether you are using the messaging service (e-mail). When checked, the right threshold field is activated. |
2 | Enter the threshold for receiving notification emails. |
3 | Click Save. |
4 | A tooltip displays the general situation based on the usage rate of each resource. (e.g. Less than 70% Moderate Level / 70% Warning Level or More / 90% or More Risk Level) |
API Key Management
Follow the below steps to manage the API Key for authentication when calling Brity RPA OpenAPI.
Click in the bottom-left corner of the Tenant Portal main page
Click Personal Info. The "Personal Info." pop-up window is displayed.
Click on the API Key tab, the API Key of the currently connected user is displayed in the form of a card list.
You can edit API Key information by clicking the edit button at the bottom of the details area . For more information on how to configure and use the API Key edit pop-up , refer to Managing API Keys
You can add API Key information by clicking the '+ Add API Key' card at the bottom of the card list. For configuration and usage of the Add API Key pop-up , refer to Adding API Key.
No. | Description |
---|---|
1 | Click on the API Key card to display the API Key details area. |
2 | Edit API Key pop-up is displayed. |
3 | Add API Key pop-up is displayed. |
For more information on API Keys, see Managing API Keys
Logging Out
Click > Logout in the bottom-left corner of the Tenant Portal main page.
Checking Server Status
You can have an overview of memory and CPU status of all currently running servers. These status are classified and expressed by each certificate name for service modules. Dashboard cards included in each classification indicate individual server nodes; the time the service module was uploaded on the node and the service access address (IP and Port) are displayed along with the nodes.
Click > About in the bottom-left corner of the Tenant Portal main page.
No. | Description |
---|---|
1 | Except for the OCR server, clicking on it will take you to the "Monitor Server" menu. The server you click in the "Server Monitoring" menu is automatically selected. |
Through dashboard cards that are running service modules, you can briefly check on server redundancy configuration.
Monitoring
You can monitor the operating status of the RPA solution by tenant on the Tenant Portal main page. Through monitoring, you can check the execution status of jobs and bots by tenant, check bot operation rate, and find errors. By performing such tasks, you can increase the efficiency of work automation. Click in the top-left corner of the screen to enter the Tenant Portal main page.
No. | Description |
---|---|
1 | Displays the total number of registered users. |
2 | Displays the total number of registered tenants. |
3 | Displays the number of jobs executed in a week. |
4 | Displays the total number of registered bots. |
5 | Displays the job operating status by date. |
6 | Displays the job operating status by tenant. |
7 | Displays the top 5 tenants from the highest success rate. |
8 | Displays the top 5 tenants from the most job execution cases. |
9 | Displays the top 5 bots from the longest operation time. |
10 | Displays the bottom 5 tenants from the lowest success rates. |
11 | Displays the bottom 5 tenants from the least job execution cases. |
12 | Displays the bottom 5 bots from the shortest operation time. |
Moving to Admin Portal Tenant
The Tenant Portal main page displays tenant-specific statistics.
Clicking on the name of the target tenant shows statistical information that may represent administrators, users of the tenant and displays the license information of the currently connected users of the tenant.
If you click the Move Tenant button, you can access and use the tenant in the Admin Portal based on the currently accessed user in a new browser tab.
Tenant move function is performed based on Tenant Portal access users. Therefore, even if you are logged in as a different user in the Admin Portal, the login information is changed based on the user connected to the Tenant Portal when you move a tenant.
Managing Users
You can manage RPA Solution users by registering users, searching users, editing user information, and deleting user information.
"Managing Users” explains the following topics:
Registering Users
Searching Users
Editing User Information
Deleting Users
Mapping User Tenants
Click Tenant User on the Tenant Portal main page.
Tenant User management screen
You can check the list of the RPA solution users, and click a user to edit the user information. You can also assign a registered user as a tenant administrator, or remove from assigned administrators.
No. | Description |
---|---|
1 | Set search conditions. |
2 | Reset the search conditions. |
3 | Search users that match the set conditions. |
4 | Add a user. |
5 | Delete the selected user. |
6 | Assign a tenant to the selected user. |
7 | Displays the list of users. |
8 | Download the list as an Excel file. (Depending on the environment setting, a pop-up for entering the reason for the download is displayed, and you can download the file after entering the reason.) |
Registering Users
Users must first be registered to use RPA Solution.
To register a user, complete the following steps:
Click Tenant User > Add. The “Add User” pop-up window will be displayed.
Enter the user information.
Click Save.
Click OK on the save confirmation pop-up window.
Click OK on the save complete pop-up window.
The new user has been added.
If the administrator registers the user directly, the consent of the registered user to collect personal information must be obtained.
Searching Users
You can enter conditions and search users. To search a user, complete the following steps:
Click Tenant User
Enter search conditions.
No. | Description |
---|---|
1 | Enter the user ID. |
2 | Enter the user’s email address. |
3 | Enter the name of the user. |
4 | Select whether or not to authenticate the user's phone verification. |
5 | Enter the company of the user. |
6 | Enter the department of the user. |
Click Search.
Users that match the set conditions are displayed. To reset the search conditions, click Reset. To check details about each user, click the ID of a user in the list.
Editing User Information
You can edit each user’s information and set permissions. To edit a user’s information or set permissions, complete the following steps:
Click Tenant User.
Click the ID of the user you want to edit.
Edit the user’s information and set permissions on the pop-up window, and then click Save.
If you want to assign the user to a tenant administrator, select the Tenant Admin checkbox.
Click OK on the save confirmation pop-up window.
Click OK on the save complete pop-up window.
The user information has been edited.
Deleting Users
You can delete users from the Tenant Portal. To delete a user, complete the following steps:
Click Tenant User
Find the user you want to delete, and then select the checkbox next to the user’s name.
If Chatbot is connected with the portal, BRITY_ECO_SERVER account will appear on the list. Do not delete this account as it is needed to connect with the chat bot.
Click Delete.
Click OK on the delete confirmation pop-up window.
Click OK on the delete complete pop-up window.
The user has been deleted from the Tenant Portal.
Mapping User Tenants
You can map a tenant with a user, and manage the mapping by user. To map a tenant, complete the following steps:
Click Tenant User.
Select the checkbox for the user you want to map, and then click Map Tenant. The “Map Tenant” pop-up window will be displayed.
Select the checkbox for the tenant you want to map in the Unmapped Tenants list, and then click ↑ Add.
Check if the tenant was added to the Mapped Tenants list.
Click Save.
Click OK on the save confirmation pop-up window.
Click OK on the save confirmation pop-up window.
The tenant has been mapped with the user.
Managing Tenants
You can manage RPA Solution users by registering tenants, searching tenants, and editing tenant information.
“Managing Tenants” explains the following topics:
Registering Tenants
Searching Tenants
Editing Tenant Information
Click Tenant on the Tenant Portal main page.
Tenant management screen
You can check the list of the RPA solution tenants, and edit their information by clicking on their name. You can also manage users by tenant.
No. | Description |
---|---|
1 | Enter the Name, Prefix, Data Source, and Manager of the tenant you want to search. |
2 | Reset the search conditions. |
3 | Search tenants that match the set conditions. |
4 | Add a tenant. |
5 | Map users with tenants. |
6 | Manage the sequence of tenants. |
7 | Displays the list of tenants. |
Drag & Drop is available for changing tenant sequence. Drag a tenant from its original row and drop it on the row you want.
Registering Tenants
You can add new tenants. To add a tenant, complete the following steps:
Click Tenant > Add. The “Add Tenant” pop-up window will be displayed.
Enter the tenant information.
Click Save.
Click OK on the save complete pop-up window.
Click OK on the save complete pop-up window .
The new tenant has been added.
Searching Tenants
You can enter conditions and search tenants. To search a tenant, complete the following steps:
Click Tenant
Enter search conditions.
Click Search.
Tenants that match the set conditions are displayed. To reset the search conditions, click Reset. For details about each tenant, click the name of a tenant in the list.
Editing Tenant Information
You can edit each tenant’s information. To edit tenant information, complete the following steps:
Click Tenant
Click the name of the tenant to edit in the list. The “Edit Tenant” pop-up window will be displayed.
Edit the tenant information.
Click Save.
5. Click OK on the save Confirmation pop-up window. 6. Click OK on the save Complete pop-up window.
The tenant information has been edited.
Managing Tenant Users
You can manage users included in each tenant by adding, searching, and deleting them within each tenant.
"Managing Tenant Users” explains the following topics:
Adding Tenant Users
Searching Tenant Users
Deleting Tenant Users
Tenant management screen(“Map User” screen)
You can search and manage users by tenant.
Click Tenant on the Tenant Portal main page.
Select the tenant of the users you want to change, and then click Map User.
Add, search, or delete tenant users on the “Map User” pop-up window.
No. | Description |
---|---|
1 | Displays the list of tenant users. |
2 | Displays the list of users that can be added to the tenant. |
3 | Search users that match the search conditions among the tenant users. |
4 | Search users that match the search conditions among the addable users. |
5 | Add the selected tenant user to the Tenant Users list. |
6 | Delete the selected tenant user from the Tenant Users list and move it to Addable Users list. |
Adding Tenant Users
You can add users to tenants. To add a user to a tenant, complete the following steps:
Click Tenant.
Select the tenant to which you want to add the user, and then click Map User.
Select the checkbox for the user you want to add in the Addable Users list.
Click < Add.
Click OK on the add confirmation pop-up window.
Click OK on the addition complete pop-up window.
The selected user has been added to the tenant.
Searching Tenant Users
You can enter conditions and search users within the selected tenant. To search a user within the selected tenant, complete the following steps:
Click Tenant.
Select the tenant you want to search users within, and then click Map User.
Enter search conditions in the search bar above the Addable Users list or the Tenant Users list. You can search by ID, name, and department.
Press Enter, or click in the search bar.
Tenant users that match the condition you have entered will be displayed.
Deleting Tenant Users
You can delete users from tenants. To delete a user from a tenant, complete the following steps:
Click Tenant.
Select the tenant you want to delete the user from, and then click Map User.
Select the checkbox for the user you want to delete from the Tenant Users list.
Click Delete >.
Click OK on the delete confirmation pop-up window.
Click OK in the delete complete pop-up window.
The selected user has been deleted from the tenant.
Managing Data Sources
You can manage the data sources to use for tenants.
“Managing Data Sources” explains the following topics:
Adding Data Sources
Searching Data Sources
Click Data Source on the Tenant Portal main page.
Data Source management screen
You can check the details of each data source by clicking one on the list, and add new data sources.
No. | Description |
---|---|
1 | Enter the name of the data source to search. |
2 | Reset the search conditions. |
3 | Search data sources that match the set conditions. |
4 | Add a data source. |
5 | Displays the list of data sources. |
Adding Data Sources
You can add new data sources. To add a new data source, complete the following steps:
Click Data Source > Add. The “Add Data Source” pop-up window will be displayed.
Enter the data source information.
If you want to test the data source, click Connect.
Click Save.
Click OK on the save confirmation pop-up window.
Click OK on the save complete pop-up window.
The new data source has been added.
If you are adding a data source by adding a physical DB, you must restart the system Tomcat.
Searching Data Sources
You can search data sources by name. To search a data source, complete the following steps:
Click Data Source.
Enter the name of the data source to search.
Click Search.
Data sources that match the name are displayed. To reset the search conditions, click Reset. For details about each data source. click the name of a data source in the list.
Viewing Reports
You can check the job execution and bot operation status in reports, and download them as Excel files.
Click Report on the Tenant Portal main page.
Checking job status by tenant
You can check the job execution status by tenant.
Click Report > Job Status By Tenant.
No. | Description |
---|---|
1 | Enter the name of the tenant to search. |
2 | Set a search period. |
3 | Reset the search conditions. |
4 | Search tenants and their job execution status that match the set conditions. |
5 | Refreshes job status data by tenant. |
6 | Download the job execution status by tenant as an Excel file. |
7 | Displays job execution status by tenant in a list. |
Checking job status by bot
You can check the job execution status by bot.
Click Report > Job Status By Bot.
No. | Description |
---|---|
1 | Enter the name of the tenant to search. |
2 | Enter the name of the bot to search. |
3 | Set a search period. |
4 | Reset the search conditions. |
5 | Search bots and their the job execution status that match the set conditions. |
6 | Refreshes job status data by bot. |
7 | Download the job execution status by bot as an Excel file. |
8 | Displays job execution status by bot in a list. |
Managing Notices
You can manage notices. Registered notices will be displayed in pop-up windows when users log in to RPA Designer.
“Managing Notices” explains the following topics:
Registering Notices
Searching Notices
Deleting Notices
Click Notice on the Tenant Portal main page.
Notice management screen
You can add new notices, and check the details of each notice by clicking one on the list.
No. | Description |
---|---|
1 | Set search conditions. |
2 | Reset the search conditions. |
3 | Search notices that match the set conditions. |
4 | Add a notice. |
5 | Delete the selected notice. |
6 | Displays the list of notices. |
Registering Notices
You can register new notices. To register a new notice, complete the following steps:
Click Notice > Add. The “Add Notice” pop-up window will be displayed.
Select the type of content to be entered (plain/HTML).
For Normal type, enter the content as text.
For HTML type, use the function at the top of the editor to enter the content in HTML
Click Save.
No. | Description |
---|---|
1 | Select the content type. |
2 | If you select the Normal type, enter only text. |
3 | If you select the HTML type, use the HTML editor's header functions to enter the content in HTML format. |
Click OK on the save confirmation pop-up window.
Click OK on the save complete pop-up window.
The new notice has been registered.
Searching Notices
You can enter conditions and search notices. To search a notice, complete the following steps:
Click Notice.
Enter search conditions.
Click Search.
Notices that match the set conditions are displayed. To reset the search conditions, click Reset. For details about each notice, click the name of a notice in the list.
Deleting Notices
You can delete notices. To delete a notice, complete the following steps:
Click Notice.
Select the checkbox for the notice you want to delete.
Click Delete.
Click OK on the delete confirmation pop-up window.
Click OK in the delete complete pop-up window.
The selected notice has been deleted.
Managing Licenses
Administrators can manage licenses for RPA Designer (including Stand-alone Designer), RPA Bot (including Attended Bot) that are applied throughout the system. The license is granted one for each RPA Designer and RPA Bot, and the license is entered and activated by the client.
The supported license types are as follows. The Attended Bot / Stand-alone Designer (including Lite) license type that can be used without a server connection is not supported by the on-premise license.
All license types (as of v2.5.0): Bot / Designer / Designer Lite / Attended Bot / Stand-alone Designer / Stand-alone Designer Lite
On-premise support license type (based on v2.5.0): Bot / Designer / Designer Lite
“Managing Licenses” explains the following topics:
Applying Licenses
Using Licenses
Attended Bot/Stand-alone Designer (including Lite) operates in a local PC environment without direct communication with the server when the first license authentication is completed. Thus, the Attended bot information can only be viewed on the authentication-related page of Tenant Portal, such as license management, certificate/token, etc. And it is not retrieved with relevant client information from menus such as “Bot/Job Monitoring”, “Group Auth Mgmt.”, etc.
License List screen
You can check the list of licenses, view the license information, and initialize licenses. Click License > License List.
No. | Description |
---|---|
1 | The total quantity and remaining quantity by license type. Bot(including Attended Bot) and Designer license type currently applied. |
2 | Displays the “License information” pop-up window. You can view the license information, and enter description. : If it displays on the right side of the license key, it means a trial license. |
3 | Download the license list as an Excel file. |
4 | Initialize the selected license. Only available when the license is activated. |
5 | Displays Client ID. : If it displays on the right side of the client id, it means that offline activation has been performed. |
6 | Search for licenses with all, normal or expired terms by selecting them in the options below. |
The activation date and time is the last time the activation was performed, and in the case of the end use date and time of token issuance, it is displayed only for clients that are activated online and can communicate with the server.
Information is not displayed if it is operated in an environment where communication with the Attended Bot/Stand-alone Designer and server is not enabled in an offline environment.
Quantity information for each Bot / Designer is aggregated as a total for each license type as a large classification unit as shown below. (As of v2.5.0)
1. On-premise type
Bot : Bot
Designer : Designer + Designer Lite
2. SaaS-type
Bot : Bot + Attended Bot
Designer : Designer + Designer Lite + Stand-alone Designer + Stand-alone Designer Lite
Applying Licenses
You can upload and apply the license files you have received upon Brity RPA license purchase. The identifier of the license to be applied must include identifiers for all operating Brity RPA servers. If you are running RPA Solution under a multi-server environment, make sure the license contains all identifiers for currently operating RPA servers when you receive it.
Upon applying the license, the number of client licenses displayed on the portal will be updated accordingly.
To register a license, complete the following steps:
Click License > License List or License > Tenant License Setting.
Click Apply license. The “Apply license” pop-up window will be displayed.
No. | Description |
---|---|
1 | A button for selecting and uploading a license file issued. |
2 | A list of uploaded licenses is displayed. |
3 | Displays the application status by license that is uploaded. After uploading the license you have issued, you can apply it by clicking on the license that is "UNAPPLIED". |
4 | Indicates the identifier information of the server verified through the current request. |
Click Select File and select the license file you have received.
Click Upload.
Click OK on the upload confirmation pop-up window. Once upload is complete, the license will be added to the list below, and the uploaded license will display UNAPPLIED under the Applied result column.
Click UNAPPLIED under the Applied result.
Click OK on the apply confirmation pop-up window.
The license has been applied.
If two or more MAC addresses exist on the system, make sure you check the MAC address of the network card you are currently using and then receive the license accordingly. Deactivated or disused MAC addresses may cause the license to not work properly on the system.
Using Licenses
You can manage the licenses for all clients that are registered on the system. License keys that have not been assigned to tenants cannot be activated. Click License > Tenant License Settings.
No. | Description |
---|---|
1 | Displays the status and number of all licenses applied to the system. |
2 | Displays tenant specific Bot (including Attended Bot)/Designer license assignment information in card form. |
3 | It means the following quantity by item. All : Displays the total number of licenses that are assigned to the tenant. Register : Displays the number of licenses currently activated and being used by RPA Solution users within the tenant. Remaining : Displays the number of licenses that have been assigned to the tenant but have not yet been activated on PCs. |
4 | Displays the whether the tenant is in use. (Used/Unused) |
5 | Display the "Tenant license settings” pop-up window. You can assign licenses to the tenant. |
※ License keys assigned to Unused tenants cannot be used; in such case, you need to initialize the licenses and assign them to other tenants.
Quantity information for each Bot / Designer is aggregated as a total for each license type as a large classification unit as shown below.
(As of v2.5.0)
Bot : Bot + Attended Bot
Designer : Designer + Designer Lite + Stand-alone Designer + Stand-alone Designer Lite
Assigning Tenant Licenses
Client license keys must be assigned to the tenants in order to be used. To assign a license key to a tenant, complete the following steps:
Click License > Tenant License Setting.
Find the card of the tenant to which you want to assign the license, and then click . The “Tenant license settings” pop-up window will be displayed.
No. | Description |
---|---|
1 | Displays licenses that are assigned to the tenant but have not yet been activated. |
2 | Displays licenses that are applied to the system but have not yet been assigned to any tenants. |
3 | Assign the selected license to the tenant by adding it to the list on the left. |
4 | Remove the selected license from the tenant by moving it to the list on the right. |
5 | Initialize activated licenses in the tenant. Once initialized, the licenses will appear in the remaining license list on the left. |
6 | Search for licenses with all, normal or expired terms by selecting them in the options below. |
Activated licenses are not displayed in the remaining license list. To assign a license to a different tenant, you need to initialize each specific license in the License > License List menu, or initialize all activated licenses in the tenant by clicking License Initialization.
Select the checkbox for the license you want to assign in the Unmapped licenses list, and then click < Add. The license will be added to the remaining license list on the left.
If you want to remove the license from the tenant, select the checkbox for the license you want to remove in the remaining license list, and then click Release >.
Click OK on the add confirmation pop-up window.
Click OKon the addition complete pop-up window.
The license has been assigned to the tenant.
Activating or Initializing Licenses
Activating Client Licenses
When the client enters the license key, the server performs activation processing, at which time the client checks the license type and then performs subsequent actions (requesting issuance of certificates and authentication tokens as a result of activation). However, in the case of the Attended Bot/Stand-alone Designer, it does not import the resource by requesting the API to the server when the actual automation process is executed after issuing the certificate through activation. After the authentication token is issued, the client can update the PC environment information according to its own policy and check the license activation status and validity.
Initializing Client Licenses
To change the PC you want to use or initialize client information, you must initialize an enabled RPA Bot/Designer or Attended Bot/Stand-alone Designer license. You can perform license initialization through Tenant Portal and direct deactivation requests from clients. If the tenant is deleted while the client is active after the tenant has been assigned a license, the assigned license is initialized on the server. However, for Attended Bot/Stand-alone Designer that supports offline mode, the server does not support the initialization function and a deactivation request must be made directly through the client. Since the Attended Bot/Stand-alone Designer is not managed by privilege, it is handled without special verification when requesting deactivation from the client.
• Initialize the license only if necessary.
• RPA Designer (including Stand-alone Designer), and RPA Bot (including Attended Bot) can be enabled and used on only one PC with one license.
• Initializing the license changes the license and client information of the corresponding RPA Designer (including Stand-alone Designer) or RPA Bot (including Attended Bot) to an unused state. Activation and enrollment operations must be performed again to reuse.
• To use an offline activated license on another PC, you must initialize the license by entering information according to the normal deactivation procedure before it can be used again. For example, suppose deactivation is not successfully processed on the server. In that case, it cannot be used on other PCs, and the license must be activated again on the PC where the license was used before proceeding with the deactivation procedure.
License Expiry Information
Check the information about the expiration date of the applicable license
Based on the license applied to the current server, if there is a license that expires within 30 days based on the license period of the Orchestrator solution or individual Bot / Designer, the red color at the top of the menu title reads, "You have a license that expires in n days." A message is displayed. Click on the text, and you will see a popup with license expiration information, as shown below.
The following information is provided for each Orchestrator solution license period and Bot / Designer (including Lite) so that you can respond before the license expires by providing the information about the expire license. For example, "M cases out of n cases (within seven days: o cases, within 30 days: p cases) will expire."
License expiration information is provided based on the total quantity currently applied in the Tenant Portal, and information is provided based on the connected tenant in the Admin Portal.
As a result, the Tenant Portal may show expiration information. Still, the Admin Portal does not display expiration information because there are no licenses due to expire in a specific tenant.
Managing Configurations
You can check and manage the configurations needed for RPA Solution operation. Click Configuration mgmt. on the Tenant Portal main page.
No. | Description |
---|---|
1 | Search specific configuration. |
2 | Displays categories settings. Click a specific category, and the setting items included in the category are displayed on the right. |
3 | Display the “Edit configuration” pop-up window. Changes made on the pop-up window are reflected immediately without requiring a service restart. |
4 | Conduct a test run with the new configurations before you move on to edit the associated information for mail transfer. |
5 | Download the configuration as an Excel file. |
Settings management items
Through setting management, it is possible to set up processes, bot monitoring, and linkages.
Main Category | Item | Description |
---|---|---|
Process | Prevent Project Approval Reversal | When approving a project (process flow), if there is an unapproved version among the previous versions, it cannot be approved. |
Project creation limits | Only administrators can create and delete v1.00 projects. The created v1.00 project will be registered with an approved status. | |
maximum running time of the process | Maximum execution time of the process if no timeout is set (unit: seconds, range: 1-999,999) | |
Project auto-approval | It automatically approves the exported project from the designer. | |
Automatic approval of process flows | It automatically approves the process flow exported by the designer. | |
Bot Monitoring | Activate remote function | Activate the remote control function of bot monitoring. |
Activate the screen sharing function | Activate the screen sharing function of bot monitoring. | |
SMTP server address | SMTP server address for mail connection. | |
Representative email address password | This is the password of the representative e-mail address for connection. | |
SMTP server port | SMTP server port for mail connection. | |
SMTP AUTH for mail association | SMTP auth for mail connection. Attempts to authenticate the user using the AUTH command. | |
SMTP SSL for mail linkage | Set to use SSL to connect to the SSL port by default when linking mail. | |
SMTP STARTTLE ENABLES for mail association | In SMTP for mail chaining, enable TLS if the server supports STARTTLS. | |
SMTP STARTTLS REQUIRED for mail association | Make sure to use STARTTLS in SMTP for mail linkage. If the server does not support it, the connection will fail. | |
Representative email address | This is the representative e-mail address for connection. | |
Push | KakaoTalk (Alimtalk) Service | Activate the Kakao Notification Talk service. |
KakaoTalk(Alimtalk) API Client ID | This is the Client ID for Kakao Notification Talk. | |
KakaoTalk(Alimtalk) API Client Password | This is the client password for Kakao Alert Talk. | |
KakaoTalk(Alimtalk) API Sender Key | This is the Sender Key for Kakao Notification Talk. Only pre-registered keys can be used. | |
SMS | SMS Service | Activate the SMS service. |
SMS API Client ID | Client ID for SMS connection. | |
SMS API Client Password | This is the client password for SMS connection. | |
SMS API Sender Number | This is the calling number for SMS connection. Only pre-registered numbers can be used. | |
Resource | Resource registration status | Allows all users to see the full resource registration status. |
Scheduler | Waitable Maximum Processflow Job | Maximum number of ProcessFlow Jobs that can exist in a queued state per tenant. If ProcessFlow startup is delayed, limit the maximum number of waitable ProcessFlow Jobs to a number appropriate to the setpoint. (Unit: case, range: 1-9,999) |
Waitable Maximum Processflow Callprocess Job | Maximum number of CallProcess Jobs requested by ProcessFlow that can exist in a waiting state per tenant. In a situation where waiting jobs are created indiscriminately due to an incorrectly called CallProcess condition, the maximum number of waiting process jobs is limited to an appropriate number for the set value. (Unit: case, range: 1-9,999) | |
Maximum waiting job | The maximum number of Process Jobs that can exist in a waiting state per tenant. In a situation where waiting jobs are created indiscriminately due to an incorrectly called CallProcess condition, the maximum number of waiting process jobs is limited to an appropriate number for the set value. (Unit: case, range: 1-9,999) | |
Enabling Job Parameter Security Settings | You can set security options for individual parameters when setting up a scheduled job and executing a job. After you apply the security option to a parameter, the information will not be visible in the portal afterwards. | |
Job Parameter Security Setting Target String | Register the job parameter security setting target string in advance. Based on the input string, the security option of the parameter corresponding to the condition when executing a new scheduled job or job is set to enabled by default, and the user can change it again.(In case of multiple input, enter including the delimiter ;. For example, enter a and b as a;b when registering. The symbol < > & cannot be saved.) | |
Based on scheduled task end date notification | Set the number of days based on the scheduled task end date notification date. The information of the scheduled task that corresponds to the end date of the registered scheduled task as of the current day is sent to the user who has set the messaging service. It will be sent once per scheduled task, and if the end date of the reservation task changes, it will be sent again if the conditions are met. If you do not want to set it, please enter 0. (Unit: Day, Range: 0-999) | |
OCR | OCR function | Activate the OCR function (template management, character recognition, category management) for each tenant. |
Management Policy | Auto filling batch cycle | Set the cycle of pattern analysis service. It analyzes the processes according to the set cycle and saves the pattern. If you do not want to set it, please enter 0. (Unit: Days, Range: 0-9,999) |
Number of auto filling pattern creations | Set the number of patterns to be generated at one time through pattern analysis. (Unit: cases, range: 0-9,999) | |
2-Factor Certification | Enable two-step verification. | |
Allow user password deferral | You can set the password change to be deferred when the user's status changes to Password Change Required status. If you postpone the password change, the password change time is changed to the time of the postponement, and the password change pop-up will be displayed again in the next password change cycle. If the password change cycle is not set, the value is a meaningless setting value, and even if the setting is changed during operation, the already processed user status is not changed. | |
User password change cycle | Set the user password change interval. Change the user's status to Password Change Required status by checking the user's last password change time according to the set cycle. If you do not want to set it, please enter 0. Even if the setting is changed during operation, the already processed user status is not changed. (Unit: Days, Range: 0-9,999) | |
ETC | Upload file extensions | Set the uploadable file extension. Only uppercase/lowercase letters and numbers (e.g. txt, DOC, mp4) can be entered, separated by ','. |
Email/push messaging service | Activate the messaging service (e-mail, push, etc.). | |
Portal URL | Defines the portal URL used for the Alarm function. | |
Sever Monitoring Alarm Cycle | Define the period between receiving a tenant portal alarm email and receiving the next email. | |
Tenant Portal Messaging Service Mail Sending Conditions (Number of Alerts) | If you set up a tenant portal messaging service condition, define how many times the condition occurs before sending an alarm email. |
Managing API Keys
To call OpenAPI provided by Brity RPA, an authentication token is required, and when called, it operates with the privileges of the user-tenant specified in the authentication token. These authentication tokens are managed in units of API Key, and the tenant administrator can manage the API Key status and status and check the API request history.
"Managing API Keys" explains the following topic:
Managing API Keys
Checking API request history
An individual user's API Key can also be checked in Personal Information Management - API Key.
However, history information of making API requests using the API Key is provided only in the tenant portal.
API Key Management page
You can check the list of API keys, add an API key, check details, or disable status. Click API Key > API Key Mgmt.
No. | Description |
---|---|
1 | Displays the quantity of currently issued API Keys by status and information about to expire within 30 days. |
2 | Click the "Add" pop-up window. You can add a new API Key by entering your User ID, Tenant, Expiration Date, and Description. |
3 | Download the API Key list as an Excel file. |
4 | Displays the “Modify API Key” pop-up window; you can view the information of the API Key, edit the description, or change the status.※. If the API Key is deactivated, it cannot be returned to the valid state. |
5 | Displays the Request Count pop-up; you can view the number of requests and the date and time of the first/last request. If there is a request history, the "Go to Request History" button will be displayed, and click on it to view the API request history requested with the API Key in a new browser window. |
The status of the API key is valid, expired, or disabled, and only when it is valid, the API key can be used commonly.
Valid: The API Key is available.
Expiration: The API Key cannot be used because the set expiration date is earlier than the current one.
Disabled: The API Key is disabled by the user so that it cannot be used.
In the event of tenant non-use/deletion, user deletion/tenant mapping release event, the API key issued to the tenant or user information is deactivated after a certain period. As a result, it cannot be used, and the reason for deactivation is reflected as follows.
Tenant not used: TENANT_UNUSED
Unmapping user-tenant: USER_TENANT_UNMAPPED
Delete User: USER_DELETED
Adding API Key
Add an API Key that will be used to make OpenAPI requests to the Brity RPA server.
To add an API Key, follow the below steps.
1. Click API Key > API Key Mgmt. . 2. Click Add . The "Add API Key" pop-up window will appear.
No. | Description |
---|---|
1 | Enter the API Key issuance information. Works with the entered user tenants permission and is not added if the user is not mapped to a tenant. Also, API Key cannot be used after the set token expiration date. |
2 | The maximum number of days that can be set from the date of issue is displayed. The default is 365 days When setting the API Key expiration date. And you can change the number of days by changing the server's properties. Server properties can be found in the Brity RPA installation manual application/comm. properties Description of each property value |
3 | Save an API Key based on the information you entered. |
3. Enter the user, tenant, token expiration date, and description to issue the API key. 4. Click Save .
Managing API Key Information
View the information of the API Key that will be used to make OpenAPI requests to the Brity RPA server, and change the description or status.
To view and manage API Key information, follow the below steps.
Click API Key > API Key Mgmt. .
Clickthe API Key ID data of the API Key found in the list . The "Edit API Key" pop-up window will appear.
No. | Description |
---|---|
1 | If the status of the API Key is valid, the API Key is displayed. Copy: Copy the API Key string. The API Key string is a long string and the entire value is not visible on the screen, so click the Copy button to save it to the clipboard and paste it where you need it. Verification: Checks whether the API Key can be actually authenticated. If you click the Validate button, the API Key is requested for authentication and the result is notified. |
2 | You can change the status to Disabled to disable the API Key. If you click the checkbox, an input window is displayed at the bottom for the deactivation of the API key, and enter the reason for deactivation. |
3 | Save the API Key based on the information you entered. |
3. Enter information to view API Key information and edit the description, or to disable status. 4. Click Save .
API Key information is modified.
When an API Key is deactivated, the API Key becomes unusable and cannot be changed back to valid.
Also, the information displayed in the API Key information area varies depending on the status of the API Key.
Valid: API Key is displayed, and deactivation can be performed.
Expires: No display other than status.
Deactivation: The date and time of deactivation and reason are displayed.
Checking API request history
You can use the API Key to check the history of making API requests to the Brity RPA server.
API request history page
Click API Key > API Request History .
No. | Description |
---|---|
1 | Displays the quantity of currently issued API Keys by status and information about to expire within 30 days. |
2 | Download the API Key list as an Excel file. |
3 | Displays the API Key Pop-up window and the API Key's user ID, tenant, and expiration date. In addition, if you click the "Search by API Key" button, the history is searched for the corresponding API Key as a search condition. Further, if you click the "Go to API Key" button, the "Modify API Key" pop-up screen is displayed. |
The API request history is deleted after a certain period of time, and the default value is 60 days.
You can change the number of days to delete history by changing the server's properties.
Server properties can be found in application/comm. properties Description of each property value
Monitoring Server
You can view the list of currently operating servers and the resource status of each server and download it in Excel through the server monitoring screen.
Click on the Server Monitoring menu through the menu on the left.
The list on the left shows the list of servers that are currently in operation.
Click the server you want to view in detail.
The calendar at the top of each chart displays data for the selected time period.
You can download the data to Excel by clicking the Download button.
No. | Description |
---|---|
1 | A list of servers that are currently connected is displayed. The number of servers searched is displayed as N in the "Server List (N)" at the top. When you click on the server, details are displayed in the right area. |
2 | The details of the server selected from the server list on the left are displayed. The server settings of the information set during server operation (max memory, idle, etc.) are also displayed. |
3 | By modifying the calendar date, you can change the chart at the bottom and the search period of the data when downloading Excel. You can specify a date from 3 months to the present |
4 | It charts the data for that resource for the selected period in the calendar. You can check the max value and usage through the chart tooltip for memory, CPU, and disk that display utilisation. If no data was collected during the lookup period, the date will not be displayed in the chart. |
5 | Download the retrieved information as an Excel file. |
If you click a specific server in the About menu to move it, the selected server is automatically selected.