---
title: Modify Model(s) in Digital Twin for one Litmus Edge
slug: solutions/modify-models-in-digital-twin-for-one-litmus-edge
docTags: 
createdAt: 2025-08-21T13:34:16.336Z
---

To modify Model(s) with Litmus Excel Add-ins, you should be familiar with how Models work in [Digital Twins](docId\:xlj3gvOZyg_52Ue4pB5u7) on Litmus Edge.

# Before You Begin

- You have installed the Litmus Excel Add-ins extension. See [Install Litmus Excel Add-ins](docId\:GZDhBJ1xZZNDDThYOCuuu) for details.
- You have prepared a [Tool file](docId\:Ov8snXeMrb3nVZJJK6DUh).  
- Model(s) have been [added](docId\:TJpsZlSmmrLw_pD_9J-KD) to Digital Twins.

# Initial Preparation

Open a new DT Model Management Tool File in Excel.

If prompted, *Enable Content *to allow the code to run.

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

Make sure the the tool is set **Connect To** is set to *One LE*.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/aO7bYH1Wq3rNXSDl4Y98O_image.png" size="70" width="330" height="152" position="center" showCaption="false"}

# Modify Models(s)

## Import Model(s)

Import the Model Settings for Model(s) defined on Litmus Edge using the [Import Model(s) Wizard](docId:6B2RMRJG50mF_gtiDWT8w).

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/gPCiYe7-BZGbUBRCV5AiX_image.png" size="70" width="399" height="177" position="center" showCaption="false"}

Users can set a filter to reduce the number of Module(s) shown as selection to the user.

- **Search Option**: Select what type of filter is to be used
- **Model Name Mask**: Set the filter to be applied. Will be ignored if **Search Option** is set to *ALL*
- The wizard will show what filter will be applied.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/z7e1bnlfZZVuON-mNGwMG_image.png" size="80" width="889" height="769" position="center" showCaption="false"}

- Press the **Search** button to pull the filtered List of Model(s) from Litmus Edge.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Lqm-D1_3o_vhMXeQgumkz_image.png" size="80" width="889" height="769" position="center" showCaption="false"}

- The user will be shown the filtered List of Model(s) matching their filter.

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

- Select the Model(s) to import and press the **Import** button. 

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

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

Users can choose between:

- Press** New Search** to set another filter and search again if the list doesn't show the Model(s) the user wanted to import
- Select **All **Model(s) using the Checkbox in the Header Row.
- Select a **Group** of Model(s) by selecting their respective Check Box
- Select one **Model **by selecting the respective Check Box
- Select **No **Model and close the Wizard pressing the **Close** button instead.
:::

- The selected Model(s) with their settings are imported into the sheet. 
  Once finished, the user can either.
  - perform another search using the **New Search** button
  - finsih the import using the **Close** button

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

- The **Action** for each imported tag is set to **M** for modify.

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

## Mandatory Model Settings

Users can modify these mandatory settings for a Model(s).

**Model Name:** The Name of an existing Model can be changed.

:::hint{type="warning"}
**Important: **This will change the topic for the Instances of this model and will cause other services like Analytics, Integrations or Flows not be able to read the data
:::

**Model Definition Properties** are a mandatory set of Model Settings, which are required for defining the Digital Twin Model Data structure.

- **Static Attributes**: [Static Attributes](docId\:zPaDX1lMmE0F44V7r6v6Q) allow  to manage the metadata for the model. This column combines all of these as a single JSON Object.
  It is recommended to use the [Static Attributes Wizard](docId\:sGCUuaHdBPoGMkT6m6cK-) when setting your specific values for Static Attributes.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/5NMeR9IP_mcfFFqP8Q7tJ_image.png" size="70" width="437" height="381" position="center" showCaption="false"}

- **Transformations**: [Transformations](docId\:zPaDX1lMmE0F44V7r6v6Q) allow to define how to transform the data collected in instances by converting raw JSON data to a desired format by defining the JSON-based schema by the model . This column combines all of these as a single JSON Object.
  It is recommended to use the [Transformations Wizard](docId\:szGNXUppusSQOGR75XU0N) when setting your specific values for Transformations.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/QK0ydGSjSoolqoP6Qk-UW_image.png" size="70" width="468" height="342" position="center" showCaption="false"}

- **Dynamic Attributes**: [Dynamic Attributes](docId\:zPaDX1lMmE0F44V7r6v6Q) allow  to manage variable data in the model.  This column combines all of these as a single JSON Object.
  It is recommended to use the [Dynamic Attributes Wizard](docId\:pm4MPWmlpYLTf5lQRO8g6) when setting your specific values for Dynamic Attributes.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/NAjEVZB2HvKdLHKMC2Woj_image.png" size="70" width="459" height="360" position="center" showCaption="false"}

- **Model Schema**: [Model Schema](docId\:zPaDX1lMmE0F44V7r6v6Q) allows to create a custom data structure for the model. This column combines all of these as a single JSON Object.
  It is recommended to use the [Model Schema Wizard](docId\:sWQiuan_1cmI7EG-QoFlE) when setting your specific Model Schema.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/8JDjljlgV-KI7qaCS0OVc_image.png" size="70" width="434" height="362" position="center" showCaption="false"}

## Not Mandatory Model Settings

- **Model Description**: Enter a short description of the model in the Description field
- **UNS Enabled:** Select if you want to enable Litmus UNS for the Model.
- **UNS Connector**: If Litmus UNS Connector(s) are defined for the Litmus Edge, select which Litmus UNS Connector to use to populate the Static Attributes with the Litmus UNS Hierarchy. 

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

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

Selecting an UNS Connector will automatically modify the respective Static Attributes associated with the UNS Connector as well as adding them to the Model Schema under the metadata folder by default.


Before changing UNS Connector:

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

After changing UNS Connector:

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/XyJGDcI3KM-1PF-Sn8-un_image.png)


:::

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

You can repeat modifying [mandatory](docId\:ypTo-nUrYoGAXCaPaZp3M) and [not mandatory](docId\:ypTo-nUrYoGAXCaPaZp3M) Model settings for every Model you need to modify before [executing Actions](docId\:ypTo-nUrYoGAXCaPaZp3M).
:::

## Executing Actions

When all [mandatory](docId\:ypTo-nUrYoGAXCaPaZp3M) and [not mandatory](docId\:ypTo-nUrYoGAXCaPaZp3M) settings for all Model(s) are set they are ready to be modified.

It is **Recommended **but not mandatory to verify the configuration first without executing the Action by pressing the **Verify Only** button. 

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

This will check that all required Model Settings are provided and logically correct. And provide any finding to the user.
Example: Below the user not select a UNS Connector despite having enabled UNS in column **UNS Enabled**.

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

:::hint{type="warning"}
**Important: **The tool can not verify if all provided Model settings are factually correct. For example it can not verify that the value of a Static Attribute is correct for what the user want to achieve.
:::

The Model(s) can be modified to Litmus Edge by pressing the **Verify + Execute** button.

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

This will check that all required Model Settings are provided and logically correct. And provide any finding to the user.
If no issues have been identified, the tool will verify that the user wants to execute **ALL** the actions from the **Action** Column:

1. **A**: Add Model(s)
2. **M**: Modify Model(s)
3. **D**: Delete Model(s)
4. **I**: Ignore Model(s) -> do nothing

To perform all actions, press the **Yes** button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Qz5tBypCu-cZMWvEOqRCL_image.png" size="80" width="710" height="341" position="center" showCaption="false"}

The Tool will perform ALL Actions row by row. When finished, a result Summary is shown. Close the Result Summary by pressing the **X** close button.

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

The tool will ask if the user wants to re-compare the Model(s) against Litmus Edge.
To re-compare, press the **Yes **button.
To not re-compare, press the **No** button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/QrN4yDtwb_3YtgewYrJcW_image.png" size="70" width="401" height="151" position="center" showCaption="false"}

If the User selected to press the **Yes **button from aboves messagebox, the tool will pull all the Model settings from Litmus Edge again including the ModelID and also change the **Action **to **M** for each Model with a ModelID or **A **forModel with no ModelID. 

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/hGNty-3uSpHHS9ObK-nrX_image.png)

# Troubleshooting

The Tool will perform several checks throughout the proces of defining the Model settings.  If they do not pass successfully, the user will be notified. 
The checks include:

- Model Name uniqueness on a Litmus Edge level. 
  - The tool checks if a **Model Name** already exist for a specific Litmus Edge in the Tool.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/NQB_YaQF8kRp-iC6dbial_image.png" size="80" width="777" height="500" position="center" showCaption="false"}

- [Allowed and not allowed Ascii Characters](docId\:FNwHcidRnnPizCZkUWiYz) for Model Names and Descriptions
  - The user is shown a message box as notification.

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

- The character(s) are highlighted in red and also shown in a note.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/d52-wcwtZZKJI98_xoA3B_image.png" size="80" width="400" height="272" position="center" showCaption="false"}

- See [Allowed and not allowed Ascii Characters for Names and Descriptions](docId\:FNwHcidRnnPizCZkUWiYz) for a full list for both Names and Descriptions.
- Correct JSON formating for **Static Attributes, Trasnformations, Dynamic Attributes** and **Model Schema**.
  - Example for an invalid JSON formatting of the Static Attributes

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/VpiS_ZQ1m3w2jqj9FllIy_image.png" size="70" width="495" height="516" position="center" showCaption="false"}

- While it is possible to not define entries for the columns **Static Attributes, Trasnformations, Dynamic Attributes** and **Model Schema**, the tool verifieds if any of these columns are empty**. **As this will cause Instances of this model to not return data or not return expected data**.**

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



- While it is possible to leave some Values for **Static Attributes **and** Dynamic Attributes** empty, the tool checks for such empty values**. **As this will cause Instances of this model to not return data or not return expected data**.**
  Example: No SchemaID defined for Dynamic Attribute.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Ut_tm1OoXh4m6RZo4Bt9-_image.png" size="60" width="430" height="577" position="center" showCaption="false"}