Import Tag(s) Wizard
The Import Tag(s) Wizard allows users to search for Tag(s) defined for DeviceHub devices on a Litmus Edge and select which on these Tag(s) they want to import the Tag settings into the Tag Management tool.
Open the Import Tag(s) Wizard
To open the Import Tag(s) Wizard, press the Import Tag(s) button from the LitmusConfiguration Ribbon.
Notes:
To open the Import Tag(s) Wizard, the tool will verify that it is not in the Status:
- Offline
- DeviceHub not responding
- No LE Set
- No API Key
If the Tool found to be in one of these states, a message is displayed.
Setting up the Search Filter
To search for DeviceHub devices, the user can setup a filter to apply to the search. This allows them to reduce the list for potentially imports to only the devices they are truly interested in.
Select the LE Device IP
Tool set to One LE
If the tool is set to Connect To One LE, the user will not be able to change or select the LE Device IP.
Tool set to Multiple LE
If the tool is set to Connect To Multiple LE, the user can select which Litmus Edge to search for, provided that more than one Target Litmus Edge IP has been defined.
Additionally users can also enter a Litmus Edge IPv4 which is not yet present in the sheet
The tool will check if it does have an API Key for the Litmus Edge IPv4 address. If no API Key is found, it will notify the user and request the API Key.
Press the Yes Button, provide the API Key and press the Save Button.
Set Search Option
The tool provides a number of Filter Options the user can select from. The include:
- ALL: Do not apply any filter and return all tag(s) defined in DeviceHub on the selected Litmus Edge
- DOES NOT CONTAIN: Select all Tag(s) where the Tag Name does not contain the value from my Tag Name Mask.
Notes:
All Search Options except ALL, require a value for the Tag Name Mask.
Define the Tag Name Mask
For any Search Option except ALL, a mask is required to apply to the Tag Name.
Example: Selected Search Option set to EQUAL TO and Tag Name Mask set to Tag1
Define the DeviceHub Devices
Select if you want to search for Tag(s) only on a specific DeviceHub Device or over all (field is empty) Device(s).
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 Import Wizard will show what Filter will be applied.
Initiate the Search
If all settings are correctly set, the Search Button will be set to green and allows to initiate the search. To initiate the search press the green Search button.
Notes:
If the Filter is invalid, the Search button will be grayed out and can not be used.
Example: No Tag Name Mask has been defined for the Search Option EQUAL TO
Importing Tag(s)
After the Search has been initiated, the results are shown in a List Box.
The Userr will see the Device Name as well as the Tag Name.
Notes:
In case a Filter returned no Tag(s), the user is informed and can initiate a new Search.
Selecting all Tags
To select all Tags for Import, check the Checkbox of the Header Row.
Unselecting all Tags
To unselect all Tags for Import, uncheck the Checkbox of the Header Row.
Select individual Tag(s)
To select individual Tag(s) for Import, check their respective Row or Checkbox.
Unselect individual Tag(s)
To unselect individual Tag(s) for Import, uncheck their respective Checkbox or Row.
Import Tag(s)
If at least one Tag has been selected from the list, the Import button will change to green and an Import can be initiated. To initiate an Import press the green Import button.
If no Tag(s) have been selected, the Import button will be greyed out.
Notes:
The Import wizard will show how many tag(s) have been selected in the left lower corner.
After an Import finished
Once all the selected Tag(s) have been imported, the user is informed about the result and has three further options:
- Close the Wizard. This will end the import and the user can proceed with their desired actions on the sheet.
