Batch-Based Real-Time Agents - Agent Configuration

This section describes how to configure the agents.

When you select one of the agents, the configurations include the same tabs that are displayed in a batch version of the configuration, with the exception of the Filename Sequence tab, which is not included as it is irrelevant in a real-time workflow.

For details on the configuration of the agents, see the relevant section in the Desktop User's Guide:

Additional Configurations for Collection Agents

When the collection agents are included in a real-time workflow, there are also three additional tabs for each of the agent configurations: Decoder, Decompression and Execution. See the example image below.

Disk agent configuration dialog - Agent tab

Decoder Tab

In the Decoder tab you configure the settings related to the decoding of the collected data.

Disk agent configuration dialog - Decoder tab

Setting	Description

Setting	Description
Decoder	Click Browse to select from a list of available decoders created in the Ultra Format Editor, as well as the default built-in decoders: CSV Format JSON Format MZ Tagged Format Different settings are available depending on the Decoder you select.
Full Decode
MZ Tagged Specific Settings
Tagged UDR Type	Click the Add button to select from a list of available internal UDR formats stored in the Ultra and Code servers, to reprocess UDRs of an internal format and send them out. If the compressed format is used, the decoder automatically detects this.
JSON Specific Settings
UDR Type	Click Browse to select the UDR type you want the Decoder to send out. You can either select one of the predefined UDRs or the `DynamicJson` UDR, which allows you to add a field of type `any` for including payload.
Unmapped Fields	If you have selected `DynamicJson` as UDR Type, you can select the option data in this field in order to include payload. If you have selected another UDR type that contains an any, or a map field, you can select to put any unmapped fields into the field you select in this list. All fields of any or map type in the selected UDR type will be available. If set to (None), any unmapped fields will be lost.
Schema Path	Enter the path to the JSON schema you want to use in this field.
CSV Specific Settings
UDR Type	Click Browse to select the UDR type you want the Decoder to send out. You can either select one of the predefined UDRs or the `DynamicCsv` UDR if the CSV format is not known.
Format	Select the CSV format you want to use; Unix, Mac, Windows, or Excel, or select to define your own customized format. If you select Custom, the following four settings will be enabled.
Delimiter	Enter the delimiter character(s) for the fields in the CSV.
Use Quote	Select this option if quotes are used in the CSV.
Quote	If Use Quote is selected, enter the type of quotes used in the CSV.
Line Break	Enter how line breaks are expressed in the CSV.

Decompression Tab

In the Decompression tab you specify if you want to decompress the files or not.

Disk agent configuration dialog - Decompression tab

Setting	Description

Setting

Description

Compression Type

Select the required decompression algorithm:

No Compression: The agent will not decompress the files. This is the default setting.
GZIP: The agent will decompress GZIP formatted files. No configuration required.
LZO: The files are compressed using LZO compression. If you select this option, the Command Line field is displayed and populated by default with the command lzop -d -c -q. This command allows you to use the lzop unix command to decompress standard input with the LZO algorithm and write the output on standard output. You can enter an alternative lzop command if required. For further information on the lzop command, see https://www.lzop.org/lzop_man.php.