The user interface

The IBM RPA Studio user interface supports many features to automate tasks. Its ribbon brings all elements that you need to create, edit, debug, and track the script development.

The user interface contains a development area, in which you can use the scripting language or the low code graphical interface to develop your scripts. It also displays the script call graphs, so you can view the logical structure of your script.

While you develop a script, you can also run and debug it. Use the IBM RPA Studio debugger to inspect your script code by stepping through the code, tracking global variables values and watched variables, and examining code stacks.

The following image shows the user interface ribbon, panes, and development area.

The IBM RPA Studio user interface. It shows the ribbon, panes, and the development area. Each of these elements is numbered, so it can be described in details through this content.

This section sort the features based on how you can use them to develop a script. Use the following table to refer to each section of the IBM RPA Studio screen capture.

No. Topic Description
1 Create a script Describes the UI elements to run file operations like create, open, save, and publish.
2 Edit a script Describes the UI elements to add variables, subroutines, rule sets, and asset files to your script.
3 Edit actions Describes the UI elements to browse through commands in your script, comment or uncomment commands, and view or unview variables and assets imports on a script.
4 Debug a script Describes the main UI elements to start debugging, start without debugging or debug step by step, and elements to watch a debug by tracking global and watched variables, and code stacks.
5 Navigate and find code Describes the UI elements to browse through your script code.
6 Use tools to develop a script Describes the UI elements to test regular expressions, synchronize assets, create test for scripts, transform knowledge base files into machine learning models, train knowledge base models, and run image and PDF operations.
7 Get help Describes the UI elements to access resources to help you learn more about the product.
8 The Script view mode Presents the Script view as a development mode to build scripts.
9 The Designer view mode Presents the Designer view as a development mode to build scripts.
10 The Call graph view mode Presents the Call graph view to display the logical structure of a script.
11 Toolbox pane Describes the UI elements to find and use commands available on the Toolbox pane.
12 Output panes Describes the UI elements to open panes that help you analyze script outputs and track script parse errors.
13 Resource panes Describes the UI elements to open panes that help you track script variables, assets, rules set, subroutines, and properties.

Create a script

On the Home tab, use the elements in the File group to run file operations like create, open, save, and publish. The following image shows these elements on the user interface.

The elements in the Home tab by focusing on the elements of the File group. These elements are: New, Wal file, Report file, Spreadsheet file, Text file, Workflow file, Workflow file, Open, Open from Repository, Save, Save As, Save All, and Publish.

The following table describes the UI elements and their actions:

UI element Description
New Open the new file window.
Wal file Create a WAL file.
Report file Create a Report file.
Spreadsheet file Create a Spreadsheet file.
Text file Create a Text file.
Workflow file Create a Workflow file.
Open Open the Open dialog box to open a new file from the computer.
Open from Repository Open the Repository tab to open a script from the repository.
Save Save the current file.
Save As Open the Saves As dialog box.
Save All Save all files opened.
Publish Publish the script to the repository.

Develop a script

The user interface contains a development area that groups every resource that you need to develop a script. In this area, you can drag commands from the Toolbox, view your code in different modes, and add panes to help you develop and debug a script.

The Script view mode

In the development area, click the Script tab to use the scripting language, a procedural programming language to develop scripts on the Script mode. The following example shows a sample script that is developed on the Script mode.

The development area focus on the Script mode. It uses written code to show how to enter new commands to a script.

Run common actions on a command added to the script such as cut, copy, or paste, and specific actions according to the command. The following image shows the action options in the drop-down menu:

The menu opened in the Script mode. It shows the options available in the menu when you use the Script mode to develop a script.

Open the menu by right-clicking on a command. The following list shows the specific actions that you can run:

  • Format
    Format code syntax like its indentation.

  • Toggle Outlining
    Collapses a selected block of code. It also collapses the block of code most closely of the selected line.

  • Collapse to Definitions
    Collapses the tree of all rule sets and subroutines blocks in the entire script.

  • Show All Outlining
    Shows all outlining information for the entire script.

Learn more about the Script view mode in Script mode.

The Designer view mode

In the development area, click the Designer tab to develop your scripts by using a low code graphical interface. The following example shows a sample script that is developed on the Designer mode.

The development area focus on the Design mode. It uses the graphical interface to show how to add commands to the script by moving them from the Toolbox pane.

Run common actions on a command added to the script such as edit, remove, copy, or paste, and specific actions according to the command. The following image shows the action options in the drop-down menu:

The menu opened in the Designer mode. It shows the options available in the menu when you use the Designer mode to develop a script.

Open the menu by right-clicking on a command. The following list shows the specific actions that you can run:

  • Run To Line
    Run the script until the selected command. You can also use the Ctrl+F10 keyboard shortcut.

  • Insert
    Insert elements around the selected command, like an empty line after or before it, a comment after or before it, and related commands.

  • Duplicate
    Add another related command on the script with the same input and output parameters values.

  • Convert
    Convert the selected command to another with the same input and output parameters values.

  • Variables
    Based on the variables in the selected command, find their references on the script or replace them.

  • Advanced
    Into the advanced option, you can run the following actions:

    • Extract Routine
      Create a subroutine and move the selected command into it.

    • Move To Routine
      Move the selected command to an existent subroutine.

    • Surround With
      Surround the selected command into an instruction block that is created by some Flow control commands.

    • Comment Selection
      Comment the selected command.

    • Uncomment Selection
      Uncomment the selected command.

Learn more about the Designer view mode in Designer mode.

The Call graph view mode

In the development area, click the Call graph tab to view the logical structure of a script. The call graphs appear like flowchart diagrams, where it shows each subroutine in your script as a new node in the flowchart.

The following example shows a sample script that connects all subroutines on it:

The development area focus on the Call Graph mode. It creates three subroutines and connects them one to another by using the Run Subroutine command. In the Call Graph view, it shows these subroutines connected.

Learn more about the Call graph view mode in Call graph mode.

Toolbox pane

Open the Toolbox pane by clicking in the Toolbox element on the View tab or by using the Ctrl+W, X keyboard shortcut. You can identify each command by its label or verb. For example, to click in a webpage you use the Click on Web Page command. Search it on the Toolbox by its label or use its verb webClick.

The following example shows how you can open the Toolbox pane, and how to search for a command:

The IBM RPA Studio focusing on the Toolbox pane. It uses the keyboard shortcut to open the Toolbox and search for the Click on Web Page command.

The toolbox contains more than 600 commands that you can use to develop your scripts. For more information, see Commands.

Output panes

On the View tab, use the elements in the Studio group to open panes that helps you analyze script outputs and track parser errors on the script.

  • Output
    Opens the Output pane, which logs messages from some commands, like the Log Message command.

The Output pane with a text on it. The Toggle Word Wrap is pressed, so the text can fit in the pane width.

  • Error List
    Opens the Error list pane, which displays parser errors on your script. Parser errors can launch error, warning, or message alerts for misuse of commands, subroutines, or variable types, for example.

The Error List pane with three errors alerts for a subroutine, a variable, and a command.

  • Status bar
    Shows the status of operations that you run on the IBM RPA Studio, like when you press a keyword shortcut or run a script.

Resource panes

On the View tab, use the elements in the Studio and Wal groups to open panes that help you track script variables, assets, rules set, subroutines, and properties.

  • Variables
    Opens the Variables pane, which lists all variables that you add to your script according to its type. It also can display environment variables for IBM RPA.

  • Assets
    Opens the Assets pane, which lists all assets that you add to your script according to its type.

  • Rules set
    Opens the Rules set pane, which lists all rule sets that you add to your script.

  • Routines
    Opens the Routines pane, which lists all subroutines that you add to your script.

  • Properties
    Open the Properties pane, which details the elements into Report and Workflow files.

Edit a script

On the Home tab, use the elements in the Edit group to add variables, subroutines, rule sets, and asset files to your script. The following image shows these elements on the user interface.

The elements in the Home tab by focusing on the elements of the Edit group. These elements are: New variable, New routine, New rule set, and File.

The following table describes the UI elements and their actions:

UI element Description
New variable Create a variable.
New routine Create a subroutine.
New rule set Create a rule set.
Asset Create an asset file.
Audio file Create an asset of an audio file.
Image file Create an asset of an image file.
Web Service Create an asset of a Web Service.
Grammar file Create an asset of a grammar file.

Edit actions

On the Home tab, use the elements in the Actions group browse through commands into your script, comment or uncomment commands, view or unview variables and assets imports. The following image shows these elements on the user interface.

The elements in the Home tab by focusing on the elements of the Actions group. These elements are: Undo, Redo, Navigate Backward, Navigate Forward, Comment, Uncomment, Variables visible, Imports visible, Hide description, Word wrap, View script, View designer, and Start Recorder.

The following table describes the UI elements and their actions:

UI element Description
Undo Undo the last change.
Redo Redo the last change.
Navigate Backward Go back to the last action made on the script.
Navigate Forward Go to the newest action made on the script.
Comment Comment the selected lines.
Uncomment Uncomment the selected lines.
Variables visible Make variables visible on the script when you use the Designer mode.
Imports visible Make assets imports visible on the script when you use the Designer mode.
Hide description Hide command description.
Word wrap Wrap long lines of written comments.
View script View the Script mode.
View designer View the Designer mode.
Start Recorder Start the IBM RPA Studio's recorder tool. For more information, see Recorder.

Debug a script

Use the IBM RPA Studio debugger to inspect your script code. The UI displays many elements to step through the code, track global variables values and watched variables, and examine code stacks.

For more conceptual and how-to's content, see Debugging scripts.

Debugging

On the Home tab, use the elements in the Debugging group to run your script. The following image shows these elements on the user interface.

The elements in the Home tab by focusing on the elements of the Debugging group. These elements are: Start, Start without debugging, Start step by step, Toggle Breakpoint, Delete All Breakpoints, Attach to Schedule, and Attach to Runtime.

The following table describes the UI elements and their actions:

UI element Description
Start Run a script.
Start without debugging Run a script without debugging.
Start step by step Run a script debugging step by step.
Toggle Breakpoint Add or remove a breakpoint.
Delete All Breakpoints Delete all breakpoint on the script.
Attach to Schedule Attach the script to a scheduled job.
Attach to Runtime Attach the script to a running bot.

Debugging process

Use the elements on the Debug tab to step through your code and inspect it. The following image shows these elements on the user interface.

The elements in the Debug tab by focusing on the elements of the Debug group. These elements are: Continue, Pause, Stop, Step Into, Step Over, Step Out, and Toggle step by step.

The following table describes the UI elements and their actions:

UI element Description
Continue Continue debugging.
Pause Pause debugging.
Stop Stop debugging.
Step Into Step into the next line.
Step Over Step over the current highlighted line.
Step Out Step out a block of code, like subroutines or rule sets, to the block of code that called it.
Toggle step by step Track the debugging process as in a step by step debugging.

Debug panes

Use the elements on the Window tab to track global variables, view the call stack, run extra commands, and watch specific variables. The following image shows these elements on the user interface.

The elements in the Debug tab by focusing on the elements of the Debug group. These elements are: Global Variables, Watches, Call Stack, Immediate, and Debug Bar.

The following list describes the user interface elements and their actions:

  • Global Variables
    Opens the Global Variables pane, which you view every variable you set on your script, and track variables' values while you debug it.

  • Watches
    Opens the Watches pane, which you view specific variables while you debug a script. Add variables to it by right-clicking a variable from the Globals pane and clicking Add Watch.

The Globals and Watches panes are in focus. The Globals pane has the a, b, and c variables. It adds the last variable to the Watches pane.

  • Call Stack
    Opens the Call Stack pane, which you can track the execution flow of the script.

The Globals pane is in focus. It shows the call stack for the main and the websiteActions routines while the script is running in debug mode.

  • Immediate
    Opens the Immediate pane, which you run commands that aren't in your script.

The Immediate pane is in focus. It adds the Log Message command in the Immediate pane to diagnosis a variable before and after it receives a value.

  • Debug Bar
    Opens the Debug Bar box, which floats over the main window, and contains the same elements from the Debug tab.

The Debug Bar box. It shows every element on this box, such as Continue, Pause, Stop, Step Into, Step Over, Step Out, and Toggle step by step.

On the View tab, use the elements in the Wal group to browse through your script code. The following image shows these elements on the user interface.

The elements in the View tab by focusing on the elements of the Wal group. These elements are: Navigate to, Go to line, Find and replace, Find results, and Find results.

The following table describes the UI elements and their actions:

UI element Description
Navigate to Open the Navigate To box.
Go to line Go to a specific line.
Find and replace Open the Find and Replace box.
Find results Open the Find Results pane.

Use tools to develop a script

IBM RPA Studio has built-in tools to create, test, and debug scripts, so you can improve your bot capabilities. With these tools you can test regular expressions, synchronize assets, create test for scripts, transform knowledge base files into machine learning models, train knowledge base models, and run image and PDF operations.

The elements in the Tools tab by focusing on the elements of the General, Artificial Intelligence, Pdf, and Image groups. These elements are: Regular Expression Builder, Assets Synchronization, Tests Explorer, Machine Learning Model Builder, Knowledge Base Training, Region Selector, Fields Mapper, Extract Pdf Text, and Image Cropper.

The following list describes the user interface elements and their actions:

  • Regular Expression Builder
    Open the Regular Expression Builder tool, which you use to test regular expressions.

  • Assets Synchronization
    Open the Assets Synchronization tool, which you use to synchronize assets. Starting from IBM RPA 23.0.3, this tool isn't available due to the IVR removal. For more information, see Removed.

  • Tests Explorer
    Open the Tests Explorer tool, which you use to create tests for scripts. For more information, see Script auditing.

  • Machine Learning Model Builder
    Open the Machine Learning Model Builder tool, which you can use to transform knowledge base files into machine learning models, such as text classification, knowledge bases, N-gram, and bag-of-words models. For more information, see Machine learning.

  • Knowledge Base Training
    Open the Knowledge Base Training tool, which you can use to test, improve existing data, and create new data for a knowledge base model. For more information, see Training a Knowledge Base model.

  • Region Selector
    Open the Region Selector tool, which you use to get an image or text from a PDF file. For more information, see PDF region selector.

  • Fields Mapper
    Open the Fields Mapper tool, which you use to get and set values from the PDF file. For more information, see Fields Mapper.

  • Extract Pdf Text
    Open the Extract Pdf Text tool, which you use integrated with commands to get text from a PDF file. For more information, see Extract Pdf Text.

  • Image Cropper
    Open the Image Cropper tool, which you use to crop an image and export it to the script by using the Crop Image command.

Get help

On the Help tab, use the elements in the General group to access resources to help you learn more about the product. The following list describes the user interface elements and their actions:

  • Help
    Go to the IBM RPA online documentation.

  • IBM RPA Community
    Go to the IBM RPA Community webpage.

  • About
    View information about products that are installed and their version, and IBM RPA Studio version and copyright.

View logs

On the Help tab, use the elements in the Logs group to view logs generated by the IBM RPA Studio, Bot Agent, and IBM RPA Vault. The following list describes the user interface elements and their actions:

  • Studio
    View logs related to IBM RPA Studio activities.

  • Agent
    View logs related to Bot Agent service activities.

  • Vault
    View logs related to IBM RPA Vault activities.

For more information about logs, see Main applications logs.

Layout

Reorganize panes through the UI or use the pane as a floating window, reset the layout to the default, or open the start page. The following list describes the user interface elements to handle the layout:

  • Start Page
    On the View tab, you can find the Start Page element, which opens or focus on the Start Page pane.

  • Reset Layout
    On the Help tab, you can find the Reset Layout element, which resets the layout to the default layout.

IBM RPA Studio settings

On the Tools tab, you can find the Options element, which opens the platform settings window, where you can configure internal components. For more information, see IBM RPA Studio settings.