---
title: Meta Data Wizard
slug: solutions/meta-data-wizard
docTags: 
createdAt: 2025-08-15T14:08:59.332Z
---

If for a Device the user has selected for the Column **Enable Meta Data&#x20;**&#x74;o be TRUE, the user will need to provide a specifically formatted JSON Object.

To assist with the definition of the JSON Object, the Device Management Tool provides a Meta Data Wizard.

# Access the Meta Data Wizard

:::hint{type="info"}
**Notes**:

To access the Meta Data Wizard it is required that:

- The Column **Meta Data** is not grayed out -> Column **Enable Meta Data** is set to TRUE
- A **Device Name** is defined
- A **Driver Name** is selected
- A **Driver Group Name** is selected
:::

Select the respective cell in Column **Meta Data&#x20;**&#x66;or the Device you want to define Meta Data.

If all conditions are met, the **Meta Data Wizard** button is shown in the Help section of the **LitmusConfiguration&#x20;**&#x72;ibbon.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/4C3pWMeUq3GXsecJODmeB_image.png)

Open the Meta Data Wizard by pressing the **Meta Data Wizard** button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/C_w52hP3vWOMqtIOIpYXS_image.png" size="60" width="274" height="147" position="center" showCaption="false"}

The Meta Data wizard will show.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/jjYl1sJnRtFjTNI7qS_Me_image.png)

:::hint{type="info"}
**Notes**:

If the Device has already Meta Data defined, they will be shown in the List.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/LpG58igNGeQBInCnHXGdd_image.png" size="80" width="1331" height="681" position="center" showCaption="false"}
:::



# Add a new Meta Data Key-Value Pair

To add a new Key-Value pair, press the **Add&#x20;**&#x6F;ption from the left panel.&#x20;

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Py3xRChellXWCJmzVF6S5_image.png" size="80" width="948" height="589" position="center" showCaption="false"}

Provide both the **Name&#x20;**&#x61;nd the **Value**, which are mandatory, for the Key-Value pair.
To accept the entry press the green **Modify** button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/cXXrrN5Qo-ZtFYHd-ODQg_image.png" size="80" width="952" height="525" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

If not both Name and Value are provided, the **Modify&#x20;**&#x62;utton will remain grayed out and the Key-Value pair can not be saved.

The wizard also performs a verification for each entry and will show any violation in red. In this case the **Modify** button will also be grayed out to prevent the saving of any invalid Key-Value pair.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ULDqNQeQX_TQW9c_O-7vc_image.png" size="80" width="938" height="505" position="center" showCaption="false"}
:::

## Adding Litmus UNS Key-Value Pairs

If the Litmus Edge for which the Device is defined is connected to Litmus UNS,  the Meta Data Wizard shows a drop down from with all available Litmus UNS integrations.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/_e9ToKa54eHxY_xdBat5L_image.png" size="80" width="625" height="607" position="center" showCaption="false"}

Select one of the Litmus UNS integrations to add their respective hierarchy Key-Value pairs.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/AupGk8IN92U0wQuGa5HV4_image.png" size="80" width="471" height="126" position="center" showCaption="false"}

Press the TAB key to confirm the selection. This will add the KEy-Value pairs with their respective default values.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Kyjdzq06-3ZufiuZ3c-v0_image.png" size="80" width="948" height="614" position="center" showCaption="false"}

To change the value, [edit](docId\:tECprcmT6i2KyOPTH9DFZ) the Key-Value Pairs.

:::hint{type="info"}
**Notes**:

You can only use one set of Litmus UNS Key-Value pairs.
If you select another Litmus UNS Integration

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TwvpBWKwbfbubVrSXNK8S_image.png" size="80" width="774" height="613" position="center" showCaption="false"}

it will overwrite the previous Key-Value pairs.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/0V9QJJ3IuBopc3Hby8Tgl_image.png" size="80" width="679" height="303" position="center" showCaption="false"}
:::

# Edit a Meta Data Key-Value Pair

Select the Key-Value pair you want to edit to open its **Edit&#x20;**&#x73;creen.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TngEPnPy35ffYHja6vZUi_image.png" size="80" width="937" height="567" position="center" showCaption="false"}

Edit the **Name&#x20;**&#x61;nd/or **Value&#x20;**&#x61;nd press the **Modify&#x20;**&#x62;utton.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/T9SdDMeFCT7L_gpM7jP2A_image.png" size="80" width="941" height="542" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

If not both Name and Value are provided, the **Modify&#x20;**&#x62;utton will remain grayed out and the Key-Value pair can not be saved.

The wizard also performs a verification for each entry and will show any violation in red. In this case the **Modify** button will also be grayed out to prevent the saving of any invalid Key-Value pair.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ULDqNQeQX_TQW9c_O-7vc_image.png" size="80" width="938" height="505" position="center" showCaption="false"}
:::

# Delete a Meta Data Key-Value Pair

Select the Key-Value pair you want to delete to open its **Edit&#x20;**&#x73;creen.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TngEPnPy35ffYHja6vZUi_image.png" size="80" width="937" height="567" position="center" showCaption="false"}

To delete the Key-Value Pair press the **Delete&#x20;**&#x62;utton.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/B9YjG1exXBV2CDXW2g9ME_image.png" size="80" width="934" height="510" position="center" showCaption="false"}

# Save the Meta Data&#x20;

To save all the defined Key-Value pairs as a new Meta Data JSON Object, press the **Save&#x20;**&#x62;utton.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/3XjyIzGZTsb-1g5hMdWRl_image.png" size="80" width="940" height="586" position="center" showCaption="false"}

This will create the correctly formatted Meta Data JSON Object and store it in column **Meta Data** for the device.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/fiLL-bhlVTrJzjUEhjZ87_image.png)

:::hint{type="warning"}
**Important:&#x20;**&#x54;his will overwrite the current value in column **Meta Data**.
:::

# Cancel the Meta Data Wizard

If a user decides to not save the current Meta Data Wizard configuration, they can press the **Cancel&#x20;**&#x62;utton.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/XPQ-aqX3f7WLCEEtcmu4C_image.png" size="80" width="1287" height="679" position="center" showCaption="false"}

:::hint{type="info"}
**Notes**:

This will not overwrite the  current value in column **Meta Data**.
:::

