Capture Commands


Navigation:  Agent Commands >

Capture Commands

Capture commands capture data from a web page or from an input data provider, and saves the captured data to output. No other type of command can save data to output, so you need a capture command for each data field you want in your output data.


It is important to understand that some commands don't capture anything. For example, the Set Form Field command does not capture the input value that corresponds to a form field, but simply identifies the field. To capture data, you need to use one of the capture commands to acquire the input value and save it to data output.


These are all of the Capture commands available in Content Grabber:

Web Element Content

Download Image

Download Document

Download Screenshot

Calculated Value

Page Attribute

Data Value


Data Types

Content Grabber supports the following data types for captured data.


Data Type


Short Text

All content will be captured as Short Text by default. Short Text content can be up to 4000 characters long.

Long Text

Long Text content can be any length, but cannot always be used in comparisons, so you may not be able to include Long Text content in duplicate checks.


A whole number.


A floating point number.


A date and/or time value.


A value that can be true or false. Boolean values are stored as 1 or 0 integer values.


Extracted content will be converted to the selected data type at the time of extraction. If content cannot be converted to the chosen data type, a warning will be logged and the command will capture nothing.


When exporting data to Excel or PDF, data formatting will be set to General by default. This may cause issues when exporting some data types, like Date/Time values. When exporting Date/Time values to Excel or PDF you should always set the ExcelColumnFormat property on the Capture command. The ExcelColumnFormat property takes the same kind of formatting string as the Custom formatting string in MS Excel. For example, the formatting string "yyyy-mm-dd" formats a Date/Time value as year, month and day.


Capture Command Properties

All commands have a set of properties that govern the function of the command. The following is a set of basic properties common to all capture commands.




Transformation Script

Please see the Content Transformation Script topic for more information.

Data Type

The type of the captured data.

Design Value

The value to use for this capture command in the agent editor. This value can be important when testing scripts in the editor if the scripts depend on captured data.

Excel Column Format

The data format when exporting to Excel or PDF. The ExcelColumnFormat property takes the same kind of formatting string as the Custom formatting string in MS Excel.

Excel Column Width

The width of the column holding the extracted data when exporting to Excel or PDF.

User Defined Design Value

The design value for this command is user defined instead of set automatically when the command is saved.

Use Data Value

Captures a data value instead of an attribute of the selected web element. The web element is ignored when this option is true.

Data Consumer

Specifies the input data to use when the Use Data Value property is set to true.