Agent Command


Navigation:  Agent Commands > Action Commands >

Agent Command

The Agent command is the first command that executes in an agent; all other commands are sub-commands. So, only one Agent command can exist in an agent. The Agent command loads the start URL, which is the first point of data extraction, and also contains all common agent properties (including data export configuration).


The Agent command uses a data provider that provides one or more start URLs, and the command will execute once for each of these URLs.



This Agent command uses a simple data provider to

load a single static start URL


NOTE: The Agent command derives from the Navigate URL command, which loads one or more URLs.


Command Configuration

The configuration screen for the Agent command has four tabs: Common, Action, Data, and Properties. We explain the Properties in the sections below. In the Common tab, you can edit the command name and (optionally) customize the data provider properties.


CSV Data: If you leave a check in the Use Default Input box, the command will provide simple CSV data and use that data as input. Simple CSV data consists of values that you enter directly into the command, so no external CSV is necessary.


You can uncheck the Use Default Input box and choose the Data Provider that will provide the start URLs. The default data provider is a simple data provider that provides a list of static URLs. You can populate the data provider directly by entering the start URLs in the URLs input box.


Use the Action tab to control how the web browser loads the start URLs. See Action Configuration for more information.


Use the Data tab to set the data provider that provides the start URLs. Read more in Using Data Input.


Command Properties

The following properties are specific to Agent commands:




The directory that contains all the agent files. This is a read-only property and will be set automatically when you save the agent.

User Agent

The user agent that the web browser sends to target the web server when requesting web pages.


Process Restart Condition

These properties govern the conditions under which an agent process would restart. Click Process Restart Conditions in the Properties tab to reveal these properties:



Restart On Time Interval

Restarts an agent process at a specific time interval that you can edit.

Restart Time Interval

The number of minutes between each restart - if an agent process is restarting on time intervals.

Restart On Memory Usage

Restarts an agent process at a specific maximum memory usage limit. Use this option to clear JavaScript memory leaks and ensure that the process does not run out of memory.

Max Memory Usage

If Restart on Memory Usage = True, the maximum permissible memory usage (in MB) before an agent process will restart.

Pause Before Restarting

The number of minutes that you want the agent to pause between stopping and restarting an agent process.





Data Provider

The data provider that provides start URLs for the agent. See Using Data Input for more information.

Database Connections

Common database connections that are available to the agent. See the Data section for more information.

Export Target

The destination where data extractions will go. See Exporting Data and Distributing Data for more information.

Input Parameters

A list of input values that you can specify when running an agent from the command line or from the API. See Input Parameters for more information.

Internal Database

The internal database that will store the data during extraction. For more information, see the article, The Internal Database.





Proxy Configuration

See IP Blocking & Proxy Servers for more information.





Email Notification

See Error Logs and Notifications for more information.


See Scheduling for more information.





Assembly References

See Assembly References for more information.

Initialization Script

See Agent Initialization Scripts for more information.


Self-Contained Agents



Author Details

See Building Self-Contained Agents for more information.





Cleanup External Session Data

See Sessions for more information.

Support Sessions

See Sessions for more information.

Remove Internal Session Data Immediately

See Sessions for more information.


User Interface



Max Tree Expansions

The maximum number of nodes that will automatically expand in the Tree View window.

Max Tree Selections

The maximum number of chosen nodes in the Tree View window. Setting this value too high may affect the performance of the editor.


XPath Factory



Max Inner Prospects

The maximum number of inner nodes to examine when optimizing a selection XPath. Setting this value too high may affect the performance of the editor.


The following common command properties are also available to the Agent command:

Navigate URL Command Properties

Data List Command Properties

Action Command Properties

List Command Properties

Container Command Properties

Command Properties