Table of Contents

Making a shape display information about the item it is linked to

Using a shape data field of type Info, you can make shapes display information about the item to which they are linked:

Tip

For an example, see Ziine > Visual Overview Design Examples view > [data > PROPERTIES] page.

Configuring the shape data field

Add a shape data field of type Info to the shape, and set its value to one of the keywords listed below.

Note

These keywords (wrapped in square brackets) can be used as placeholders in the value of other shape data fields and within other placeholders. See Placeholders for variables in shape data values.

  • Elements:

    To display information about the element to which the shape is linked, specify:

    • ALARM TEMPLATE
    • DATAMINER
    • DESCRIPTION
    • DISPLAY TYPE
    • ELEMENT NAME
    • ELEMENT STATISTICS:...
    • ID
    • IMPACTED SERVICES
    • IP
    • NAME
    • POLLING IP
    • PORT INFO
    • PROTOCOL
    • PROTOCOL TYPE
    • PROTOCOL VERSION
    • REDUNDANCY STATE
    • STATE
    • TREND TEMPLATE
    • TYPE
    • AVERAGE VALUE (see Displaying history values for parameters)
    • MINIMUM VALUE (see Displaying history values for parameters)
    • MAXIMUM VALUE (see Displaying history values for parameters)
    • IN USE: Displays "true" or "false" depending on whether the element is being used in a resource, is a DVE parent of a function resource, or represents the physical device corresponding with a virtual function resource (supported from DataMiner 10.3.0/10.2.6 onwards). Note that the UseResource=true option must be specified on the element shape for this to work.
    • Contributing Booking: Displays the contributing booking ID of a resource (supported from DataMiner 10.3.0/10.2.11 onwards). Note that the UseResource=true option must be specified on the element shape for this to work.

  • Services:

    To display information about the service to which the shape is linked, specify:

    • DATAMINER
    • DESCRIPTION: The description of the service element.
    • ELEMENT NAME: Displays the element alias if one exists; otherwise the actual element name is displayed.
    • FORCE ELEMENT NAME: Displays the actual name of the service element, not the element alias.
    • ID
    • NAME
    • SERVICE DESCRIPTION: The description of the service itself (enhanced service only).
    • SERVICE STATISTICS:...

  • Redundancy groups:

    To display information about the redundancy group to which the shape is linked, specify:

    • DATAMINER
    • DESCRIPTION
    • ID
    • NAME

  • Views:

    To display information about the view to which the shape is linked, specify:

    • ID
    • NAME
    • VIEW NAME
    • VIEW STATISTICS:...

  • Alarms:

    To display information about the alarm to which the shape is linked, specify:

    • ALARM ID
    • ALARM TYPE
    • ALARMPROPERTY:<PropertyName>
    • COMMENT
    • ELEMENT NAME
    • ELEMENT TYPE
    • ELEMENTPROPERTY:<PropertyName>
    • OWNER
    • PARAMETER DESCRIPTION
    • PARAMETER KEY
    • RCA LEVEL
    • REDUNDANCY STATE
    • ROOT ALARM ID
    • ROOT TIME
    • SERVICE IMPACT
    • SERVICES
    • SEVERITY
    • SOURCE
    • STATUS
    • TIME
    • USER STATUS
    • VALUE

  • Interfaces:

    To display information about the DCF Interface to which the shape is linked, specify:

    • CUSTOM NAME

  • Virtual function resources:

    To display information about the virtual function resource to which the shape is linked, specify:

    • NAME

    • ELEMENT NAME

    • RESOURCE NAME

    • RESOURCE ID

    • FUNCTION NAME

    • IN USE: Displays "true" or "false" depending on whether the resource is being used in any bookings (supported from DataMiner 10.3.0/10.2.3 onwards).

      Note
      • Prior to DataMiner 10.2.6/10.3.0, the "IN USE" check is only performed when the visual overview is opened or when the resource itself is changed.
      • Using the "IN USE" placeholder may affect performance in case the system contains a large number of bookings.

  • Bookings: See Linking a shape to a booking.

  • EPM objects: See Linking a shape to an EPM object.

Placeholder for Info value in shape text

The info specified in the Info field will only appear on the shape if you add shape text that contains a "*" character. This character will then be replaced by the requested information.

To add text to a shape, just double-click the shape, and enter the text.

Note

If an Info shape data field is set to DATAMINER, the placeholder is replaced by the name of the DMA that is currently hosting the element, service, or redundancy group.

Element statistics, service statistics, view statistics, etc.

To display element statistics, service statistics or view statistics, the same placeholders are used as when configuring MaintenanceSettings.xml to display these statistics in the Surveyor.

For example, to display the number tickets for an element, you can set the value of the Info field to ELEMENT STATISTICS:[#Tickets].

For more information, see Displaying alarm statistics in the Surveyor or Displaying ticket statistics in the Surveyor.

Propose changes