Store External Data Entries


This action stores several values at a time through the Data Exchange API. Theses values are referred to as “External Data” in the Runtime and Results tabs. A typical use is to grab business-related metrics through a Variable Extractor or through the SQL action and store them for later analysis. The entry values can be structured in a tree by specifying different paths in the path parameter.

Type Advanced Action
Version 1.0.0
Maturity Stable
Author Neotys
License BSD Simplified
NeoLoad 5.0 (Ultimate, Enterprise or Professional Edition w/ Integration & Advanced Usage option required)
NeoSense Not Compatible
Requirements Java Client for Data Exchange API
Bundled in NeoLoad Bundled in NeoLoad 5.1

For NeoLoad 5.0: Jar, Sources

For NeoLoad 5.1: Bundled in NeoLoad (See the documentation)

Note: If at least one of the variable values is not numerical, all values will be displayed in the URL column of the External Data.


  • variableName: The name of the multi-valued variable which contains the values to be stored. Example: “myValues” (not “${myValues}”).
  • path: The string representing the list of nodes that contains the entry.
  • unit (optional): The unit of the entry.
  • code (optional): The string code of the status associated to the entry.
  • message (optional): The message of the status associated to the entry.
  • state (optional): The state of the status associated to the entry. Possible values are PASS and FAIL.
  • DataExchangeAPIURL: The url of the DataExchange server. Typically the NeoLoad Controller.
  • DataExchangeAPIKey (optional): The identification key specified in NeoLoad.

Status Codes

  • NL-STORE-EXTERNAL-DATA-ENTRIES-ACTION-01: There was an issue parsing the parameters.
  • NL-STORE-EXTERNAL-DATA-ENTRIES-ACTION-02: The variable was not found.
  • NL-STORE-EXTERNAL-DATA-ENTRIES-ACTION-03: There was an issue initializing the DataExchange API client.


  • An example of values stored from a multi-valued variable:
    • variableName: ids
    • path: index|ids
    • DataExchangeAPIURL: http://localhost:7400/DataExchange/v1/Service.svc/

  • A full example of values stored from a multi-valued variable:
    • variableName: categories
    • path: index|categories
    • message: The handle is invalid.
    • state: FAIL
    • DataExchangeAPIURL: http://localhost:7400/DataExchange/v1/Service.svc/
    • DataExchangeAPIKey: myKey


  • 1.0.0 – Initial release