List of naming pattern substitution parameters
- Last UpdatedDec 17, 2024
- 4 minute read
- PI System
- PI Server 2024 R2
- PI Server
When you define naming patterns for element, event frame, transfer, and model templates,
you can use the substitution parameters described in the following table. These naming
pattern shortcuts are available in addition to the substitution parameters that are
listed in the Naming Pattern field when you click 
.
|
Parameter name |
Substitution |
|---|---|
|
Description parameters |
|
|
%DESCRIPTION:path% |
The object's description represented by the path to the object. If the path is not specified, the description of the current object is used. |
|
%\ELEMENTDESCRIPTION% |
The description of the object's root element, or the description of the primary referenced element of the object's root event frame. |
|
%..\ELEMENTDESCRIPTION% |
The description of the object's parent element, or the description of the primary referenced element of the object's parent event frame. Use ..\ notation, such as %..\..\ELEMENTDESCRIPTION%, to retrieve further ancestors. |
|
%\EVENTFRAMEDESCRIPTION% |
The description of the object's root event frame. |
|
%..\EVENTFRAMEDESCRIPTION% |
The description of the object's parent event frame. Use ..\ notation, such as %..\..\EVENTFRAMEDESCRIPTION%, to retrieve further ancestors. |
|
ID parameters |
|
|
%ANALYSISID% |
The ID of the object's analysis. |
|
%ATTRIBUTEID% |
The ID of the object's attribute or attribute template. |
|
%|ATTRIBUTEID% |
The ID of the object's root attribute or attribute template. |
|
%..|ATTRIBUTEID% |
The ID of the object's parent attribute or attribute template. Use ..| notation, such as %..|..|ATTRIBUTE%, to retrieve further ancestors. |
|
%DATABASEID% |
The ID of the object's PI AF database. |
|
%ELEMENTID% |
The ID of the object's element, or the ID of the primary referenced element of the object's event frame. |
|
%\ELEMENTID% |
The ID of the object's root element, or the ID of the primary referenced element of the object's root event frame. Use ..\ notation, such as %..\..\ELEMENTID%, to retrieve further ancestors. |
|
%..\ELEMENTID% |
The ID of the object's parent element, or the ID of the primary referenced element of the object's parent event frame. |
|
%EVENTFRAMEID% |
The ID of the object's event frame. |
|
%\EVENTFRAMEID% |
The ID of the object's root event frame. |
|
%..\EVENTFRAMEID% |
The ID of the object's parent event frame. Use ..\ notation, such as %..\..\EVENTFRAMEID%, to retrieve further ancestors. |
|
%ID:path% |
The object's ID represented by the path to the object. If the path is not specified, the ID of the current object is used. |
|
%MODELID% |
The ID of the object's PI AF model. |
|
%SYSTEMID% |
The ID of the object's PI AF server. |
|
%TRANSFERID% |
The ID of the object's PI AF transfer. |
|
Name parameters |
|
|
%ANALYSIS% |
The name of the object's analysis. |
|
%DATABASE% |
The name of the object's PI AF database. |
|
%\ELEMENT% |
The name of the object's root element, or the name of the primary referenced element of the object's root event frame. |
|
%..\ELEMENT% |
The name of the object's parent element, or the name of the primary referenced element of the object's parent event frame. Use ..\ notation, such as %..\..\ELEMENT%, to retrieve further ancestors. |
|
%\EVENTFRAME% |
The name of the object's root event frame. |
|
%..\EVENTFRAME% |
The name of the object's parent event frame. Use ..\ notation, such as %..\..\EVENTFRAME%, to retrieve further ancestors. |
|
%NAME:path% |
The object's name represented by the path to the object. If the path is not specified, null is returned since it references the name of the current object. |
|
%SYSTEM% |
The name of the object's PI AF server. |
|
%\TEMPLATE% |
The name of the root template of the object's element or event frame. |
|
%..\TEMPLATE% |
The name of the parent template of the object's element or event frame. Use ..\ notation, such as %..\..\TEMPLATE%, to retrieve further ancestors. |
|
Path parameters |
|
|
%ELEMENTPATH% |
The path of the base element, the element of an attribute, or the primary referenced element of an event frame. |
|
%..\ELEMENTPATH% |
The path of the object's parent element, or the path of the primary referenced element of the object's parent event frame. Use ..\ notation, such as %..\..\ELEMENTPATH%, to retrieve further ancestors. |
|
%EVENTFRAMEPATH% |
The path of the event frame or the element of an attribute of an event frame. |
|
%..\EVENTFRAMEPATH% |
The path of the object's parent event frame. Use ..\ notation, such as %..\..\EVENTFRAMEPATH%, to retrieve further ancestors. |
|
Time parameters Note: You can specify a format string with all time substitutions. The format string is separated from the substitution name by a colon. For example, %TIME:d% uses the short date pattern, whereas %UTCTIME:yyyy/MM/dd HH:mm:ss.fff% specifies the format in full. |
|
|
%ENDTIME:yyyy-MM-dd HH:mm:ss.fff% |
The current local end time of the object using the specified formatting. If no formatting is specified, the default formatting is used. The formatting uses standard format strings supported by the DateTime.ToString method, as described in Format strings for time substitution parameters. |
|
%UTCENDTIME:yyyy-MM-dd HH:mm:ss.fff% |
The current Coordinated Universal Time (UTC) end time of the object using the specified formatting. If no formatting is specified, the default formatting is used. The formatting uses standard format strings supported by the DateTime.ToString method, as described in Format strings for time substitution parameters. |