How to modify the SPECTRUM OneClick Tool Tip popup (Legacy KB ID CNC TS32709 )

Document ID : KB000052118
Last Modified Date : 14/02/2018
Show Technical Document Details
Related Issues/Questions:
How to modify the SPECTRUM OneClick Tool Tip popup
How to add an attribute to the SPECTRUM OneClick popup dialog box that appears when you position the mouse pointer on a model

Problem Environment:
SPECTRUM 08.01.00.00
SPECTRUM 09.00.00.00
Tool Tip
container-tooltip-config.xml 
network-tooltip-config.xml
port-tooltip-config.xml
device-tooltip-config.xml
default-tooltip-config.xml
You can modify the OneClick xml file(s) that control the information displayed when you position the mouse pointer over a model.


There are 5 different files depending on what type of model you want to modify the information for. They are all located in the $SPECROOT /tomcat/webapps/spectrum/WEB-INF/topo/config directory on the OneClick systems. The files are:


container-tooltip-config.xml  - Container models other then the Network container
network-tooltip-config.xml - The Network Container model
port-tooltip-config.xml - Port models
device-tooltip-config.xml - Device models
default-tooltip-config.xml - Any other model not covered by the above


The following is an example of adding the Acknowledged attribute to the device-tooltip-config.xml file but can be used for any of the tooltip files mention above:


1. You will need to identify the attribute id of the attribute you wish to add. This can be done using the Command Line Interface (CLI), the Attribute Editor or the Attributes tab. For this example, the Acknowledged attribute id is 0x1134e.
2. Copy the $SPECROOT/tomcat/webapps/spectrum/WEB-INF/topo/config/device-tooltip-config.xml file to the $SPECROOT/custom/topo/config directory
3. Edit the $SPECROOT/custom/topo/config/device-tooltip-config.xml file and add the attribute information. In this exaple, the following was added to the device-tooltip-config.xml  file. This can be added after the last </param> tag in the file.


  <param>
    <localize>Acknowledged</localize>
  </param>


  <param>
    <attribute>0x1134e</attribute>
  </param>


4.  Find the following entry:


<html><table>
  <tr>
    <td><b>{0}</b></td>
    <td>{1}</td>
  </tr>
  <tr>
    <td><b>{2}</b></td>
    <td>{3}</td>
  </tr>
  <tr>
    <td><b>{4}</b></td>
    <td>{5}</td>
  </tr>
  {6}
</table></html>


5. Change the above entry in step 4 to read as follows:


<html><table>
  <tr>
    <td><b>{0}</b></td>
    <td>{1}</td>
  </tr>
  <tr>
    <td><b>{2}</b></td>
    <td>{3}</td>
  </tr>
  <tr>
    <td><b>{4}</b></td>
    <td>{5}</td>
  </tr>
  <tr>
    <td><b>{6}</b></td>
    <td>{7}</td>
  </tr>
  {8}
</table></html>


4. Save the changes
5. Have users log out of OneClick
6. Restart tomcat
7. Log back in and verify the change has taken affect


Note: In the changes made in step 4 and 5, you will need to add a new set to <tr> tags for each new attribute added to the file incrementing the numbers inside the brackets {} within the <tr> tags accordingly. You will also need to increment the number inside brackets {} after the last </tr> tag by two for each new attribute added.

.


(Legacy KB ID CNC TS32709 )