Configure a format

About a Format Incoming data in Eliona are mapped to the individual attributes of an asset. Simply put: formats map 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 create a new one. The corresponding menu item is noted in the documentation for the respective connection method.

This is the recommended option for creating 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 ones.

Note: Use this option only to edit existing formats. We recommend not NOT to create new formats this way for the time being.

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	Select which asset type this format applies to. This selection affects which values appear in section [D] appear
[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 presents 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 into the corresponding paths [D2]. If you create a format using option 1, the payload appears in this area. If you later edit a format, the content of the ↗ payload preview appears here
[B5]	Payload entry	A single component of the payload. You can drag and drop these components onto the paths in the attributes [D2]
[C]	Section “Path Configuration”	In this section, you specify which asset the incoming data are mapped to.
[C1]	Identifier	Here you select the individual asset to which the incoming data are mapped. The following are available for selection: - GAI: GAI is used to determine the asset to which the data are 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	Select here where the identifier should be taken from. The following are available: Payload: The identifier is located in the payload Topic: The identifier is located in the topic
[C3]	Identifier	Enter the identifier here. If the identifier is to be the topic, "#" can simply be entered in the path
[C4]	Timestamp selection	Select how the timestamp should be detected. The following are available: - Auto: The timestamp is detected automatically - Field: Drag a payload entry into the field [C5]
[C5]	Field for timestamp entry	If you have selected in [C4] Field selected: 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 defined for this asset type.
[D2]	Path to payload entry	This is one of the attributes defined for this asset type.
[E]	Save	Click here to apply the settings

Procedure

Format Drag and Drop.mp4

2MB

Open

1. Give the format in [A1] a name

2. Select in [A2] select an asset type ▷ The attributes belonging to the respective format appear in [D]

3. Specify in section [C] which individual asset the data should be mapped to.

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

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

You assign individual entries from the payload via drag and drop

Edit an existing format

Proceed as follows to subsequently edit an already existing format.

Fig. 2 - Payload preview at the bottom

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 opens [I]. The payload preview contains a sample payload. The content of the payload preview is shown in the next step in the field [B3] displayed.

4. Insert a payload into the payload preview.

5. Click on [J] ▷ The format configuration opens

6. Make the settings as described in ↗ Procedure described