Placeholders for variables in shape data values

Tip

For examples, see Ziine > Visual Overview Design Examples view > Placeholders page.

Info keywords

A number of keywords can be used in Info shape data fields to display information about a shape. These keywords, wrapped in square brackets, can also be used as placeholders in the value of shape data fields. For example:

Shape data field	Value
Alarm	10/20/500
SetVar	MyVariable:[root alarm id]

Info keywords (wrapped in square brackets) can also be used as placeholders within other placeholders. For example: [var:[NAME]]

For an overview of the different keywords, see Making a shape display information about the item it is linked to.

Note

To prevent infinite loops, do not use alarm keywords in shape data items of type Alarm.
These keywords cannot be used inside other placeholders.

Other placeholders

Note

Placeholders are case-insensitive. In other words, you can use [this service], [This Service], etc.
In the [param: ...] placeholders mentioned below, ParameterID can be replaced by another [param: ...] placeholder. In other words, parameter references can be nested. When you use other placeholders within placeholders, be careful not to create loops.
You can use placeholders directly in the text of a shape.
Many of the advanced features described below apply to DataMiner Cube only.

[AggregationRule:...]

The placeholder [AggregationRule: folder/rule, view ID, protocol, element property, view property, remote primary key] can be used to link a shape to an aggregation rule, in order to display aggregated parameter values. See Linking a shape to an aggregation rule.

It can also be used with:

Shapes linked to a trend component, pie chart, bar chart, column chart, or stacked area chart, where it can be used in the Parameters shape data field instead of a parameter.
Tip

See also:
- Linking a shape to a trend component
- Creating a parameter chart
Shapes linked to a parameter summary, where it can be entered instead of a parameter in the ParametersSummary shape data field.

Tip

See also: Linking a shape to a calculation involving multiple parameters

The placeholder takes the following arguments:

Folder/rule: The location of the rule in the aggregation directory. The root directory does not need to be specified.
View ID: The ID of the view on which the aggregation rule is calculated.
Protocol: The protocol by which the aggregation rule is grouped.

Note

Grouping is only possible by base protocols.
Element property: The element property by which the aggregation rule is grouped.
View property: The view property by which the aggregation rule is grouped.
Remote primary key: The remote primary key of the table row on which the aggregation rule is calculated (string or numeric value).

Note

In case a discrete parameter is used for the remote primary key, do not use the display value.

Note

Not all the values need to be filled in. If the view ID or the remote primary key are not filled in, these will automatically be replaced by -1. In the most extreme case, it is possible to configure the placeholder with only the aggregation rule name, if it is a rule in the root folder.
Grouping can be defined either by element property or by view property. Within the same aggregation rule, it is not possible to group by both properties.

Example:

[AggregationRule:Server farm/Avg Load,-1,,,1]

[attachedproperty:...]

Unlike the [property:...] placeholder, which fetches a property of the object linked to the shape, the [attachedproperty:...] placeholder fetches a property of the object linked to the Visio drawing. This placeholder is mostly of use in Visio drawings that position shapes dynamically based on coordinates.

Properties used inside an [attachedproperty:...] placeholder can contain multiple ID:Value pairs (one for every shape that needs to be positioned) separated by pipe characters.

ID: The ID of the object (Use DmaID/ID for elements and services, and use ViewID for views).
Value: The actual value of the property.

Example:

Suppose you have a Visio drawing in which the shapes have to be positioned dynamically based on X and Y coordinates stored in properties, and that you want that drawing to be linked to both ServiceA and ServiceB. Using the [attachedproperty:...] placeholder, you can refer to data stored in properties of either of those two services.

If ServiceA has the following two properties:

longitude: 1/2:0|1/3:1
latitude: 1/2:1|1/3:1

... and if ServiceB has the following two properties:

longitude: 1/2:1|1/3:0
latitude: 1/2:1|1/3:1

... and if in the Visio drawing you set the XPos and YPos shape data fields to the following values:

XPos: [attachedproperty:longitude]
YPos: [attachedproperty:latitude]

... then:

In the drawing linked to ServiceA, two shapes will be positioned:
- One shape linked to object 1/2 at longitude 0 and latitude 1.
- One shape linked to object 1/3 at longitude 1 and latitude 1.
In the drawing linked to ServiceB, two shapes will be positioned:
- One shape linked to object 1/2 at longitude 1 and latitude 1.
- One shape linked to object 1/3 at longitude 0 and latitude 1.

[Avg:X,Y,Z]

Average of a list of entries, e.g. X, Y, Z (which will be parsed to numbers).

[cardvar:VariableName]

Reference to a session variable (scope: current DataMiner Cube card).

As parameters of which the value is an empty string are considered initialized, you can use a [var:...] placeholder to refer to a parameter containing an empty string.

Note

From DataMiner 10.3.0 [CU14]/10.4.0 [CU2]/10.4.5 onwards, you can add the "WaitForValue" option in the placeholder to keep it from being resolved until the variable is set to a value. See Using the current value of a session variable in an expression.

[color:severity=...]

Available from DataMiner 10.1.11/10.2.0 onwards.

The alarm color for a specific severity level.

For example: [color:severity=minor]

Tip

[ConnectionLineDisplayIdx]

Display key of the connection that was clicked.

Tip

[ConnectionLineIdx]

Primary key of the connection that was clicked.

Tip

[ConnectionlineFromKey]

Starting point of the connection that was clicked.

Tip

[ConnectionLineToKey]

End point of the connection that was clicked.

Tip

[DataMinerTime]

The current DataMiner time, refreshed every second.

By default, the regional date/time format will be used. To use a different format, specify the format in the placeholder. For example:

Format	Description
`[DataMinerTime:Format=HH:mm:ss]`	Custom format.
`[DataMinerTime:Format=f]`	Full date/time pattern (short time).
`[DataMinerTime:Format=g]`	General date/time pattern (short time).
`[DataMinerTime:Format=F]`	Full date/time pattern (long time).
`[DataMinerTime:Format=G]`	General date/time pattern (long time).

Note

For more information on possible formats, refer to https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings.

[DestinationInterfaceElementID]

The DMA ID and element ID of the destination interface of the connection that was clicked.

Tip

[DestinationInterfaceElementName]

The element name of the destination interface of the connection that was clicked.

Tip

[DestinationInterfaceIdx]

The interface ID of the destination interface of the connection that was clicked.

Tip

[DestinationInterfaceLinkedIdx]

The primary key of the table row to which the destination interface of the connection that was clicked is linked.

Tip

[DestinationInterfaceName]

The interface name of the destination interface of the connection that was clicked.

Tip

[displaytableindex]

When, inside a Microsoft Visio drawing, you specify placeholders like [param: ...] and [property: ...] in child shape data items of type "Row", you can use [displaytableindex] inside those placeholders. This placeholder will then dynamically be replaced by the row’s display index.

Tip

<DMAIP>

This placeholder can only be used inside another placeholder, or in a URL for a shape data field of type Link. It is replaced with the first configured value from the following list that can be found for the DMA you are connecting to:

The certificate address
The hostname
The primary IP address

Note

From DataMiner 10.2.0/10.2.3 onwards, the URI scheme of the DMA (i.e. HTTP or HTTPS) is automatically applied when this placeholder is resolved, unless the placeholder does not represent the URI host (e.g. when it is used as a query argument).

Tip

[Element:<input>,<output>]

Available from DataMiner 10.1.12/10.2.0 onwards.

This placeholder can be used to refer to the name or the ID of an element.

<input> should be either an element name or an element ID (in the format DMA ID/element ID).
<output> can be either Name or ID.

For example: [Element:231/15,Name]

[EscapeDataString:x]

Use this placeholder to insert a URL-encoded string into the value of a shape data field.

If, for example, you enter [EscapeDataString:String to be encoded+?] in a shape data field, this will be resolved to String%20to%20be%20encoded%2B%3F%20.

Note that the string to be encoded can itself contain dynamic placeholders.

[Event:...]

This placeholder can be used to trigger an action when a particular event occurs. It should be defined as follows: [Event:<EventName>,<ArgumentName>]

During the event, the [Event:...] placeholder will be replaced by the value of the argument specified in the placeholder.

Prior to DataMiner 10.2.0/10.1.1, only one Router Control event is supported:
- EventName: IOClicked
- Possible arguments:
  - Label: The label of the input or output that was clicked.
  - Index: The index of the input or output that was clicked.
  - DCF interface ID: The ID of the DCF interface that is linked to the input or output that was clicked.
  - DCF interface name: The name of the DCF interface that is linked to the input or output that was clicked.
  - Type: Can be "input" or "output", depending on the type of interface.
  - Matrix: The name of the matrix that contains the clicked input or output.
- Example: [Event:IOClicked,Label]
From DataMiner 10.2.0/10.1.1 onwards, this placeholder can also be used with the NodeDoubleClicked tag. In this case, the event will be triggered when a node is double-clicked in an embedded service definition (see Embedding a Service Manager component). The event placeholder will then be replaced with the value of its argument.
- Possible arguments:
  - ID: The ID of the service definition node.
  - Label: The label of the service definition node.
- Example: [event:NodeDoubleClicked,ID]

Note

If you specify multiple [Event:...] placeholders in a shape data field, only one action will be triggered when that event occurs.
It is advised not to insert [Event:...] placeholders in other dynamic parts or placeholders.

[Field]

Reference to the current field selection (only for EPM environments).

This placeholder can also be used inside other placeholders.

[FieldID]

Reference to the ID of the currently selected field (only for EPM environments).

This placeholder can also be used inside other placeholders. For example, if you specify [param:1/1,101:[fieldID]], this will be replaced by parameter 101, with the ID of the selected field as the row index.

[firstmac]

The first MAC address in the list of active MAC addresses on the client machine.

[Guid]

The GUID. This can for example be used to initialize a session variable with a particular GUID. See Initializing a session variable with a GUID.

[Interlace:<array1>,<array2>,<oldSep>,<newSep>]

Splits the specified arrays delimited with <oldSep>, and interlaces them using <newSep> as separator.

For example, if you specify [Interlace:X|Y|Z,1|2|3,A|B|C,|,;] in the shape data, this will be resolved to "X;1;A;Y;2;B;Z;3;C".

[LocalTime]

Reference to the current DataMiner time in the time zone of the connected client machine.

By default, this time will be displayed in the regional date/time format. If you want the time to be displayed in a different format, specify the format inside the placeholder. For example:

[LocalTime:Format=HH:mm:ss]

Note

The time shown by this dynamic placeholder is refreshed every second.

[Max:X,Y,Z]

Maximum of a list of entries, e.g. X, Y, Z (which will be parsed to numbers).

[Min:X,Y,Z]

Minimum of a list of entries, e.g. X, Y, Z (which will be parsed to numbers).

[pagevar:VariableName]

Reference to a session variable (scope: current Visio page).

As parameters of which the value is an empty string are considered initialized, you can use a [var:...] placeholder to refer to a parameter containing an empty string.

Note

[param:DmaID/ElementID,ParameterID]

Reference to a parameter belonging to a specific element.

The element can be specified either by its name or by its ID (DmaID/ElementID). If specified in a Visio file to be linked to a protocol, ElementID can be replaced by a "*" wildcard.

If you use this placeholder to refer to a column parameter, all the values of that column parameter will be retrieved, with a pipe character ("|") as separator. For example, if the value below is used to configure a tooltip, all values of column parameter 110 are retrieved and displayed as "One|Two|Three"

Shape data field	Value
Tooltip	Summary of parameter 110 is: [Param:MyElement,110]

If you want a custom separator instead of the default separator ("|"), specify the custom separator in a shape data item of type Options. For example:

Shape data field	Value
Options	MultipleValueSep=;

Note

As parameters of which the value is an empty string are considered initialized, you can use a [param:...] placeholders to refer to a parameter containing an empty string.
Inside a [param:...] placeholder, you can use [var:...] placeholders to refer to session variables. Example: [param:[var:Element],101]

[param:DmaID/ElementID,ParameterID,TableRow]

Reference to a dynamic table parameter belonging to a specific element.

The element can be specified either by its name or by its ID (DmaID/ElementID). If specified in a Visio file to be linked to a protocol, ElementID can be replaced by a "*" wildcard.

TableRow - which can refer to either the primary key or the display key - can be a simple ID or name, but it can also be a string containing wildcards ("*" or "?") and/or placeholders like [param:...] or [property:...].

Note

As parameters of which the value is an empty string are considered initialized, you can use a [param:...] placeholders to refer to a parameter containing an empty string.
Inside a [param:...] placeholder, you can use [var:...] placeholders to refer to session variables. Example: [param:[var:Element],101,5]
If you use this placeholder in the Parameter shape data field when linking a shape to a parameter, and the cell the placeholder refers to contains a parameter ID, instead of the cell value, the value of the parameter corresponding to that ID is displayed.

[ParentTableIndex]

This placeholder can be used when hierarchical shapes are created dynamically based on rows in a table. The placeholder will be replaced by the index of the table row associated with the immediate parent shape.

Note

When you use this placeholder, you should always specify the AllowCustomIndex option. Otherwise, Visual Overview will replace the index of the shape with the index of the table row associated with the immediate parent shape..

[ParentTableIndex] should only be used when the index has to be retrieved from a nested row-based child shape.

[ParentDisplayTableIndex]

This placeholder can be used when hierarchical shapes are created dynamically based on rows in a table. The placeholder will be replaced by the display index of the table row associated with the immediate parent shape.

Note

When you use this placeholder, you should always specify the AllowCustomIndex option. Otherwise, Visual Overview will replace the display index of the shape with the display index of the table row associated with the immediate parent shape.

[ParentDisplayTableIndex] should only be used when the index has to be retrieved from a nested row-based child shape.

[Profile:...]

Reference to specific profile instances. See Creating a list of profile instances.

[property:PropertyName]

Reference to a custom DataMiner property.

[property:...] placeholders in shape data fields of type Xpos, YPos, VdxPage and Link refer to properties of the object to which the shape is linked.
[property:...] placeholders in other shape data fields refer to properties of the object to which the Visio file is linked.

If you want to override the above-mentioned general rule, you can add to the shape a data field of type Options and set its value to either ForcePropertyFromShape or ForcePropertyFromPage.

Tip

Note

If the specified property refers to a non-existing element, service or redundancy group, then the shape will not be displayed.

[RegexMatch:x,y,options]

Available from DataMiner 10.3.0 [CU17]/10.4.0 [CU5]/10.4.8 onwards.

This placeholder takes a regular expression and input, and it returns the parts of the input matching the regular expression. For example, [RegexMatch: [a-z], aBc] will return all the lowercase letters in the input, i.e. "ac".

When multiple matches are found within the input, by default, all matches will be concatenated and returned as one single string, without any separators. You can specify options to customize this behavior:

If you want the matches to be separated, you can specify a separator.

For example, [RegexMatch: [a-z], aBc, separator=%] will return "a%c".
If you do not want all matches to be concatenated, you can use the "index=" option to indicate the specific match you want to have returned.

For example, [RegexMatch: [a-z], aBc, index=0] will return "a".

If the regular expression or the input includes the default separator (","), you can use the [sep:] placeholder to replace it with another one.

For example, in [RegexMatch:[sep:,$][a-z]$a,Bc$index=0$separator=%], the default separator has been replaced with "%".

Note

If the regular expression or the input are empty, the placeholder will return an empty string.
The "]" character cannot be used as a separator.
For an example, see Ziine > Visual Overview Design Examples view > [placeholders > REGEX] page.

[RegexReplace:x,y,z]

Use this placeholder to have a value placed in a text string based on the result of a regular expression.

In this placeholder, specify three items, separated by commas:

Item	Description
x	The regular expression.
y	The input (e.g. a session variable).
z	The string that will replace each of the matches.

Note

[RegexReplace:x,y,z] placeholders can be nested.
If any of the three input items contains a comma, the separator needs to be replaced (see About using separator characters):
```
[RegexReplace:[Sep:,#]x#y#z]
```
For an example, see Ziine > Visual Overview Design Examples view > [placeholders > REGEX] page.

Examples:

In case the sessionvar variable contains the value "alpha|beta|gamma|delta", you can place the following placeholder in the value of a shape data field:
```
[RegexReplace:(?<token>[^|]+)((?<separator>[|])|$),[var:sessionvar],value=1005 == ${token};]
```
The placeholder will then be replaced by the following string of text:
```
value=1005 == alpha;value=1005 == beta;value=1005 == gamma; value=1005 == delta;
```
You can use this placeholder to remove the unit suffix of a parameter, so that it can be used within the Sum placeholder. This is necessary if the sum uses a param placeholder and the value of the parameter includes a unit, to make sure that value can be parsed into an integer. For example, to remove the unit "Frames" and calculate the sum of the parameter with ID 5 and a fixed value of 17, you can use this placeholder:
```
[sum:[RegexReplace:\sFrames$,[param:*,5],],17]
```

[Reservation:...]

This placeholder can be used to retrieve a property of a booking (which can be a profile instance GUID, a resource GUID, or a custom property), the start or end time of a booking, the ID of a booking, the status of a booking, or the ID of the service definition of a booking.

To retrieve a property of a booking, use the following basic syntax:
```
[reservation:<GUID or service>,<property>|<argA>|<argB>]
```
This syntax consists of the following components:
- The GUID of the booking or the name or ID of the service linked to it (or a [this service] placeholder referring to a service).
- The property to be retrieved, which can be specified as follows:
  - ProfileID: The GUID of the profile instance linked to the resource retrieved from the booking. If this property is used, the node ID must be specified in <argA>.
  - ResourceID: The GUID of the resource linked to the booking. If this property is used, the node ID must be specified in <argA>.
  - Property=<propName>: The value of a custom property of the booking. The name of that custom property must be specified in <propName>.
  Note
  
  In case the property is not present for a particular booking, nothing will be displayed.
  
  For example:
```
[reservation:[this service],Property=Class]
```
- The arguments necessary to be able to retrieve the property, specified using the following syntax: <ArgumentName>=<ArgumentValue>. For example, NodeID=15.
  
  Depending on the specified property, these arguments may not be needed.
To retrieve the start or end time of a booking, configure this placeholder with the GUID of the booking or the name or ID of the service linked to it, followed by ,start or ,end.

For example, to retrieve the start time of a booking, configure the placeholder as follows:
```
[Reservation:<ReservationGuid>,Start]
```

To retrieve the ID of a booking, use the following syntax:

[reservation:<bookingID or service name or service ID or placeholder referring to a service>,ID]

For example:

[reservation:[this service],ID]

To retrieve the status of a booking (e.g. "Ended", "Pending", "Ongoing", etc.), using a similar syntax:

[reservation:<bookingID or service name or service ID or placeholder referring to a service>,Status]

For example:

[reservation:[var:IdOfSelection],Status]

From DataMiner 10.1.10/10.2.0 onwards, this placeholder can also be used to retrieve the ID of the service definition of a booking, using the following syntax:
```
[reservation:<service ID or booking ID>,ServiceDefinitionID]
```
For example:
```
[reservation:[this service],ServiceDefinitionID]
```

Note

This placeholder can be used inside a [Sum:...] or [Subtract:...] placeholder.

[Resource:...]

This placeholder can be used to retrieve a property of a resource, which can be the name of the resource, the ID of the element linked to the resource, a custom property, etc.

For this purpose, the following syntax must be used:

[Resource:<GUID>,<property>]

This syntax consists of the following components:

The GUID of the resource.
The property to be retrieved, which can be specified as follows:
- FullElementID: The ID of the resource element (i.e. the DVE representing the resource) in the format DmaID/ElementID. This can for instance be used to link to an actual element in Element shape data.
- Name: The name of the resource.
- Property=<propName>: The value of a custom property of the resource. The name of that custom property must be specified in <propName>, e.g. Property=State.
- InUse: From DataMiner 10.3.0/10.2.3 onwards, you can specify InUse to make the placeholder indicate whether a resource is being used in any bookings (with the result "true" or "false"). From DataMiner 10.3.0/10.2.6 onwards, this placeholder can also be used for a shape linked to an element, to indicate 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. However, note that the UseResource=true option must be specified on the element shape for this to work.
```
[Resource:<GUID>,InUse]
```
  Note
  - Prior to DataMiner 10.2.6/10.3.0, the InUse check is only performed when the visual overview is opened or when the resource itself is changed.
  - Using the InUse placeholder may affect performance in case the system contains a large number of bookings.
- ContributingBooking: From DataMiner 10.3.0/10.2.11 onwards, you can specify ContributingBooking to retrieve the contributing booking ID of a resource.

[ServiceDefinition:]

Full syntax: [ServiceDefinition:<ServiceDefinitionID>,<Property>]

From DataMiner 10.2.0/10.1.10 onwards, you can use this placeholder to retrieve properties of a service definition.

The following properties are supported:

Name: The name of the service definition.
Actions: The name of the scripts that are defined on the service definition. Names of multiple actions will be separated by colons (":"). This will allow them to be inserted directly into e.g. a SetVar shape.
Property=<propertyName>: The value of a custom property of the service definition.
Type: Supported from DataMiner 10.3.0/10.2.4 onwards. The type of service definition. This can be Default (representing the default type "SRM"), ProcessAutomation (representing the type "Skyline Process Automation"), or CustomProcessAutomation.

For example:

[ServiceDefinition:[reservation:[this service],ServiceDefinitionID],Actions]

From DataMiner 10.2.0/10.2.3 onwards, you can pass a node label in this placeholder to look up a node ID. For example:

[ServiceDefinition:aaaa-bbb-ccc-ddd,NodeID|NodeLabel=Primary Receiver]

You can for instance use this to find a resource by passing a label of a service definition node. For example:

[Reservation:[this service],ResourceID|NodeID=[ServiceDefinition:aaaa-bbb-ccc-ddd,NodeID|NodeLabel=Primary Receiver]]

Note

Passing a label of a service definition node is preferable over passing the service definition node ID, as this ID is susceptible to change.

[servicedefinitionfilter]

Reference to the row filter of an included table parameter (in a Visio file linked to a service).

Note

This placeholder can also refer to mediation layer parameters. This allows you to use the same Visio file for different services based on the same service definition.

[ServiceFilter]

Reference to the service that was clicked in the service list (only for EPM environments).

Note

This placeholder works in exactly the same way as the [ServiceFilterName] placeholder.

[ServiceFilterIdx]

Reference to the primary key of the selected service in the Service Overview Manager. This placeholder can only be used in AlarmFilter shape data when a Service Overview Manager is used.

Tip

[ServiceFilterName]

Reference to the service that was clicked in the service list (only for EPM environments).

Note

This placeholder works in exactly the same way as the [ServiceFilter] placeholder.

[ServiceSelectionFilter]

Used when embedding an alarm timeline component, in order to select a single parameter to be displayed based on the service/location.

Tip

[Service definition properties]

Use this placeholder in a shape data item of type Tooltip or in shape text. The tooltip or shape text will then display service definition properties, separated by line breaks. Each property will be displayed as "<Property name>: <Property value>".

For a top-level element shape (i.e. not an interface shape), all properties of the node specified in the service definition will be shown.
For an interface shape, all interface properties of the service definition will be shown.
For a connection line, all properties defined for that line in the service definition will be shown.

Tip

[Service definition property:<property name>]

Use this placeholder in a shape data item of type Tooltip or in shape text. The tooltip or shape text will then display the property value of the specified service definition property.

For a top-level element shape (i.e. not an interface shape), the property has to be one of the properties of the node specified in the service definition.
For an interface shape, the property has to be one of the interface properties of the service definition.
For a connection line, the property has to be one of the properties defined for that line in the service definition.

Tip

[SLAFromService:<service(s)>]

This placeholder will be replaced with the DMA ID/Element ID combinations of the SLAs for the specified services. One or more services can be specified, separated by semicolons.

For example, if a system contains two services, Service A (with two SLAs with IDs 1/1 and 1/2) and Service B (with one SLA with ID 1/3), the following placeholder will be replaced by 1/1;1/2;1/3:

[SLAFromService:Service A;Service B]

[SourceInterfaceElementID]

The DMA ID and element ID of the source interface of the connection that was clicked.

Tip

[SourceInterfaceElementName]

The element name of the source interface of the connection that was clicked.

Tip

[SourceInterfaceIdx]

The interface ID of the source interface of the connection that was clicked.

Tip

[SourceInterfaceLinkedIdx]

The primary key of the table row to which the source interface of the connection that was clicked is linked.

Tip

[SourceInterfaceName]

The interface name of the source interface of the connection that was clicked.

Tip

[Subtract:...]

This placeholder can be used to calculate datetime and time span values by subtracting one or more values from a specified value. For example:

Calculating a time span by subtracting one datetime value from another:

[Subtract:14/02/1989 22:22:22,12/01/1989 11:10:9]
Calculating a time span by subtracting a datetime value and two time span values from a datetime value:

[Subtract:14/02/1989 22:22:22,12/01/1989 11:10:9,00:01:00,00:00:05]
Calculating a datetime value by subtracting a time span from a datetime value:

[Subtract:14/02/1989 22:22:22,00:02:00]
Calculating a time span by subtracting one time span from another:

[Subtract:23:33:15,00:03:15]

By default, datetime and time span values will be displayed in the regional date/time format. If you want such a value to be displayed in another format, then specify the format inside the placeholder, for example: [Subtract:23:33:15,00:03:15|Format=hh:mm].

Note

For more info on possible formats, refer to https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-timespan-format-strings.

From DataMiner 10.3.8/10.4.0 onwards, the subtract placeholder also supports numerics. Just like with time spans, you can subtract consecutive numbers from the first number.

Subtracting one number from another:

[Subtract:10,3]
Subtracting multiple numbers from the first number:

[Subtract:10.1,3.3, 2.6]

[Sum:X,Y,Z]

Sum of a list of entries, e.g. X, Y, Z (which will be parsed to numbers).

This placeholder also supports datetime and time span values.

[tableindex]

When, inside a Microsoft Visio drawing, you specify placeholders like [param: ...] and [property: ...] in child shape data items of type "Row", you can use [tableindex] inside those placeholders. This placeholder will then dynamically be replaced by the row’s table index.

Tip

[tableIndexFilter]

Takes the table index of the item that is dropped onto or hovered over the item in which this placeholder has been specified.

Tip

[TableIndexFilterResolved]

When drag-and-drop behavior has been configured for child shapes, this placeholder represents the primary key of the row represented by the dragged shape.

Tip

[TableDisplayIndexResolved]

When drag-and-drop behavior has been configured for child shapes, this placeholder represents the display key of the row represented by the dragged shape.

Tip

[ThisGroup]

This placeholder is replaced with all the security groups that the currently logged-in user is part of. Multiple groups will be concatenated with a pipe ("|") character.

[thisMAC]

All MAC addresses of the client machine, separated by pipe characters ("|").

[thisusername]

The name of the current user.

[thisuserfullname]

The full name of the current user.

[This card object]

The name of the view, service or element to which the Visio file is linked.

[This card objectID]

The ID of the view, service or element to which the Visio file is linked.

[this element]

Reference to the element to which the Visio drawing is linked.

It is possible to override the default behavior of this placeholder for child shapes. In case you want the placeholder to refer to the element linked to the parent shape of a child shape, instead of the element linked to the entire Visio drawing, add a shape data field of type Options, and set its value to ForcePropertyFromParent.

[this ElementID]

Reference to the element ID of the element to which the Visio drawing is linked. This placeholder is resolved as DataMinerID/ElementID.

[This EnhancedServiceID]

In a drawing linked to an enhanced service, you can refer to this service with this placeholder.

[this reservationID]

From DataMiner 10.2.8/10.3.0 onwards, you can use this placeholder in shape data or shape text of shapes linked to a booking (e.g. dynamically generated shapes that represent bookings) to retrieve the GUID of the booking. The placeholder can also be nested, for example to retrieve booking properties or resources.

For example:

[Resource:[reservation:[this reservationID],ResourceID|NodeID=18|],Name]

[reservation:[this reservationID],Property=Monitoring]

Note

This placeholder is often used in combination with the shape data Options set to AllowInheritance=False|ForcePropertyFromParent. See AllowInheritance=False and ForcePropertyFromParent.

[this service]

Reference to the service to which the Visio drawing is linked.

It is possible to override the default behavior of this placeholder for child shapes. In case you want the placeholder to refer to the service linked to the parent shape of a child shape, instead of the service linked to the entire Visio drawing, add a shape data field of type Options, and set its value to ForcePropertyFromParent.

[this ServiceID]

Reference to the service to which the Visio drawing is linked. This placeholder is resolved as DataMinerID/ServiceID.

[this view]

Reference to the view to which the Visio drawing is linked.

It is possible to override the default behavior of this placeholder for child shapes. In case you want the placeholder to refer to the view linked to the parent shape of a child shape, instead of the view linked to the entire Visio drawing, add a shape data field of type Options, and set its value to ForcePropertyFromParent.

[this ViewID]

Reference to the view ID of the view to which the Visio drawing is linked.

[UTCTime]

Reference to the current DataMiner time in the UTC time zone. The time shown by the placeholder is refreshed every second.

By default, this time will be displayed in the regional date/time format. If you want the time to be displayed in a different format, specify the format inside the placeholder. For example:

[UTCTime:Format=HH:mm:ss]

[var:VariableName]

Reference to a session variable (scope: current DataMiner Cube session).

As parameters of which the value is an empty string are considered initialized, you can use a [var:...] placeholder to refer to a parameter containing an empty string.

Note

[xpos]

In child shapes of a shape that is dynamically linked to an element (i.e. shape data field of type Element set to *), you can use [xpos] and [ypos] placeholders.

In references to table parameters, for example, you can specify the tableIndex using [xpos] and [ypos] placeholders.

Example: The parameter reference 13206:[xpos]_0|Alarm will become 13206:5_0|Alarm if the shape is displayed in horizontal position 5.

[ypos]

See [xpos].

Table of Contents

Placeholders for variables in shape data values

Tip

Info keywords

Note

Other placeholders

Note

[AggregationRule:...]

Tip

Tip

Note

Note

Note

[attachedproperty:...]

[Avg:X,Y,Z]

[cardvar:VariableName]

Note

[color:severity=...]

Tip

[ConnectionLineDisplayIdx]

Tip

[ConnectionLineIdx]

Tip

[ConnectionlineFromKey]

Tip

[ConnectionLineToKey]

Tip

[DataMinerTime]

Note

[DestinationInterfaceElementID]

Tip

[DestinationInterfaceElementName]

Tip

[DestinationInterfaceIdx]

Tip

[DestinationInterfaceLinkedIdx]

Tip

[DestinationInterfaceName]

Tip

[displaytableindex]

Tip

<DMAIP>

Note

Tip

[Element:<input>,<output>]

[EscapeDataString:x]

[Event:...]

Note

[Field]

[FieldID]

[firstmac]

[Guid]

[Interlace:<array1>,<array2>,<oldSep>,<newSep>]

[LocalTime]

Note

[Max:X,Y,Z]

[Min:X,Y,Z]

[pagevar:VariableName]

Note

[param:DmaID/ElementID,ParameterID]

Note

[param:DmaID/ElementID,ParameterID,TableRow]

Note

[ParentTableIndex]

Note

[ParentDisplayTableIndex]

Note

[Profile:...]

[property:PropertyName]

Tip

Note

[RegexMatch:x,y,options]

Note

[RegexReplace:x,y,z]

Note

[Reservation:...]

Note

Note

[Resource:...]

Note