Subscribe

UiPath StudioX

The UiPath StudioX Guide

Extract Data

UiPath.UIAutomationX.Activities.ExtractData

Extracts data from a specified web page or application. Use this activity to extract structured information such as table data or web search results that can span multiple pages. Follow the Extract Wizard to indicate what information to extract. Must be added inside an Application Card activity.

To learn how to use this activity, see Tutorial: Extracting Table Data from a Web Page and Editing It in Excel.

In the Body of the Activity

  • Indicate Target - Indicate the data to extract by following the Extract Wizard.
  • Extract to - Click plus button on the right side of the field and then, from the menu, select what to do with the extracted data:
    • Select an Excel file and then a sheet, named range, or table where to copy the data. Alternatively you can click Indicate in Excel to select directly from the file.
    • Save for Later Use - Use the data later in your project as input for another activity.
    • Open in Advanced Editor - Enter a VB expression.
  • After you indicate the target, click the Options Options button button and then select one of the available options to further configure your target.
    • Indicate Target - Indicate the target again.
    • Configure Target - Configure advanced options for the target.
    • Configure Next Link - Configure the link to click for moving to the next page if the data spans multiple pages.
    • Highlight Target - View the currently selected target on your display surrounded in a box.
    • Highlight Next Link - View the currently selected link for the next page on your display surrounded in a box.
    • Test Extraction - Run a test of the data extraction with the current configuration.

Properties

Common

  • ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
  • DelayAfter - Delay (in milliseconds) between the time this activity is completed and the time the next activity begins any operations. The default value is 300 milliseconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • DelayBefore - Delay (in milliseconds) between the time the previous activity is completed and the time this activity begins performing any operations. The default value is 200 milliseconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • Display Name - The name displayed for the activity in the Designer panel.

Input

  • ExtractMetadata - An XML string that enables you to define what data to extract from the indicated web page.

Misc

  • Private - If selected, the data used by the activity is not saved to the StudioX logs when the project is executed.

Options

  • DataTable - See Extract to in the body of the activity.
  • DelayBetweenPages - The amount of time (in milliseconds) to wait until the next page is loaded. The default value is 300 milliseconds. If the loading time of the page is longer, this value should be higher.
  • InputMode - Select how to execute the click on the next page link if the data spans multiple pages:
    • Same as Card - Use the same input mode as the Application Card. This is the default selection.
    • Window Messages - Sends a specific message to the target application. This input method can work in the background, is compatible with most desktop apps, but it is not the fastest of the methods.
    • Hardware Events - Simulates the click by using the hardware driver. This is the slowest method, it cannot work in the background, but it is compatible with all desktop apps.
    • Simulate - Simulates the click using the technology of the target application. This input method is the fastest of the three and works in the background.
  • MaximumResults - The maximum number of results to be extracted. If the value is 0, all the identified elements are added to the output. The default value is 100.

Updated 2 years ago


Extract Data


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.