settings.externalMetaproperty. These link data ingested to the cloud from a non-agent source, such as an external API, to the device.
externaldefine statically configured scenarios derived from the
ardexa.yamlconfiguration file on the device. This was the first metadata configuration scheme implemented in the Ardexa Cloud.
dynamicscenarios, introduced in agent version 2.3.0 are populated by the Ardexa agent. The agent watches specific file system locations on the device for dynamic run and dynamic tail scenarios, typically executable files in
/opt/ardexa/logsrespectively. This scheme scales well with large device configurations and is heavily used by the Machine Plugins system. For more information, see Dynamic Mapping.
csv, the agent expects to receive a CSV-formatted record containing one or more fields. This record is transformed into an event which is sent to the Ardexa Cloud. The set of fields is determined by the
fieldsproperty of the scenario.
fieldsproperty contains a string without a period (
.), the scenario is using a compact fields reference. The value of
fieldswill resolve to a top-level property of the device's
meta. This top-level property will contain an array of fields collected by the scenario.
.), the scenario is using a dynamic compact fields reference. The format of the fields property will be
<table>.<source>. The table and source refer to a scenario within the current scenario type (eg.
dynamic) that contains the actual fields array used by both scenarios.
idin these settings corresponds to the ID of a device setting, as returned in the
settingsproperty of the GET device endpoint.