Container Commands Export Overview

Export: This option determines whether the data extracted by this command will be exported or not. This option allows users to enable or disable export functionality for the command. If you uncheck the box, the data will not be exported. By default, it is checked to export the data.

Data Required

The Data Required property controls whether parent records without any child data are included in the export. It only affects commands with a parent-child structure, such as categories with products or pages with items.

• Default: Behaves like Yes for relevant commands. For commands without child data, changing this property has no effect.

• Yes: Parent records without child data are excluded from the export.

• No: Parent records are always included, even if they have no child data.

Example:

• Page Area List: Categories (parent) with no products (child) are removed when Data Required = Yes or Default.

• Action Repeater: Pages with no people are removed when Data Required = Yes or Default.

This ensures exported data only includes meaningful parent-child pairs, avoiding empty rows.

Separate Export Table:

This option allows users to export data into a separate file. By default, it is unchecked. When enabled, a new file is generated using the name specified in the Export Name field. If multiple agents are exporting to the same table, ensure the same export name is used for consistency.

• Export Name: Defines the name of the exported file (e.g., database table, spreadsheet, CSV file). If left blank, the command name will be used. When exporting data to the same table across multiple agents, this name must be identical for all.

• Empty row handling: Specifies the action to take when an exported data row is empty. The available options are:

  • Keep: Retains empty rows. This is the default setting.

  • Remove : Deletes empty rows.

  • Remove With Error: Deletes empty rows and increments the error count.

  • Remove With Failure: Causes the export to fail if empty rows are found.

• Empty table handling: Specifies the action to take when the exported data table is empty. The available options are:

  • Keep: Retains the empty table. This is the default setting.

  • Remove : Deletes the empty table.

  • Remove With Error: Deletes the empty table and triggers an error message.

  • Remove With Failure: Causes the export to fail if the table is empty.

• Key name: This property specifies the name of the primary key column in the exported table (database table, spreadsheet, CSV file), if this container generates a new table. The export name postfixed with “ID” is used if this property is empty. If multiple agents are exporting data to the same table,  then you must set this option to the same value for all those agents.

• Key sort order: This property specifies the sort order  of the primary key column in the exported table (database table, spreadsheet, CSV file), if this container generates a new table. Default value is set to 0.

• Parent key name: Specifies the name of the parent key column in the exported table (database table, spreadsheet, CSV file), if this container generates a new table. The parent ID column name is used if this property is empty. If multiple agents are exporting data to the same table, then you must set this option to the same value for all those agents.

• Parent key sort order: Specifies the sort order of the parent key column in the exported table (database table, spreadsheet, CSV file), if this container generates a new table. Default Value is 0.

• Export Method: Determines how data is exported from the container. The default value is 'Add Rows', which allows users to append rows only, while columns must be added separately. Different methods for data extraction are available, including:

  • Add Columns: Adds new columns to the table.
    These fields allow you to dynamically assign column names and values based on other commands in the agent.

    • Name Command(Optional): When you enter a command name here, the data extracted by that command is used as the column header (name) in the export.

    • Value Command(Optional): When you enter a command name here, the data extracted by that command is used as the value in the export.

    This makes it possible to create flexible, dynamic exports where column names and values are determined at runtime from other commands.

  • Add Rows: Adds new rows to the table (default).