Step Actions

This section provides an overview of the available step actions.

The descriptions of the step actions below refer to the concepts of patterns and expressions, both of which are central text manipulation concepts in Kapow Katalyst. For a description of these two concepts, see Patterns and Expressions.

Standard

This category contains the most commonly used step actions.

Action Description
Assign Variable This action assigns a value to a variable.
Create Page This action creates a new page.
Load Page This action loads a web page from a URL.
Return Value This action returns a value from the robot.
Store in Database This action stores a value in a database.
Test Value This action causes execution beyond the step to stop or continue depending on a boolean value.

Assign/Transform Variable

This category contains step actions for assigning to variables, performing transformations on variable values and transforming XML documents using XSLT.

Action Description
Assign Variable This action assigns a value to a variable.
Convert Variables This action converts the values of one or more variables by running them through data converters and storing the results in the same or other variables.
Transform XML This action transforms XML using XSLT.

Browser Session

This category contains step actions for saving and restoring entire browser sessions, as well as for extracting and manipulating cookies and HTML 5 web storage.

Action Description
Save Session This action saves a session in a variable or in the session pool for later restoring by another robot run.
Restore Session This action restores a session in a variable or in the session pool previously saved by another robot run.
Extract Cookie This action extracts the value of a cookie matching patterns for name, domain and path.
Create Cookie This action creates a cookie with the specified domain, path, name and (optionally) value.
Remove Cookie This action removes one or more cookies matching patterns for name, domain, path and value.
Extract Web Storage This action extracts data from the local and/or session storage. The data is stored in a variable in JSON format.
Load Web Storage This action loads data into the local and/or session storage. The data must be specified in JSON format.
Clear Web Storage This action clears data in the local and/or session storage.

Browser Windows

This category contains step actions for opening, selecting and closing browser windows.

Action Description
New Window This action creates a new window.
Set Current Window This action selects another window as the current window, i.e. the window that subsequent steps will work on.
Close Window This action closes a window.

Call Web Service

This category contains step actions for calling REST and SOAP web services.

Action Description
Call REST Web Service This action calls a REST web service and loads the result into the current window or stores it in a variable.
Call SOAP Web Service This action submits a SOAP XML request to a web service and returns a SOAP XML response.

Click/Move Mouse

This category contains step actions that mimic clicking or moving the mouse to and from elements in the browser view.

Action Description
Click This action emulates a mouse click on the found tag.
Move Mouse To This action emulates a mouse move to the found tag.
Move Mouse From This action emulates a mouse move away from the found tag.
Scroll This action emulates scrolling a document or tag.
Scroll To This action emulates scrolling the found tag into view.

Database

This category contains step actions that can store, retrieve, query or delete items in databases.

Action Description
Store in Database This action stores a value in a database.
Find in Database This action finds a value in a database.
Calculate Key This action calculates the key that will be used to store the value of the selected variable.
Delete from Database This action deletes an value in a database.
Query Database This action submits an SQL query to a database, and loops through the results.
Execute SQL This action executes an SQL statement on a database.
Store in HBase Table This action stores a value in a HBase Table.

Enter Data in Form

This category contains step actions for entering data in web forms.

Action Description
Enter Text This action enters a text into a text field in a form.
Enter Password This action enters a password into a password field in a form.
Press Key This action emulates pressing Enter in a form.
Select Option This action selects an option in a drop-down box or a list box in a form.
Select Multiple Options This action selects multiple options in a list box in a form. Note: This action can only be used for list boxes, not drop-down boxes.
Set Checkbox This action checks or unchecks a checkbox in a form.
Select Radio Button This action selects a radio button in a form.
Select File This action selects a file to upload in a file field of a form.

Extract

This category contains step actions for extracting data. Data may be extracted in text or HTML form from a web site, or from other formats such as PDF, CSV, Excel and Flash. It is also possible to extract images or specific data about the HTML or XML source such as attribute values or link URLs.

Action Description
Extract This action extracts some text, runs it through a list of data converters, and stores the result in a variable.
Extract Cell This action extracts content from an Excel page, runs it through a list of data converters, and stores the result into a variable.
Extract Selected Option This action extracts the text or value of the selected option, runs it through a list of data converters, and stores the result in a variable.
Extract URL This action extracts a URL from the found tag and stores it in a variable.
Extract Image This action extracts an image and stores it in a variable or a file. It can also optionally store the content type and file name of the image in other variables.
Extract Screenshot This action extracts an image from the current page and saves it in a variable.
Extract Target This action extracts data from a URL target and stores it in a variable or a file. It can also optionally store the content type and file name of the loaded data in other variables.
Extract Tag Attribute This action extracts a tag attribute from the found tag, runs it through a list of data converters, and finally stores it in a variable.
Extract Form Parameter This action extracts a form parameter from a form URL in the found tag.
Extract from Flash This action extracts content from a Flash object.
Extract from PDF This action extracts text from a PDF document contained in a variable.
Extract Binary Content This action extracts binary content from the current window.

File System

This category contains step actions for accessing the file system. You may read, write and modify files and directories, loop over files in a directory or test for the existence of a given file.

Action Description
Load File This action loads data from a file, either into the browser window or to a variable.
For Each File This action loops through the files in a directory.
Write File This action writes a new file or appends to an existing file.
Test File Existence This action causes execution beyond the step to stop or continue depending on whether a specific file exists.
Get File Info This action fetches meta data about a file in the file system.
Copy File This action copies a file on the local file system where the robot is executed. The action generates an error if the destination file exist.
Delete File This action deletes the specified file or directory.
Make Directory This action creates a new directory.
Rename File This action renames a file or directory on the local file system where the robot is executed. The action generates an error if the destination (New Name) exist.

Loop

This category contains step actions for looping. You may loop through HTML structures, windows, comma-separated values, form values, Excel ranges, or crawl entire domains.For looping through HTML structures, you have two options: For Each Tag and For Each Tag Path. The For Each Tag step action is the simpler of the two; it is used to loop through the immediate children of the found tag, while the For Each Tag path can loop through similar tags at any depth within the found tag. To loop through a number of pages connected by "Next" links or the like, you must use the Repeat and Next step actions.

Action Description
For Each Tag This action loops through tags contained immediately inside the found tag.
For Each Tag Path This action loops through tags contained at any level inside the found tag.
For Each URL This action loops through the URLs contained in the found tag.
For Each Window This action iterates through the browser windows, setting each in turn as the current window.
For Each Text Part This action splits a text at a specified delimiter and loops through the parts.
For Each Option This action loops through the options in a drop-down box or list box in a form, selecting one option in each iteration.
For Each Radio Button This action loops through a group of radio buttons, selecting one of the radio buttons in each iteration. The found tag must be one of the radio buttons in the group.
Loop Field Values This action loops through the specified values, entering one value in the text field in each iteration.
Loop in Excel This action loops over the rows, columns, cells in the found range or over all the sheets in the Excel page.
Repeat This action creates a repeat loop together with the Next action.
Next This action requests another iteration in a repeat loop created using the Repeat action.
Crawl Pages This action crawls pages, each iteration outputting the next crawled page.
Get Iteration This action gets the current iteration of an enclosing loop step.

Load Page

This category contains step actions for loading pages from a given URL or creating a new page based on already extracted content. If required, you can also choose to specify the page load request at the basic HTTP level yourself.

Action Description
Load Page This action loads a web page from a URL.
Create Page This action creates a new page.
Raw HTTP This action performs a Raw HTTP request of the selected method.

Make Snapshot

This category contains step actions for saving offline snapshots of web pages. To save an offline HTML copy of a page and its resources, use Make Snapshot. To save multiple interlinked HTML pages, use Rewrite Page and Rewrite Style Sheet.

Action Description
Make Snapshot This step action creates a snapshot of the current window, including its frames and resources.
Rewrite Page The Rewrite Page step action extracts the HTML content of the current window and additionally rewrites and outputs the links to style sheets, images and other pages.
Rewrite Style Sheet The Rewrite Style Sheet step action acts as a helper for Rewrite Page. It task is to rewrite links to other style sheets or images in a given style sheet.

Modify Page

This category contains step actions for modifying the current web page, e.g. by removing, replacing or inserting content.

Action Description
Insert Tag This action inserts a new tag.
Replace Tag This action replaces the found tag with a new tag.
Remove Tags This action will remove tags from found tags. The Remove rules will be executed in the order listed below. Any tags matching one or more of the Except rules will not be removed. Defining no Remove rules defaults to removing all tags.
Remove Tag Range This action removes a range of tags.
Hide Tag This action hides the found tag.
Unhide Tag This action unhides the found tag.
Divide Text This action divides the text in the found tag into pieces.
Divide Table This action divides the input <table>-tag into several sub <table>-tags, one of which is outputted in each iteration.
Remove Table Rows This action removes from the input <table>-tag all rows (<tr>-tags) that do not have a specified number of columns (<td>- and <th>-tags).
Transpose Table This action transposes (i.e. flips) the input <table>-tag by mirroring its <td>-tags along the top-left to bottom-right diagonal.
Normalize Table This action normalizes a table by inserting extra cells to eliminate rowspan and colspan. The content from the original cell is copied to the new cell(s)

Other

This category contains various other step actions.

Action Description
Set Named Tag This action marks the found tag as a named tag, so that it can be used as a reference when finding tags in subsequent steps.
Set Named Range This action marks the found range as a named range, so that it can be used as a reference when finding ranges in subsequent steps.
Clear Named Tags/Ranges This action unmarks a selected named tag or range, or all named tags/ranges, so that these will no longer be named in the subsequent steps.
Do Nothing This action does nothing.
Wait This action waits for a specified period of time.
Stop This action causes the execution of the robot to stop without errors.
Generate Error This action generates an error.
Execute Command Line Executes a command line or shell script. Ensure RoboServer has sufficient privileges for this operation
Change Proxy This action changes the proxy server.
Execute JavaScript This action executes JavaScript.

Output

This category contains step actions for returning values to the API that called this robot, sending e-mail and writing to files or logs.

Action Description
Return Value This action returns a value from the robot.
Send Email This action sends an email. Note that the email is not sent during execution in Design mode in Design Studio.
Write File This action writes a new file or appends to an existing file.
Write Log This action writes a message to the log. This is useful when debugging a robot.

Test

This category contains conditional actions for testing, i.e. stopping the execution down the current branch if some condition is satisfied. This condition may for instance depend on the contents of the found tag, a variable, the existence of a given window.

Action Description
Test Tag This action causes execution down the current branch to stop or continue depending on the contents of the found tag.
Test URL This action causes execution down the current branch to stop or continue depending on the URL contained in the found tag.
Test Value This action causes execution beyond the step to stop or continue depending on a boolean value.
Test Variables This action causes execution beyond the step to stop or continue depending on one or more variable values.
Test Row This action tests the number of columns in a table row.
Test Window This action causes execution beyond the step to stop or continue depending on whether a specific window exists.
Test Page Type This action causes execution beyond the step to stop or continue depending on the type of the page.
Test Cell Type This action test the cell type, e.g. Blank or Number etc. of the found range and causes execution beyond the step to stop or continue depending on whether all cells in the range are of the given type.

Excel

This category contains actions that are specially designed for Excel pages.

Action Description
Extract Cell This action extracts content from an Excel page, runs it through a list of data converters, and stores the result into a variable.
Extract Hyperlink This action extracts a hyperlink from an Excel page, runs it through a list of data converters, and stores the result in a variable.
Extract Sheet Name This action extract the sheet name of the sheet which contains the found range into a variable.
Insert Columns This action inserts one or more columns in a spreadsheet.
Insert Rows This action inserts one or more rows in a spreadsheet.
Insert Sheet This action inserts a new sheet in a spreadsheet.
Remove Columns This action removes selected columns from a spreadsheet.
Remove Rows This action removes selected rows from a spreadsheet.
Remove Sheet This action removes a selected sheet from a spreadsheet.
Set Column Width This action sets the width of a column in a spreadsheet. The width is specified in a number of characters.
Set Content of Cell This action inserts the specified content to a spreadsheet cell.
Set Content of Column This action sets the content of a column in a spreadsheet from a variable of complex type.
Set Content of Row This action sets the content of a row in a spreadsheet from a variable of complex type.
Set Format of Cell This action sets the format of one or more cells in a spreadsheet.
Set Hyperlink on Cell This action inserts a hyperlink to a cell.
Set Row Height This action sets the height of a row in points.
Set Information This action sets the value of an information property in a spreadsheet.
Set Sheet Name This action sets the sheet name.
Set Value of Cell This action sets the value of a cell.
Loop in Excel This action loops over the rows, columns, cells in the found range or over all the sheets in the Excel page.
Test Cell Type This action tests the cell type, e.g. Blank or Number etc. of the found range and causes execution beyond the step to stop or continue depending on whether all cells in the range are of the given type.
Set Named Range This action marks the found range as a named range.
Extract As HTML This action extracts the found range as an HTML page containing a table with the cells of the range into a variable.

Deprecated

This category contains step actions that have been replaced by newer versions or have otherwise become obsolete. They are available only for backwards compatibility with robots written using earlier versions of Design Studio. Do not use these step actions in new robots.