--- title: Create and Import Models slug: litmusedge-v2/product-features/digital-twins/create-and-import-models description: Learn how to create and import digital twins models. docTags: createdAt: 2022-09-08T19:10:53.000Z --- :::hint{type="info"} **Note**: To access the Digital Twins feature, you need a Scale or Growth Litmus license. ::: You can create Digital Twins models by navigating to **Digital Twins** > **Models**. See [Use Digital Twins to Contextualize Data](docId\:JfTh4HofYGQaCaiMxlodu) to review how to leverage Digital Twins. # Step 1: Create Model You have two options for creating the model. You can create a new model or import a model as a JSON file. ## Create a New Model **To create a new model:** 1. Navigate to **Digital Twins**. The *Models *pane appears. 2. From the *Models *pane, click the **Create a model **tile. The *Create a Model* dialog box appears. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/RgVgMbkVf98fnibVlKx5M_createmodel.png" size="80" width="1266" height="482" caption="The Create a Model tile" position="center" showCaption="true"} 3. Click the **Type** drop-down list and select a model type. 4. Enter the name of the model in the **Name** field. 5. (Optional) Enter a short description of the model in the **Description** field. 6. (Optional) If applicable, select the **UNS Enabled checkbox** and select a UNS connector from the drop-down menu. 7. Click **Add**.**** A new model tile appears in the *Models *pane. ## Import an Existing Model You can import a model as a JSON file. To import an existing model, click the** Import Model** icon, select the `.json` file, and click **Open**. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/LAj9ItVAwnDjSPV0mYRoF_image.png" size="80" width="1920" height="482" caption="Import Model icon" position="center" showCaption="true"} ## Model Versions When you create a model, the model version starts at v.0. When you save the model, the version number is updated. :::hint{type="info"} **Note: **You can identify models sourced from Litmus Edge Manager with a flag. ::: For Litmus Edge version 3.11.1 and later, the version number is also displayed in the model and instance configuration. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/ykav22cg5JaoDGVX2LkeM_image.png" size="80" width="1276" height="804" position="center" showCaption="false"} ## Implement Model Updates to Instances If there are changes to the model that need to be implemented in associated instances, click **Upgrade Instances**. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/l6lqT8nXUCoV2H_1Bo6Av_image.png" size="80" width="1276" height="804" position="center" showCaption="false"} Then, select the instances to upgrade and click **Upgrade**. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/5Os84oYFEY-0PBcVVZtf1_image.png" size="40" width="557" height="388" position="center" caption="Model Changed dialog" showCaption="true"} :::hint{type="info"} **Note**: You have the option to update models with instances and select which instances to update as well. ::: # Step 2: Configure Model After creating the model, you can configure it appropriately for instances. Click the **Model tile** (grid view) or **Model name** (table view) to view the model details. ## Model Image Click the** Upload image** icon to select an image for the model. The image will display for the model tile on the *Models* pane. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/DEQ6AjyYcjo6HsHs6wEX2_image.png" size="80" width="1277" height="841" position="center" showCaption="false"} ## Static Attributes Manage the metadata for the model from the *Static Attributes* tab. :::hint{type="info"} **Note**: You can create up to 2000 static attributes. ::: ### Manually Add Static Attributes **To add static attributes:** 1. Click the **Model tile** (grid view) or **Model name** (table view) to open the model details. 2. From the *Static Attributes* tab, click the** Add item** icon. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/qRvZqvLUt7kiZWOwlMKIW_image.png" size="70" width="1276" height="741" position="center" showCaption="false"} 3. In the **Attribute Name** field, either select an item from the drop-down list or enter a custom attribute name. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/N0H8t8wv5EuOnwUwNnrmo_image.png" size="80" width="1277" height="807" position="center" showCaption="false"} 4. In the **Attribute Value** field, enter a value for the model. 5. When done adding attributes, click **Save Model**. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/bU5KpVnnqIzVVO8CdKnwO_image.png) If you need to filter existing attributes, you can use the search field. ### Import Static Attributes To import static attributes, create a CSV file with the following headers. **Required Headers** - ModelName - Key - Value **Optional Headers** - InstanceName After creating the file, click the model tile, navigate to **Static Attributes**, and click the **Import Attributes** icon. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/2laxtLye4n9xS15IE7Tar_image.png) ### Export Static Attributes To export a CSV file of existing static attributes, click the **Export Attributes** icon. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/OAwIv9XiP4W7MCie7GESH_image.png) ## Transformations Use the *Transformation *tab to transform the data collected in instances by converting raw JSON data to a desired format by defining the JSON-based schema. You can define schema IDs, which can be used to manipulate the payload and define a structure for the payload as the model inherits data. See [Use Digital Twins to Contextualize Data](docId\:JfTh4HofYGQaCaiMxlodu) to review how to format transformations. :::hint{type="info"} **Note: **Litmus Edge versions 3.16.1 and above use **JSONPath **syntax. Incorrect syntax will return `NULL` values. You can see examples of nested keys in [Digital Twin guide](docId\:JfTh4HofYGQaCaiMxlodu). ::: :::hint{type="info"} **Note**: If you update a transformation and remove all elements from the schema, the entire NATS message will be included in any dynamic attribute that has the transformation selected for the *Schema ID*. ::: ### Arrays You can configure arrays in transformations. For example: ```json { "key": [ "$timestamp", "$value", "$metadata", { "key2": "$timestamp", "key3": "$value", "key4": "$metadata" } ], "key5 new": "$timestamp" } ``` ### Configure Transformations **To add a transformation schema:** 1. Click the **Model tile** (grid view) or **Model name** (table view) to open the model details. 2. Click the **Transformation **tab. 3. Click the **Add a Schema** icon. The *Add *dialog box appears. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/EIrP3Y5HwVzc8oGTK3Z2N_image.png" size="80" width="1277" height="602" position="center" showCaption="false"} 4. Enter a name for the schema. 5. Select from **JSON **from *Schema Type* drop-down menu. 6. In the code window, copy and paste the JSON-based schema. 7. (Optional) You can use the *System Variables *in the code drawer. 8. Click **Add**. 9. When done adding attributes, click **Save Model**. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/HS0Azvt0qrTpE9p_Pbgg5_image.png) To edit or delete a schema, click the **Action menu** for the schema and select an option. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/AZjj0404qT6twuQpILYOO_image.png) ## Dynamic Attributes Manage variable data in the model from the *Dynamic Attributes* tab. You have the option of adding a schema ID, which can be used to map dynamic attributes one-to-one for data transformation. :::hint{type="info"} **Note**: You can create up to 2000 dynamic attributes. ::: ### Manually Add Dynamic Attributes **To add a dynamic attribute:** 1. Click the **Add item** icon. ::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/tdOhZhK6LJ6fegKGIp7S8_image.png" size="80" width="1277" height="454" position="center" showCaption="false"} 2. In the **Name **field, enter a name for the attribute. 3. (Optional) Enter a value for **Unit **and select a **Data Type**. 4. The **Skip Key **option is only available when the *Data Type *is set to JSON. 5. (Optional) If you've created data transformation schemas, select one from the **SchemaID **field. 6. When done adding attributes, click **Save Model**. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Rirgb5fwOwwHHEyAUljfY_image.png) If you need to filter existing attributes, you can use the search field. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/8X4gojz2yaC7fJBNaG5Jq_image.png) ### Import/Export Dynamic Attributes To import dynamic attributes, create a CSV file with the following headers. **Required Headers** - ModelName - SchemaID ** Optional Headers** - InstanceName - Topic - Name - Unit - DataType After creating the file, click the model tile, navigate to **Dynamic Attributes**, and click the **Import Attributes** icon. To export a CSV file of existing dynamic attributes, click the **Export Attributes** icon. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/L5fIpkJ-UWov1tSWhBRah_image.png) :::hint{type="success"} **Note: **Check the Sample CSV here. ::File{src="https://api.archbee.com/api/presign/Q116WJTAr1sefeVNvMCF9-V_QXvCRithqA_YF2hjBmw-20250505-190948.csv" label="dynamic-attributes-sample.csv"} ::: ## Schema Use the *Schema *tab to create a custom data structure for the model. :::hint{type="info"} **Note**: Clicking the **Save Model** button will increment the version number, even if no changes are made. ::: ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/lwuguKlSBXurwXu_ibW28_image.png) To create a category for the schema, click the **Action menu** icon for *root *and select **Add Node**. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TVIBE3N7d7WJ-AT2fIszf_image.png) To add attributes to the schema, do one of the following: - Drag and drop attributes from the left-hand list to the canvas under the appropriate category. - Click the **Action menu** for a category and select **Add item to Node**. Then, select the attribute to add. When done configuring the schema, click **Save Model**. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/DPfal6J4rZZmzZv41Xfuk_image.png) ### Import Schemas ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/EVS-LeVQ22cuaCXqurzwO_image.png) To import a CSV file of a schema, create a CSV file with the following headers: - ID - ModelID - Position: Enter the position of the attribute in the schema. - ParentID: If the attribute is under a node/category, enter the ParentID of the node. To get the ParentID, create a new node, export the schema, and then refer to the **ParentID **column. - Name: The name of the attribute. - IsFolder: If it is an attribute, the value is **FALSE**. If it is a node, the value is **TRUE**. - AttributeID - AttributeType ### Export Schemas To export a CSV file of an existing schema, click the **Export Schema **icon. ### Sync Attributes To sync the existing schema, click the **Sync Attributes **icon. All attributes will be appended to the current hierarchy. If they exist, the *static\_attributes *and *dynamic\_attributes *nodes will be recreated. If you wish to proceed, then click **Yes**. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/5L_p8--grreqVNxolbwMa_image.png) ### Clear Schema To clear the schema builder tree, click the **Clear Schema **icon. The model must be saved for the changes to take effect. ![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/-RBn8nyJY0HQeFhDSYSdf_image.png)