# Configure a format

About a *format* incoming data in Eliona is assigned to the individual attributes of an asset of any asset. Simply put: formats assign incoming data to individual Eliona assets.&#x20;

## 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 format. The corresponding menu item is noted in the documentation for the respective connection method.

{% hint style="success" %}
This is the recommended option for creating a new format.
{% endhint %}

### 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.

{% hint style="warning" %}
Note: Use this option only to edit existing formats. We recommend initially creating new formats **NOT** in this way.
{% endhint %}

## Configure format

### Overview

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/mWQ3OqZqlSPEFcdKpM1v/DocsVerbindungen%20-%20Formate%201.png" alt=""><figcaption></figcaption></figure></div>

<table data-full-width="true"><thead><tr><th width="109.33333333333331">Element</th><th width="213">Title</th><th>Details</th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Section “Configuration”</td><td>In this section, details about the format are configured</td></tr><tr><td><strong>[A1]</strong></td><td>Name</td><td>Give the format a name in this field</td></tr><tr><td><strong>[A2]</strong></td><td>Asset type</td><td>Select which asset type this format applies to. This selection affects which values appear in section <strong>[D]</strong> appear</td></tr><tr><td><strong>[B]</strong></td><td>Section “Payload”</td><td>In this section, a preview of the incoming data is displayed.</td></tr><tr><td><strong>[B1]</strong></td><td>Code preview</td><td>Click here to open the code preview. The code preview presents the information from section <strong>[D]</strong> in the form of a payload.</td></tr><tr><td><strong>[B2]</strong></td><td>Topic</td><td>The topic</td></tr><tr><td><strong>[B3]</strong></td><td>Topic path</td><td>The path to the respective payload entry</td></tr><tr><td><strong>[B4]</strong></td><td>Payload</td><td>This is the transmitted payload. Drag values from the payload into the corresponding paths <strong>[D2]</strong>. If you create a format using option 1, the payload appears in this area. If you edit a format afterward, the content of the ↗ payload preview appears here</td></tr><tr><td><strong>[B5]</strong></td><td>Payload entry</td><td>An individual component of the payload. You can drag and drop these components onto the paths in the attributes <strong>[D2]</strong></td></tr><tr><td><strong>[C]</strong></td><td>Section “Path configuration”</td><td>In this section, you specify to which asset the incoming data is mapped.</td></tr><tr><td><strong>[C1]</strong></td><td>Identifier</td><td>Here you select the individual asset to which the incoming data is mapped. The available options are: - GAI: 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. <a href="../../../documentation/assets/configure-an-asset#verfuegbare-einstellungen">↗ <em>See <strong>[M1]</strong> in Asset -> Configure an asset -> Available settings</em></a></td></tr><tr><td><strong>[C2]</strong></td><td>Location of the identifier</td><td><p>Select here where the identifier is taken from. The available options are: </p><ul><li>Payload: The identifier is in the payload </li><li>Topic: The identifier is in the topic</li></ul></td></tr><tr><td><strong>[C3]</strong></td><td>Identifier</td><td>Enter the identifier here. If the identifier is to be the topic, "<strong>#"</strong> can simply be entered in the path</td></tr><tr><td><strong>[C4]</strong></td><td>Timestamp selection</td><td>Select how the timestamp should be detected. The available options are: - Auto: The timestamp is detected automatically - Field: Drag a payload entry into the field <strong>[C5]</strong></td></tr><tr><td><strong>[C5]</strong></td><td>Field for timestamp entry</td><td>If you have selected <strong>[C4]</strong> <em>Field</em> : simply drag the timestamp  <strong>[B5]</strong> into the field</td></tr><tr><td><strong>[C6]</strong></td><td>Attach function</td><td>click to attach a JavaScript function</td></tr><tr><td><strong>[C7]</strong></td><td>All functions</td><td>View all available functions</td></tr><tr><td><strong>[D]</strong></td><td>Input</td><td>In this section, the payload entries are assigned to the individual attributes.</td></tr><tr><td><strong>[D1]</strong></td><td>Attribute</td><td>This is one of the attributes defined for this asset type.</td></tr><tr><td><strong>[D2]</strong></td><td>Path to payload entry</td><td>This is one of the attributes defined for this asset type.</td></tr><tr><td><strong>[E]</strong></td><td>Save</td><td>Click here to apply the settings</td></tr></tbody></table>

### Procedure

{% file src="<https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/22qEALiwojcWYUgzr7Di/Format%20Drag%20and%20Drop.mp4>" %}

1. Give the format in **\[A1]** a name
2. Select an asset type in **\[A2]** ▷ 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]** via drag and drop into the respective fields \[D2]
5. Repeat step 4 until all desired attributes have been assigned their 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.

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/CgH8QZydP6nrSIkGew44/DocsVerbindungen%20-%20Formate%202.png" alt=""><figcaption><p>Fig. 2 - Below the payload preview</p></figcaption></figure></div>

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 displayed 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](https://docs.buildings.ability.abb/collection/english-v14/foreword) described
