Modify Instance(s) in Digital Twin for one Litmus Edge

to modify instance(s) with litmus excel add ins, you should be familiar with how instances work in digital twins docid\ cmsvdg3aaf7lcky2qlyax 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 prepare a new tool file to manage digital twin instance(s) docid\ vlo483zs86lal5dnmnspu instance(s) have been add instance(s) to digital twin for one litmus edge docid\ ytekatuitkrmmmyrt5qwq to digital twins initial preparation open a new dt instance management tool file in excel if prompted, enable content to allow the code to run make sure the the tool is set connect to is set to one le modify instance(s) import instance(s) import the settings for instance(s) defined on litmus edge using the import instance(s) wizard docid\ xavozf7yih7 eqqhvotlu users can set a filter to reduce the number of instance(s) shown as selection to the user search option select what type of filter is to be used instance name mask set the filter to be applied will be ignored if search option is set to all digital twin models select if you want to search for instance(s) only from a specific model the wizard will show what filter will be applied press the search button to pull the filtered list of instance(s) from litmus edge the user will be shown the filtered list of instance(s) matching their filter select the instance(s) to import and press the import button notes users can choose between press new search to set another filter and search again if the list doesn't show the instance(s) the user wanted to import select all instance(s) using the checkbox in the header row select a group of instance(s) by selecting their respective check box select one instance by selecting the respective check box select no instance and close the wizard pressing the close button instead the selected instance(s) with their settings are imported into the sheet once finished, the user can either p erform another search using the new search button finish the import using the close button the action for each imported tag is set to m for modify mandatory instance settings users can modify these mandatory settings for an instance(s) instance name the name of an existing instance can be changed important this will change the topic for the instance and will cause other services like analytics, integrations or flows not be able to read the data instance definition properties are a mandatory set of instance settings, which are required for defining the digital twin instance static attributes add an instance docid 8z gtb3x2n3 bw6oubcoy displays the metadata values for the model the instance belongs to you can customize the attribute values for the instance this column combines all of these as a single json object it is recommended to use the static attributes wizard docid\ phvgf5e1r7su3lxatxzol when setting your specific values for static attributes dynamic attributes add an instance docid 8z gtb3x2n3 bw6oubcoy displays the variable data attributes configured in the model the instance belongs to you can map one to one relationships with data topics and attributes by updating the topic field for the instance this column combines all of these as a single json object it is recommended to use the dynamic attributes wizard docid\ cnozp fpqhqlns1ktuy5c when setting your specific values for dynamic attributes not mandatory instance settings update interval in seconds enter the interval between retrieving data from the instance the minimum interval allowed is one second dt instance topic review the default topic name for the instance you have the option of entering a custom topic name notes you need to follow the following guidelines for topic names subject based messaging flatten hierarchy select if you want to send hierarchy data in a flat json structure when selected, it will take a nested json object and convert it into a json object with one layer using dot notation this is useful when sending json objects to influxdb, because influxdb does not accept nested json objects publish attributes select if you want to p ublish additionally to the dt instance topic each individual attributes under their own topic (false) notes the publish attributes feature is not available for all supported litmus edge versions if not supported, the column is grayed out notes you can repeat modifying modify instance(s) in digital twin for one litmus edge /#mandatory instance settings and modify instance(s) in digital twin for one litmus edge /#not mandatory instance settings instance settings for every instance you need to modify before modify instance(s) in digital twin for one litmus edge /#executing actions executing actions when all modify instance(s) in digital twin for one litmus edge /#mandatory instance settings and modify instance(s) in digital twin for one litmus edge /#not mandatory instance settings settings for all instance(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 this will check that all required instance settings are provided and logically correct and provide any finding to the user example example below the user did not set a topics (value is "") for the dynamic attribute important the tool can not verify if all provided instance 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 instance(s) can be modified to litmus edge by pressing the verify + execute button this will check that all required instance 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 a add instance(s) m modify instance (s) d delete instance (s) i ignore instance (s) > do nothing to perform all actions, press the yes button 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 the tool will ask if the user wants to re compare the instance(s) against litmus edge to re compare, press the yes button to not re compare, press the no button if the user selected to press the yes button from aboves messagebox, the tool will pull all the instance(s) settings from litmus edge again including the instanceid and also change the action to m for each instance with an instanceid or a for an instance with no instanceid troubleshooting the tool will perform several checks throughout the proces of defining the instance settings if they do not pass successfully, the user will be notified the checks include instance name uniqueness on a litmus edge level the tool checks if a instance name already exist for a specific litmus edge in the tool allowed and not allowed ascii characters for names and descriptions docid\ fnwhcidrnnpizczkuwiyz for instance names and descriptions the user is shown a message box as notification the character(s) are highlighted in red and also shown in a note 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 and dynamic attributes example for an invalid json formatting of the static attributes while it is possible to not define entries for the columns static attributes and dynamic attributes , 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 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 topic defined for dynamic attribute if a model is selected verify that a dt instance topic is defined verify that the topic in the column dt instance topic follows the guidelines for topic names subject based messaging