Configure a Format

Using a format, incoming data in Eliona is assigned to the individual attributes of an asset of any asset. In simple terms: formats assign incoming data to individual Eliona assets.

Create a Format

There are two ways to create a format:

1. When configuring a connection

2. Via the "Format" menu

Option 1 - When Configuring a Connection

When you configure a connection, you have the option to select an existing format or to create a new format. The corresponding menu item is noted in the documentation of the respective connection method.

This is the recommended option to create a new format.

Option 2 - In the "Format" Menu

In the "Formats" menu, you will see an overview of all existing formats. There you can edit existing formats and create new formats.

Note: Only use this option to edit existing formats. We recommend NOT creating new formats in this way for now.

Configure Format

Overview

Element	Title	Details
[A]	Section "Configuration"	In this section, details about the format are configured
[A1]	Name	Give the format a name in this field
[A2]	Asset type	Choose for which asset type this format applies. This selection influences which values appear in section [D]
[B]	Section "Payload"	In this section, a preview of the incoming data is displayed.
[B1]	Code Preview	Click here to open the code preview. The code preview displays the information from section [D] in the form of a payload.
[B2]	Topic	The topic
[B3]	Topic path	The path to the respective payload entry
[B4]	Payload	This is the transmitted payload. Drag values from the payload to the corresponding paths [D2]. If you create a format via Option 1, the payload appears in this area. If a format is edited afterward, the content of the ↗ Payload Preview appears here
[B5]	Payload entry	A single component of the payload. You can drag and drop these components to the paths in the attributes [D2]
[C]	Section "Path Configuration"	In this section, you specify to which asset the incoming data is mapped.
[C1]	Identifier	Here you select the individual asset to which the incoming data is mapped. Options are: - GAI: The GAI is used to determine the asset to which the data is mapped - External: Instead of the GAI, the "Associated ID" of an asset is used. ↗ See [M1] in Asset -> Configure an asset -> Available settings
[C2]	Location of the identifier	Here you select where the identifier is taken from. Options are: Payload: The identifier is in the payload Topic: The identifier is in the topic
[C3]	Identifier	Enter the identifier here. If the identifier should be the topic, you can simply enter "#" in the path
[C4]	Timestamp selection	Choose how the timestamp should be recognized. Options are: - Auto: The timestamp is automatically recognized - Field: Drag a payload entry into field [C5]
[C5]	Field for timestamp entry	If you have selected Field in [C4]: Simply drag the timestamp [B5] into the field
[C6]	Append function	click to append a JavaScript function
[C7]	All functions	View all existing functions
[D]	Input	In this section, the payload entries are assigned to the individual attributes.
[D1]	Attribute	This is one of the attributes that are set for this asset type.
[D2]	Path to the payload entry	This is one of the attributes that are set for this asset type.
[E]	Save	Click here to save the settings

Procedure

2MB

Format Drag and Drop.mp4

Open

1. Give the format a name in [A1]

2. In [A2], select an asset type

   ▷ The attributes belonging to the respective format appear in [D]

3. In section [C], specify which individual asset the data should be mapped to.

4. Drag the individual payload entries [B2] to the respective fields [D2] using drag and drop

5. Repeat step 4 until all desired attributes have been assigned to the respective payload entries.

You assign individual entries from the payload using drag and drop.

Edit an existing format

Proceed as follows to edit an already existing format afterward.

Fig. 2 - Bottom the payload preview

1. Click on [F]

2. Click on [G]

   ▷ A list of all formats appears

3. For the format you want to edit: Click on [H]

   ▷ The payload preview [I] opens. The payload preview contains an example payload. The content of the payload preview is displayed in field [B3] in the next step.

4. Insert a payload into the payload preview.

5. Click on [J]

   ▷ The format configuration opens

6. Make the settings as described in ↗ Procedure