Step Recorder

The Step Recorder is a tool that helps field employees conveniently make process automation requests to developers.
The time required for an RPA developer to fully understand the tasks of the person in charge can be drastically reduced through the step recorder. In addition, by recording the operation of the PC, the work process can be recorded and used as work design data.

After running the Step Recorder, a video recording file, recording project and an recorded event file are created.
Developers can view the work processes by referring to the two files and developing automated processes.

Taking advantage of the Step Recorder, field employees can minimize the time for documenting their requests, and RPA developers can reduce the time it takes to understand the work processes.

To reduce the time it takes to design automated processes by utilizing Step Recorder, complete the following steps:
1 Recording the work process 
2 Referencing video files (Utilizing the Sync function)
3 Viewing the recorded event file
4 Real-time automatic correction after converting recorded events into processes

Recording the work process

Create a scenario of the user’s actions by clicking the step recording button. You can record actions, such as mouse-click, right-click, double-click, and keyboard input actions.

To design a project with a step recording function, complete the following steps:

1. Access the C:\Users\UserName\AppData\Roaming\Brity RPA Designer folder in File Browser and double-click the BrityRPA_Recorder.exe file to run Step Recorder.

2. When Step Recording starts, use the recording menu that appears at the top of your PC screen to record your business actions.

You can configure recording settings before starting recording.

3. You can check the recording result in the recording folder under the default project path when the recording is finished.
4. C:\Users\사용자명\Documents\Brity RPA Recorder ProjectsUnder the folder 'RecordedPrj_(Year Month Date Hour Minute Second)'\RecorderData

Open recorded project file

1. On File Explorer, open the project file of "RecordedPrj_(Year Month Day Time Hour Minute Second)" folder under the C:\Users\UserName\Documents\Brity RPA Recorder Projects  through Brity RPA Designer.

2. Double-click the Record to open the tab and to check the recorded steps.

Referencing video files (Utilizing the Sync feature)

You can open and check the recorded video file to check the action of the actual user.
Not only can the recorded video be played back, but you can check which step it is mapped to through the Sync function.

To utilize the Sync feature, complete the following steps:

1. With the Record process tab open , click the Run button.

2. In the Select Execution Type pop-up window, Click Play Record.

• The recorded video is played, and activities mapped to it are highlighted.

• Stop the video, and click the step in the designer. The video is moved to the point where the action is recorded and played.

Converting a Record process to a normal process

The Record process is not a process that is directly used in actual automation work.
Therefore, it can only be used for automation when converted into a general process based on the recording process.
The designer completes the process by calibrating the target object in real time while executing the process created by the Record process.
To use Convert to Normal Process, complete the following steps.

1. With the Record process tab open , click the Run button .

2. In the Select Execution Type pop-up window, Click Create Process.

3. In the process creation pop-up window, enter the name of the process to be created and click the Create button.

4. Double-click the created process in the Project View to open the tab.

5. With the Created Processes tab open , click the Run button .

The designer performs automatic correction if the recorded data and target are different during the scenario.

Debugging

If problems occur while running a scenario, you can switch to debugging mode to view the execution status, such as the variable values, at the process stop in the debugging console.

Adding a break point

You can add a break point in the following ways:

① Select an activity card and press F9.
② Right-click the activity card and click Add BreakPoint in the context menu.

After adding a breakpoint, the added breakpoint is indicated with a red line on the left border of the activity.
When you run a flow chart, the execution will stop at the place where the breaking points have been set. And in the bottom-right area of the canvas, the Debug - CallStack, Debug - Variables, and Debug - Command Window tabs will be displayed next to the Log tab.

Utilizing the debugging console

You can enter a variable name in the input field of the Debug - Command Window tab and press Enter or click Execute to display the value of the variable at the break point. You can also change the value of the variable in the Debug - Command Window tab.

Running process sections

You can efficiently debug the processes in the flow chart by running them by sections.

Custom library

You can utilize the custom library feature to define a user library in the project, or import an external library and use it like an internal library.

Creating a custom library

1. In the Project window, right-click CUSTOM LIBRARIES and click New Custom Library.

2. In the "New Custom Library" pop-up window, specify the library type and enter description, and then click OK.

Library types

Creating a JavaScript library

Procedures for creating a JavaScript library

To create and utilize a JavaScript library, complete the following steps:

1. In the Project window, right-click CUSTOM LIBRARIES and click New Custom Library.

2. In the "New Custom Library" pop-up window, complete the following steps and click OK.

   1. Enter a name for the new custom library.

   2. Select JavaScript as the library type.

   3. Enter a description.

Example

Display the execution result of the input in the code window in a message box.

1. In the Project window, double-click the newly created custom library under CUSTOM LIBRARIES and enter the body of the JavaScript function.

2. Add the custom library to the flow chart and specify the properties.

Creating an MS Workflow Activity library

Procedures for creating an MS Workflow Activity

To create and utilize an MS Workflow Activity library, complete the following steps:

1. Download an open library (activity).

2. Change the extension of the downloaded file (.nupkg) to ".zip" and unzip it.

3. Copy the library file (.dll) in the"lib" folder to the "CustomLibraries" folder.

   • Folder path: C:\Users\UserName\Documents\Brity RPA Projects\Projectname\CustomLibraries

4. In the Project window, right-click CUSTOM LIBRARIES and click New Custom Library.

5. In the "New Custom Library" pop-up window, complete the following steps and click CREATE.

   1. Enter a name for the new custom library.

   2. select MS Workflow Activity as the library type.

   3. Select the library saves in the CustomLibraries folder from the external library path.

   4. Select the activity class.

   5. Enter a description.

Example

Delete all data in the specified folder.

Creating an MS .NET library

Procedures for creating an MS .NET library

To create and utilize an MS .NET library, complete the following steps:

1. Download the .NET Assembly (C# based library) library.

2. Change the extension of the downloaded file (.nupkg) to ".zip" and unzip it.

   • Folder path: C:\Users\UserName\Documents\Brity RPA Projects\Projectname\CustomLibraries

3. In the Project window, right-click CUSTOM LIBRARIES and click New Custom Library.

4. In the "New Custom Library" pop-up window, complete the following steps and click CREATE.

   1. Enter a name for the new custom library.

   2. Select MS .NET library as the library type.

   3. Select the library saves in the CustomLibraries folder from the external library path.

   4. Select the activity class.

   5. Select the method.

   6. Specify whether to construct an instance.

      • Check: Display constructors of the selected class and create an Instance Constructor library.

      • Uncheck: Select the Public method (including Static method) within the selected class, create the library, and call the Default constructor upon execution.

Example

Unzip the archive in a specified folder.

1. Download the “Ionix.zip” file.(https://www.nuget.org/packages/Ionic.Zip/1.9.1.8)

2. Change the extension of the downloaded file (.nupkg) to ".zip" and unzip it.

3. Copy the library file (.dll) in the"lib" folder to the "CustomLibraries" folder.

   • Folder path: C:\Users\UserName\Documents\Brity RPA Projects\Projectname\CustomLibraries .

4. Add the library for selecting the archive file to unzip to the flow chart and specify the properties.

5. Add the library for storing the unzipped archive data to the flow chart and specify the properties.

Add-in library

You can create an Add-in library on MS Visual Studio. Create the Add-in library by developing and adding a Designer library, or create an activity card in the library.

Procedures for creating an Add-In library

Procedures for creating an Add-In library and configuring the work environment are as follows:

• Create a Visual Studio Project

• Configure the Visual Studio project properties.

• Add references.

• Configure Designer debugging.

• Implement the add-In.

• Implement the activity declarative.

• Implement the OnCreateProperties.

• Implement the activity execution.

• Implement the OnCreateProperties.

• Implement the OnRun.

• Configure the multilingual string resource.

1. Creating a Visual Studio Project.

   • Version: Visual Studio 2017

   • Project type: Class library (.NET Framework, Visual c#)

     • File > New > Project > Installed > Visual C#

     • Framework: .NET Framework 4.5

   • Project name: BrityWorks.AddIn.[ProjectName]

2. Configure the VisualStudio project properties.

• N/A

  • Build > Output path: Designer_directory/AddIns/

• N/A

  • Debug > Start external program: “Designer.exe” file path

  • Debug > Start options > Working directory: Designer installation folder

• N/A

  • Resources > Add Resource (AddIn default icon, icon to display on mouse-over, and icon for each activity).

3. Add references.

   • Project > Add Reference > Assemblies, Search .

   • WindowsBase, PresentationCore, PresentationFramework.

• N/A

  • Add the IPA AddIn reference.

    • IPA.AddIn.dll, IPA.Common.dll (Browse Designer installation directory).

    • Copy Local: Set as “False.”

• N/A

  • Specify extra external library references if needed.

    • Manually add references using Add Reference.

    • Install the Manage NuGet Packages.

4. Configure the debugging environment.

• N/A

  • Change the Designer Run operation mode (PlayInBot OFF).

    • At the installation path, edit the "Designer.config" file: Change the “PlayInBot” property from “True” to “False.”

    • <UserSetting category="Designer" group="Engine“ name="PlayInBot" value=“false“ isReadOnly="false" valueType="bool" />

  • PlayInBot OFF mode: In this mode, Designer runs an engine to run and control the scenario instead of using the IPA.BOT. In default mode (PlayInBot ON), the OnRun code in the AddIn activity cannot be debugged because IPA.BOT.exe runs the scenario when it is run on Designer. (A debugger connection between the IPA.BOT.exe process and the Visual Studio is required.)

5. Implement the add-In.

- AddInDisplayName
- AddInIcon
- AddInOverIcon
- CreateActivities()

6. Implement the activity declarative.

7. Implement the OnCreateProperties.

• N/A

  • Property constructor

    • Owner: this (the fixed value as the present activity)

    • Key: PropKey (unique value)

    • Value: Default Value (the shape of controls displayed on the property window is decided depending on the data type.)

  • SetRequired: Set required values. If a required value is missing, a warning pop-up message will be displayed when you save the changes, and the program will not run. (indicated with “*” in the Properties window)

  • SetControlType: Manually specify the control to display in the Properties window regardless of the data type. (The list of default controls is provided in the PropertyControls and PathControl Type items. The additional development guide is required to create custom controls.)

8. Implement activity execution.

9. Implement the OnRun.

   • The value entered in the Properties window for the property declared in OnCreateProperties is entered as the “Dictionary” type.

   • Implement the required action using the PropKey (String) as a key to obtain the value.

   • If the OutputProperty is defined (not null), set the return value of the OnRun. (Without the value, null will be returned.)

10. Set the multilingual string resource.

API integration

Brity RPA provides an interface for API integration with external systems.

You can utilize the SendRequest activity card in the Net library to call RestAPIs via the HTTP protocol and implement interfaces with external systems.
For more information about using the activity card for integration, see SendRequest in the Net library.

Inspector

The Inspector is a tool that helps you specifically identify what you want to automate. You can view all or part of the application in a tree-like structure and analyze native apps, text extracted from images (OCR), and screen analysis of Android devices. With the Inspector, business managers can better understand the details and structure of their audience and reduce the time it takes to create scenarios.

Inspector Default Configuration

The Inspector is provided as a separate program and can be launched in the Designer by selecting the Tools > Inspector menu or IPA in the Brity RPA Designer installation path. You can double-click .exe Inspector to run it.

Inspector screen overview

인스펙터는 아래와 같은 화면 요소로 구성되어 있습니다.

• Toolbar

• Screen

• Xml

• Canvas

• Property

Basic Features of Inspector

The Inspector analyzes the automation targets you specify and displays the results. Depending on the option, the whole or part of the application can be analyzed. Native App analysis or OCR analysis that recognizes text from images can be considered for objects for which object recognition is not possible in the usual way. Screen information analysis of mobile terminals is also possible.

Application Analysis

By analyzing the structure of the entire application and organizing it in a tree form, you can understand the hierarchical relationship between objects. You can check information such as control type, class, area, name, value, text, and object path of a specific object.

Analyzing your application

1. Change the method to Application on the Inspector screen and click the Inspect button.

2. Hover to the application you want to analyze, and click on the orange rectangle. The entire application, including the selected area, is analyzed.

3. The results of the analysis will be displayed on the screen. The analysis may take some time if the application is complex at scale.

Target Analysis

Analyze the structure of specific objects and subordinates within the application. The information in the verifiable object is the same as in the application analysis.

Analyzing your audience

1. Change the method to Target on the Inspector screen and click the Inspect button.

2. Within the application, hover over the specific object you want to analyze; click when you see an orange square. Currently, the objects and subobjects in the selected area are analyzed.

3. The analysis results will be displayed on the screen in a while.

Native App 분석

Analyze text information and regions for specific objects within native applications. Native libraries make it easy to identify areas that can be automated.

Analyzing Native Apps

1. Change the method to Native on the Inspector screen and click the Inspect button.

2. Within the native application, hover over the specific object you want to analyze; click when you see an orange square. Currently, the objects and subobjects in the selected area are analyzed.

3. The analysis results will be displayed on the screen in a while.

OCR Analysis

Recognize text from images of specific objects within the application. You can check the area that contains each text and the recognized text information.

Analyzing OCR

1. Change the method to OCR on the Inspector screen and click the Inspect button.

2. Within the OCR application, hover over the specific object you want to analyze; click when you see an orange square. Currently, the objects and subobjects in the selected area are analyzed.

3. The analysis results will be displayed on the screen in a while.

Android Analysis

It analyzes the screen information of the connected Android device. You can check information such as control type, class, text, area, package, XPath, etc.

Analyzing Android

1. Connect your Android device to your PC and change the mode to Android on the Inspector screen. Select the device you want to analyze from the automatically viewed list, and then click the Analysis button.

2. The analysis results will be displayed on the screen in a while.

Inspector Convenience Features

The Inspector provides convenience functions to identify the system structure to be automated and to create scenarios more diversely and conveniently.

Extracting text

You can extract text from the analyzed screen image by specifying an area. The extracted text is displayed on the screen in the same form as the OCR analysis, along with the area information within the image.

Extracting Text

1. Change the method to Application on the Inspector screen and click the Analyze button. It is okay to proceed with the analysis in a way other than the Application.

2. Hover over the application you want to analyze, and click on the orange rectangle.

3. The analysis results will be displayed on the screen in a while.

4. Select the target from which you want to extract text on the canvas.

5. Click on the menu in the toolbar text.

6. Select the detailed area from which you want to extract the text, and then select the Cut and Apply buttons in that order. Select the Apply button immediately if you want to use the area as it was for the first time.

7. The text extraction result for the selected area will be displayed on the screen after a while.

Copying Activity

After selecting the desired object from the analysis result, use the activity copy function to copy the completed activity automatically. The copied activity can be pasted and executed directly by the designer. Depending on the analysis method, at least one activity required to perform the automation is copied, and all attributes are automatically entered.

Copying an activity

1. Analyze your audience in the way you want on the Inspector screen first.

2. Select the target you want to copy to on the canvas.

3. In the toolbar, Copy an activity. Click on the menu. To create the activity, the application to be analyzed must be running without being terminated to obtain the information necessary.

4. A message is shown stating that the activity copy was done correctly.

5. Run the designer and paste the copied activity. Depending on the analysis method, the number of activities may vary.

6. If you want to change the object, Change Activity Menus are available.

Search

You can search for specific objects in the analysis results. A list of results appears for elements containing the entered text by querying all the object's properties, including the control type. The object is displayed on the screen or canvas when you select a specific item.

검색 기능 사용하기

1. Analyze your audience in the way you want on the Inspector screen first.

2. Click on the menu in the toolbar search.

3. After entering a search term in the search bar magnifying glass, Click the button.

4. Selecting a specific item in the search results syncs to the canvas to see the destination.

Storing Object

Object storage is a storage vault that stores previously recognized objects when creating processes and tasks in the designer to reuse them.
Object storage can be used by importing stored storage files from other projects.
You can also copy and paste saved objects into Activities or search the list of activities where objects in the repository are used.

Currently, the objects that can be stored in the object store are App, SAP, ImageRecognition, and Abbyy library objects.

Storing objects in an object store

To save an object to the object store, follow the below steps:

1. Import an object repository from another project.
2. Save all objects in the current process.
3. Save the selected object in the current process to save objects to the repository.

The context menu above appears when you right-click the root of the object store or right-click on the group.

Manipulating Objects Stored in Object Store

Manipulating objects stored in the object repository is as follows:

1. Changing the name. (Duplicate allowed)
2. Copying the objects. (You can paste objects into activities in the same library)
3. Search for activities where this object has been used in the current process.
4. Search for activities where this object has been used in all processes.
5. Delete.

The context menu above appears when you right-click on the object.
The names of objects stored in the object repository are initially randomly generated.

The search results are displayed as shown above when you search for an activity where an object is used.