Table of Contents

Linking a shape to a trend component

Using a shape data field of type Component, you can configure a Visio shape to display a trend component.

Note
  • It is also possible to turn a shape into a parameter chart instead of linking it to a trend component. See Creating a parameter chart.
  • In a Visio trend component, the alarm timeline along the X-axis is only displayed if the graph initially shows only one parameter, and only as long as that parameter is displayed.
  • For examples, see Ziine > Visual Overview Design Examples view > [linking > TREND1, TR2 and TR3] pages.

Basic shape data configuration

Add the following shape data fields to the shape:

  • Component: Set the value of this shape data field to "Trending".

  • Parameters: Configure this shape data field as follows:

    • For a single trend component, configure the value as follows:

      DmaID:ElementID:ParameterID|...|...

      To include a table row, configure the value as follows:

      DmaID:ElementID:ParameterID:TableRow|...|...
      Note
      • Instead of specifying the DMA ID/Element ID in the Parameters shape data field, you can also specify an Element shape data field and set it to the element name, and then only list the parameters in the Parameters shape data field, separated by pipe characters.
      • You can use element wildcards, e.g. "*:1010:0" for index 0 on parameter 1010 of a table.
      • By default no more than 10 results can be displayed if a wildcard is used. If more results are available than this default limit, a notification will be displayed.
      • Instead of the element ID, you can also use the element name or a [this element] placeholder. Keys containing forward slashes (e.g. dmaID/elementID) are also supported.

    • For trend groups, either set the field to "TrendGroup=username:groupname" for a private trend group, where username is the name of the user that created the group, or to "TrendGroup=sharedusersettings:groupname" for a shared trend group or a read-only group. Set the field to "|" to display an empty trend component.

  • ParametersOptions: Set the following possible options as the value for this shape data field, using a pipe character ("|") to separate the options:

    • CollapseLegend:X: Determines whether the legend below the trend graph is collapsed by default. "X" can be true or false.

    • Limit:X: Determines how many results can be displayed when a wildcard is used in the Parameters field (default: 10). "X" is the number of values to be shown.

      For example, if "Limit:2" is specified, only two values matching the wildcard in the Parameters field will be displayed. However, note that if not all results can be displayed, a notification will only be displayed if more results are available than the default limit of 10.

    • MinChartHeight=X: Determines the minimum height of the chart area. "X" should be set to the number of pixels, e.g. "MinChartHeight=400". To make sure this height is reached, the legend of the trend component will become smaller when necessary, or it may even be hidden.

      By default, the minimum height is 200 px.

    • NavigatorChart:X: Determines if the bottom navigator chart is displayed. "X" can be true or false.

    • NoWildcard: If this option is specified, this will force DataMiner to load the specified index, instead of a filtered set of indexes.

      This can particularly be of use for cases where an index is not considered to be trended, even though trend data is available, e.g. an index that has trend data in the past but is no longer trended now.

    • Range:X: Determines the trend range. "X" can be "Day", "Week", "Month", or "Year".

      You can also configure a custom range in the format "Range:Start=<dateTimeTextA>,End=<dateTimeTextB>". Note that you do not have to specify two time values. You can specify a start time, an end time or both (separated by a comma). The datetime text strings need to be formatted according to the current or invariant culture.

    • ShowLegend:X: Determines if the bottom legend is displayed, which allows the user to add parameters. "X" can be true or false.

    • ShowGroups:X: Determines if the trend groups panel on the left-hand side is displayed. "X" can be true or false.

Example:

Shape data field Value
Component Trending
Parameters 221:50670:350
ParametersOptions Range:Day|NavigatorChart:false|ShowLegend:true|ShowGroups:false

Configuring session variables to be set from trace points

It is possible to configure a trend component so that a session variable is populated with a trace value when the mouse pointer hovers over a graph.

To do so, specify the following shape data:

  • Add a shape data item of type SetVar to the trend component, and set its value to "ValueTrace:", "MinTrace:", "MaxTrace:", or "TimeTrace:", followed by the name of the session variable.

  • Optionally, to limit the scope of the variable, add a shape data field of type Options, and set it to the appropriate scope. For more information, see Indicating the scope of the variable.

  • In case the trend component shows multiple parameters, add a shape data field of type SetVarOptions and set it to "MultipleValueSep=" followed by a separator of your choice. For more information, see Creating a multiple checkbox control.

    The session variable will contain a list of trace values, one for each parameter displayed in the trend component, separated by the separator you specified. If you want to display one of those values in another location, you can refer to it using its 0-based index. For example, if you have the minimum trace values stored in the MinimumValue session variable, you can use "MinimumValue[1]" to refer to the minimum trace value of the second parameter in the trend component legend.

Example of the configuration:

Shape data field Value
Component Trending
ParametersOptions ShowLegend:true
Parameters |
SetVar ValueTrace:Avg|MinTrace:Min|MaxTrace:Max|TimeTrace:Time
Options PageVariable

Configuring session variables to be updated with the graph’s time range

It is possible to configure a trend component so that a session variable is populated with the time range displayed in the graph (i.e. the start time and end time).

To do so, add a shape data field of type SetVar, and set its value to "RangeStart:<VariableA>|RangeEnd:<VariableB>".

Example:

Shape data field Value
SetVar RangeStart:MyRangeVar1|RangeEnd:MyRangeVar1
Note

The values set in the session variables will be datetime text strings formatted according to the current culture.

Creating a trend component with command control

It is possible to create a special kind of trend component that incorporates a command control. Depending on the configuration, the command control can be used to manipulate one particular component or several components, which can be on the same page, on the same card or anywhere in Cube.

  1. Add the following shape data fields to the component shape:

    Shape data Value
    Component Name of the Visio component: "Trending".
    CommandPrefix Optional prefix added to the command name (in the shape containing the command, see below) in case multiple identical commands have to be configured for different instances of the same component (e.g. "_Left__").

  2. Add the following shape data fields to the command control shape:

    Shape data Value
    Command Name of the command to be executed when the shape is clicked. Only one command is possible with a trending component: "SetTrendRange"
    Optionally, you can include the command prefix specified in the shape of the trending component, e.g. "Left_SetTrendRange".
    CommandParameter Optional parameters for the command. For the SetTrendRange command, you can specify the following trend ranges:
    - "Range:Day"
    - "Range:Week"
    - "Range:Month"
    - "Range:Year"
    Options To turn the shape into a button, specify: "Control=Button"
    Scope The scope of the command:
    - "Page" (default): All components that can execute the configured command on the same Visio page.
    - "Card": All components that can execute the configured command on all pages of the current Visio file.
    - "Application": All components that can execute the configured command anywhere in the client application (e.g. DataMiner Cube)

Example

In the following example, the range of the leftmost trend graph component found on the same Visio page as the command shape will be set to "Week" when the command shape is clicked:

  • Visio component shape:

    Shape data Value
    Component Trending
    CommandPrefix Left_

  • Command shape:

    Shape data Value
    Command Left_SetTrendRange
    CommandParameter Range:Week
    Options Control=Button
    Scope Page

Limiting the displayed values to the top/bottom X

It is possible to specify that only the top or bottom number of current values of a parameter should be displayed.

To do so, add the Sort shape data field, and set it to the following value:

Value Description
[SortOrder],limit:X - SortOrder is either "ASC" or "DESC".
- X is the number of values to be shown.

To apply both a top and bottom limit at the same time, separate the two values with a pipe ("|") character.

For example:

Shape data field Value
Component Trending
Parameters 520/3:270:*|520/3:203:*
ParametersOptions ShowLegend:true
Sort ASC,limit:2|DESC,limit:1

Filtering the trend legend

It is possible to filter the available elements in the trending legend based on the value of a property.

To do so, add the Filter shape data field, and set it to the following value:

Property:PropertyName=PropertyValue

For example, with the configuration below, the legend will only contain elements that have the property "Class" set to the value "Gold".

Shape data field Value
Component Trending
Parameters *:100:SLNet*
ParametersOptions ShowLegend:true
Filter Property:Class=Gold
Propose changes