DevicePath parameter syntax guidelines

The format for the Automatic Diagnostics functions is:
<Automatic Diagnostics function>("DevicePath")
where
DevicePath
is an absolute or relative path to one or more devices. You can also click the
Alarms
button to open the
Alarm Source Browser
 to browse for areas, device servers, and shortcuts within the areas to be used with the Automatic Diagnostics functions.
Absolute path
The format for the absolute path to a device is:
/<AreaPath>:<DeviceServerName>::[ShortcutName]DeviceName
where
AreaPath
is the name of the area. It must begin with the forward slash character and does not contain the application name.
DeviceServerName
is the name of the
FactoryTalk Linx
 server within the area.
ShortcutName
is the name of the shortcut that connects to the device.
DeviceName
is the name of the device from which you want to retrieve the Automatic Diagnostic information. Use a single device name, or use the wildcard characters ? (question mark) and * (asterisk) to specify multiple devices.
Examples
  • /Area1:FactoryTalk Linx::[Shortcut_CLX]Controller5580
    Specifies a single device.
  • /Area1:FactoryTalk Linx::[Shortcut_CLX]Controller*
    Specifies all devices whose names begin with Controller.
  • /Area1:FactoryTalk Linx::[Shortcut_CLX]*
    Specifies all devices in Shortcut_CLX.
  • /Area1:FactoryTalk Linx::*
    Specifies all devices in the device server.
  • /Area1::*
    Specifies all devices in the area.
Relative path
The format for the relative path is:
[::]
[ShortcutName]DeviceName
where
ShortcutName
is the name of the shortcut that connects to the device.
DeviceName
is the name of the device from which you want to retrieve the Automatic Diagnostic information. Use a single device name, or use the wildcard characters ? (question mark) and * (asterisk) to specify multiple devices that are contained in the same area as the display.
Examples
  • [Shortcut_CLX]Controller5580
    Specifies a single device.
  • [Shortcut_CLX]Controller*
    Specifies all devices whose names begin with Controller.
  • *
    Specifies all devices that are contained in the same area as the display.
Remarks
  • The colons (::) that precede the relative device path are optional, unless there is a colon (:) in the device name. In that case, double colons (::) must precede the relative device path.
  • DevicePath
    supports the replacement of tag placeholders used in graphic displays. For example, in
    /Area1:FactoryTalk Linx::[Shortcut_CLX]#1
     the placeholder #1 would be replaced by the parameter #1 that is passed to the display. If the expression function cannot replace all the placeholders in a device path, nothing is returned by the expression function, and an error message is logged to FactoryTalk Diagnostics.
  • To get a total for all areas in a network distributed application with multiple areas, you need to use the absolute path syntax and sum functions for each area together. For example,
    ADDA_ActiveUnsuppressedCount("/Area1::*") + ADDA_ActiveUnsuppressedCount("/Area2::*") + ADDA_ActiveUnsuppressedCount("/Area3::*")
  • To get a total for all automatic diagnostic events in an area or one server, you can use the absolute path syntax. For example,
    ADDA_ActiveUnsuppressedCount("/Area1::*")
    ADDA_ActiveUnsuppressedCount("/Area1:FactoryTalk Linx::[Shortcut]*")
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal