Add Instance(s) to Digital Twin for multiple Litmus Edge

to add 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) on multiple litmus edge docid\ zl of7krtllwfcxvzs8e 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 for the connect to option set to multiple le add instance (s) mandatory instance settings set the target litmus edge ip enter the ipv4 of the litmus edge you want add the device on into column target litmus edge ip notes if no api key for the target litmus edge was previously provided, the user will need to provide the api key model and instance name provide the following two instance settings to start the definition of an instance model name select the model for which you want to define the instance for instance name provide the name for the instance notes the tool will verify that the entries for the instance name column are unique for the litmus edge defined in column target litmus edge ip and notify the user in case the same instance name was already used the tool will automatically pull the settings from the model similar to how the ui on litmus edge prepopulates the instance wizard it is recommended to click the compare vs le button to check if an instance with the selected model and name may already be defined on litmus edge if no instance with the selected model and name combination is defined, the row will stay as a for the action notes if none of the instances in the sheet exist, therefore not having an instanceid, the tool will not attempt to read any instance settings if an instance with the selected model and name combination is already defined, the row will change to m for the action and the settings of the instance will be pulled notes this doesn't need to be done for every instance individually but can instead be done once all desired instance(s) have been added to the sheet instance definition properties 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 i f all add instance(s) to digital twin for multiple litmus edge /#mandatory instance settings ( ) instance settings are provided, as well as all add instance(s) to digital twin for multiple litmus edge docid\ c9tbavvlthioe03qwfmda settings are changed, the instance is ready to be added to litmus edge to add more instance(s) to the sheet, repeat the process described under add instance(s) to digital twin for multiple litmus edge /#add instance s for every instance you want to add executing actions when all add instance(s) to digital twin for multiple litmus edge /#mandatory instance settings and add instance(s) to digital twin for multiple litmus edge docid\ c9tbavvlthioe03qwfmda settings for all instance(s) are set, they are ready to be added 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 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 wants to achieve the instance(s) can be added to litmus edge by pressing the verify + execute button the tool will group all the instance(s) based on the litmus edge(s) defined in column target litmus edge ip for each litmus edge 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 moinstancedel (s) i ignore instance (s) > do nothing to perform all actions, press the yes button the tool will perform all actions row by row for the litmus edge when finished, a result summary is shown for each litmus edge close the result summary by pressing the x close button to continue with the next litmsu edge once all litmus edge have been processed, t he tool will ask if the user wants to re compare all 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 settings from litmus edge again including the instanceid and also change the action to m for each instance with a instanceid or a for an instance with no instanceid 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 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