Edit robot

For information about editing a robot, see the following topics.

Editor

The Editor contains workflow and parameters such as variables, expressions, and tree mode settings.

Actions and navigation

  • Undock and move any of the Editor windows to make editing more convenient.

  • Pause or reset the execution of a robot.

  • Use buttons on the toolbar to navigate through the steps of a workflow.

  • Move forward in a workflow by using the Start Execution, Step Into, Step Over, and Step Out buttons.

  • Use the following key combinations to select multiple steps:

    • Shift+click selects a range of steps

    • Ctrl+click adds or removes a selection of steps

    • Ctrl+Shift+click adds a range of step selections

Toolbar buttons

For a list of robot buttons, see Toolbar.

Zoom in and out of Editor

Zoom in and out of the workflow view the same way you zoom in a web browser.

  • To zoom in, press Ctrl+ (plus sign) or Ctrl+mouse wheel scroll up.

  • To zoom out, press Ctrl- (minus sign) or Ctrl+mouse wheel scroll down.

Attributes

Use the Attribute pane to configure the attributes of a robot.

  • Input: View lists of inputs that a robot takes.

  • Devices: Provide a reference to one or more required devices.

  • Databases: Specify a name for the database that a database step will use.

  • Return Types: View lists of return types that a robot delivers to the Basic Engine Robot.

  • Exceptions: View exceptions that occur when a Basic Engine Robot is calling.

  • Tree Modes: Configure the application-tree type for different applications to deliver.

  • Variables: Configure robot variables.

Find Usage

For Input, Devices, Variables, and Exceptions, you can use the Find Usage feature to find where they are used. Right-click the required element and click Find Usage.

This feature is similar to the text search except that the list in the Search Result panel shows instances of a particular element only.

Recorder View

Shows tabs with open application windows and a tree with available elements. Select elements in the interface or select images and insert steps by right-clicking the selected element or image.

The bottom part of the Recorder View shows the coordinates of the mouse relative to the top left corner of the application window.

The view shows the live streaming status of the device state. See also application-level actions.

When you select an element in the view, it shows the coordinates relative to the top left corner of the selected element and the path to the element in the bottom bar.

Color Description

Shows the mouse coordinates relative to the top left corner of the window.

If you select a purple area, the figure next to the purple box indicates the displacement of the mouse relative to the top left corner of the purple area.

While an area on an image is being selected to use the image finder, this shows the size of the purple area in pixels.

  • The figure next to the black box indicates the mouse coordinates relative to the top left corner of the window.
  • The figure next to the green box indicates the displacement of the mouse relative to the top left corner of the green area.
  • The green area indicates the element that contains the selected purple area.

When you click an element in the tree or on an image, this shows the displacement of the mouse in pixels relative to the top left corner of the green area.

When you click an element in the tree, this shows the displacement of the mouse in pixels that is relative to the top left corner of the orange area.

When a robot contains a loop, this option indicates the parent element that contains the loop and the element that the loop is currently on.

All tag paths in the Recorder View are interactive.

  • Left-click a tag in the path to make the node a selected tag.

  • Right-click a tag to open the context menu for the node.

Tags are marked with colored boxes corresponding to their current state:

  • A green box indicates the primary selected tag.

  • An orange box indicates a secondary tag.

  • A blue box indicates a tertiary (third) tag.

To switch among elements of different levels, use the following buttons:

  • Select Outermost Tag
  • Select Tag One Level In
  • Select Tag One Level Out
  • Select Innermost Tag
  • Select Previous Sibling Node
  • Select Next Sibling Node

Sometimes it is not possible to select cell elements in tables in the application view. In these cases, select cell elements in the application tree and add steps from the tree view.

Zoom in and out of Recorder View

Zoom in and out in the Recorder View either by selecting a zoom level in the toolbar or in the same way you would in a web browser.

  • To zoom in, press Ctrl+ (plus sign) or mouse wheel scroll up.

  • To zoom out press Ctrl- (minus sign) or mouse wheel scroll down.

Toolbar buttons

Button

Rollover Text

Description

Streaming is active button in the Recorder view

Streaming is paused button in the Recorder view

Pauses or resumes live streaming of the device state. Click to pause or resume streaming in the Recorder View.

When streaming is active, the following is shown under the Recorder View: .

When streaming is paused, the following is shown under the Recorder View: .

Create finder for selection button

Create finder for selection

Replaces the selection in the Editor finder with a finder that matches the selection in the Recorder View.

Show next location found button

Show next location found

Shows the next element that matches the finder. The tool tip displays the number of matched elements.

Select Next Node Matching Click button

Select Next Node Matching Click

Moves selection to the next node that matches the selection in the Recorder View.

Select zoom level in Automation Device View

Select zoom level

Zooms in and out in the Recorder View.

Select parent node

Select Tag One Level Out

Changes selection to the node, which is the parent to the selected one.

Select first child node

Select Tag One Level In

Selects the first child node of the selection.

Select Outermost Tag

Changes selection to the top node in the application tree.

Select Innermost Tag

Selects the last child node of the selection.

Select previous sibling node

Select Previous Sibling Node

Selects the previous node located on the same level in the application tree.

Select next sibling node

Select Next Sibling Node

Selects the next node located on the same level in the application tree.

Copy Sub Tree As XML

Copies the subtree element selected in the tree view.

Auto Execute button in Recorder view

Immediately executes and streams newly added action steps. When enabled, the circle on the button is red.

Prior to adding a step or a multiple steps, click this button. If a step opens a new application or a dialog, a respective tab appears in the stream view and becomes the active tab. To stop automatic execution, click this button again.

Application-level actions

Application-level actions are actions applied to the entire application and available by right-clicking the application tab in the Recorder View. These include the following actions and steps:

Search results

Displays an overview of Search results.

Comment

Shows comments for selectable items in the automation workflow, such as steps, Group steps, variables, finders, input types, conditional branches, and so on.

To write or change a comment, click an item and add or change notes in the Comment window. Use the Undo and Redo buttons here. The comment is automatically saved when you click outside the window.

An item that contains a comment is marked with a comment sign.

State

Shows the state of the workflow execution such as variable values. When Kofax RPA detects that a binary variable contains an image, the image is displayed in the view. Kofax RPA detects GIF, JPEG, BMP, TIFF, and PNG images. The image tool tip shows the MIME type of the image and its size (width and height).

When you right-click a value in the State pane, a context menu appears that enables you to copy the value, temporarily change the value, or insert an Assign To, Convert, or Store in Database step in the robot workflow at the position of the flow point.

Output log

Contains workflow execution messages.

Tips

Put focus on errors in workflow
When a step is inserted from a flow point in the robot and that step contains an error or multiple errors, the location of the first error is indicated in the expanded step. If the robot execution is stopped due to errors in a step, that step is expanded to show the location of the first error. If any steps were inserted in the workflow using "Surround with" steps, those steps are expanded.
Make instant mouse clicks that are not recorded

Perform an instant mouse click on an element without adding it to the robot workflow. This action can be useful to close an unnecessary or accidentally opened tab. Right-click an element in the Recorder View, click Unrecorded Instant Click, and select the mouse click type to use.

Close built-in applications
Close application tabs of built-in applications such as Browser, Excel, and others while editing a robot by clicking the Close button in the top right corner of the tab. This action is not a step, and the tab closes like any window.