Modify Tag(s) in DeviceHub on multiple Litmus Edge

to modify tag(s) with litmus excel add ins, you should be familiar with how tags work in devicehub docid 55lxgtilwfsygkxzrdfod 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 devicehub tag(s) docid\ p1a a8cn h5o1cbu64xpm tag(s) have been add tag(s) to devicehub for multiple litmus edge docid\ bm4stcoywu ooq6ncgbxb to devicehub initial preparation open a new tag management tool file in excel if prompted, enable content to allow the code to run make sure the the tool is set to multiple le for the connect to option modify tag(s) import tag(s) import the tag settings for tag(s) defined on litmus edge using the import tag(s) wizard docid\ rusqrggffrw5fgw jv0hw users can set a filter to reduce the number of tag(s) shown as selection to the user le device ip select or enter the ipv4 of the litmus edge you want to import tag(s) from notes you may need to provide the api key if the litmus edge has not been used with the tool search option select what type of filter is to be used tag name mask set the filter to be applied will be ignored if search option is set to all devicehub devices select if you want to tags only from a specific device important if more than 50000 tags are defined on the selected litmus edge, a user can only search for tags for one single devicehub device the wizard will show what filter will be applied press the search button to pull the filtered list of tag(s) from litmus edge the user will be shown the filtered list of tag(s) matching their filter select the tag(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 tag(s) the user wanted to import select all tag(s) using the checkbox in the header row select a group of tag(s) by selecting their respective check box select one tag by selecting the respective check box select no tag and close the wizard pressing the close button instead the selected tag(s) with their settings are imported into the sheet once finished, the user can either p erform another search using the new search button finsih the import using the close button the action for each imported tag is set to m for modify mandatory tag settings users can modify these mandatory settings for a tag(s) tag name the name of an existing tag can be changed important this will change the topic for the tag and will cause other services like analytics, integrations or flows not be able to read the data tag definition properties are a mandatory set of tag settings, which are required for the request the data from a device based on the driver, the tag definition properties can be added using either the modify tag(s) in devicehub on multiple litmus edge /#tag address translator most tags require a set of three values to define the tag definition register type the type of the register used when the tag was setup on the device this is driver specific tag value data type the value type of the tag this is driver specific register address / path the numeric register address of a tag on the device or the path string of the tag this is driver specific the tool will automatically modify potential modify tag(s) in devicehub on multiple litmus edge /#not mandatory tag settings with a default configuration for the driver similar to how the ui on litmus edge prepopulates the tag wizard notes for some drivers, tags can require different tag definition properties, which can lead to certain columns being grayed out as they do not apply to read data for these tags, users provide the respective settings through the modify tag(s) in devicehub on multiple litmus edge /#not mandatory tag settings column tag address translator for some drivers, the tool features a tag address translator which can be used to provide the address in their typical format and translates it into the tag definition properties used by litmus to be able to use the tag address translator, the column (optional) tag address translator has to be not grayed out tag address translator not available tag address translator available type in the tag address in their typical driver specific format example siemens s7 1500 the tag address translator will parse the provided address and set the respecitve three tag definition properties and potential driver specifics example siemens s7 1500 notes it is possible that an address could be defined with one of multiple tag data value types example a siemens tag with and address like dbx d y could be of tag data value type dword > default dint real in these cases the tag address translator will by default request from the user to select the tag data value type the form shows the default tag data type which you can accept without the need of selecting it using the use default button otherwise select the tag value data type you need from the drop down and press the save button the user can also force the tag address translator to always use the default tag data value type not mandatory tag settings based on your sheet mode setting, modify any of the modify tag(s) in devicehub on multiple litmus edge /#not mandatory tag settings in fast mode or modify tag(s) in devicehub on multiple litmus edge /#not mandatory tag settings in extended mode as needed not mandatory tag settings in fast mode each tag has a number of not mandatory settings which can be used to meeat specific needs polling interval in seconds the time between the litmus edge requesting data from the device for millisecond values, provide the value as decimal driver specifics many drivers require very unique tag definition properties specific to their make and model this column combines all of these as a single json object with a default configuration it is recommended to use the driver specific wizard docid 48vyrem4nexaxpxe5ci7x when setting your specific values for these driver specific settings not mandatory tag settings in extended mode each tag has a number of not mandatory settings which can be used to meet specific needs tag description a short description of the tag polling interval in seconds the time between the litmus edge requesting data from the device for millisecond values, provide the value as decimal count the number of consecutive registers including the one defined for this tag if the value is larger 1, the returned data will be an array publish on cov only only publish a new value to the message broker if the value changes tag formula enter a formula for the tag to process the generated data see tag formula variables docid\ io7xgyrdvv vmpnfxoaci to learn more meta data provide a json object which holds all the meta data you want to add to the tag see organize device and tag data by using metadata docid\ mu 6j6zhi0cvchdad0w8n to learn more it is recommended to use the meta data wizard docid\ geidkenk7d4poixgwtpwm driver specifics many drivers require very unique tag definition properties specific to their make and model this column combines all of these as a single json object with a default configuration it is recommended to use the driver specific wizard docid 48vyrem4nexaxpxe5ci7x when setting your specific values for these driver specific settings notes you can repeat modifying modify tag(s) in devicehub on multiple litmus edge /#mandatory tag settings and modify tag(s) in devicehub on multiple litmus edge /#not mandatory tag settings tag settings for every tag you need to modify before modify tag(s) in devicehub on multiple litmus edge /#executing actions executing actions when all modify tag(s) in devicehub on multiple litmus edge /#mandatory tag settings and sheet mode dependend modify tag(s) in devicehub on multiple litmus edge /#not mandatory tag settings settings for all tag(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 tag settings are provided and logically correct and provide any finding to the user example below the user did not set a register address / path important the tool can not verify if all provided tag settings are factually correct for example it can not verify that the register address provided for the tag is the correct register address on the plc the tag(s) can be modified on litmus edge by pressing the verify + execute button the tool will group all the tag(s) based on the litmus edge(s) defined in column target litmus edge ip for each litmus edge this will check that all required tag 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 tag(s) m modify tag(s) d delete tag(s) i ignore tag(s) > do nothing to perform all actions, press the yes button the tool will perform all actions one litmus edge at a time when finished, a result summary is shown close the result summary by pressing the x close button once all litmus edge have been processed, the tool will ask if the user wants to re compare the tag(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 tag settings from litmus edge again including the registerid and also change the action to m for each tag with a registerid or a for devices with no registerid troubleshooting the tool will perform several checks throughout the proces of defining the tag settings if they do not pass successfully, the user will be notified the checks include tag name uniqueness on a device level the tool checks if a tag name already exist for a specific device in the tool allowed and not allowed ascii characters for names and descriptions docid\ fnwhcidrnnpizczkuwiyz for tag 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 meta data , and driver specifics example for an invalid json formatting of the driver specifics valid entry for register address / path, if value has to be a number, to be a number and withhin allowed range example for an invalid entry for the register address / path is the column driver specifics empty if they are, and the driver requires driver specifics the default json object will be automaticly added for some drivers the tool also verifies if there exist mandatory json key value pairs in column driver specifics with a value being empty null empty array " \[] " empty json object " {} " for drivers which use queries to read data from databases the tool also verifies the query defined in the column driver specifics is setup to perform sql injection