### Defining WebCTRL® paths A path tells the WebCTRL® application the route through the system hierarchy to an item in the system. For example, a path tells the WebCTRL® application where to find a microblock property value to display on a graphic or where to jump to when the operator clicks a link on a graphic. In ViewBuilder, you use paths in: Controls Links Conditional expressions In WebCTRL®, you use paths in: The`source` field code in alarm actions and messages An Equipment Values report The`go` manual command Autopilot You can do one of the following to get the path: In ViewBuilder, let ViewBuilder write the path or use Logic Graphics Properties that were defined in the EIKON® application. In the WebCTRL® interface, determine the path yourself. A path consists of the reference name of each tree item included in the path, separated by a forward slash (/). For example, first_floor/zone_1/lstat. A path can be absolute or relative. WebCTRL® paths are based on parent-child hierarchy. In the tree below, the Lobby is a child of First Floor, and First Floor is a child of Atlanta R&D Facility. Conversely, Atlanta R&D Facility is the parent of First Floor, which is the parent of Lobby.
A system in the WebCTRL® interface: | Same system in SiteBuilder showing reference names in blue:
Click for details below Absolute path Relative path Relative path to heat, cool, demand, or custom source values Relative path to prime variables and thermographic colors Determining a path or microblock property Determining a path or microblock property in a converted SuperVision system
#### Absolute path An absolute path begins at a specific point in the system hierarchy and is followed by the children below it down to the object or property of interest. An absolute path can begin with either of the following: A global reference name—a reference name that is unique within the entire system and begins with a # sign. EXAMPLE If OA Conditions has a global reference name of #oa_conditions, the absolute path to OA Conditions is simply #oa_conditions. The absolute path to any child of OA Conditions, such as OA Temperature, begins with #oa_conditions. For example, #oa_conditions/oa_temp. The top of the WebCTRL® tree EXAMPLE (using the system in the figure above) To display the Lobby’s zone temperature on any graphic, the absolute path is /trees/geographic/atlanta_-_rd_facility/first_floor/zone_1/lstat.
#### Relative path A relative path is useful for items such as graphics or alarm messages that you will reuse in multiple WebCTRL® locations because the path is relative to the item that contains the path. A relative path going down the tree A relative path going down the tree begins with the reference name of the item below the location where the path is used. Examples using the system shown above: To display the Lobby’s zone temperature on the Lobby’s graphic, the path is rs. To display the Lobby’s zone temperature on the Atlanta-R&D Facility graphic, the path is first_floor/zone_1/rs. A relative path going up the tree A relative path going up the tree begins with a ~ followed by one of the options below:
Use... | To go... | Examples using the system shown above
--- | --- | ---
~parent | Up one level | To put a link on the Lobby graphic that goes to the First Floor graphic, the path is ~parent. To put a link on the Lobby graphic that goes to the Atlanta R&D Facility (up 2 levels), the path is ~parent/~parent. To display the Lobby’s zone temperature on the Boiler graphic, the path is ~parent/~parent/ first_floor/zone_1/lstat/present_value.
~equipment | To the microblock's control program | To display the Lobby zone temperature in a High Temp alarm message, the path is ~equipment/lstat/present_value.
~device | From a control program in the Geographic tree to its device in the Network tree. | To show the device name on an equipment graphic, use ~device.display-name.
~network | From a location in the Network tree up to its network (IP, ARCNET, etc.) | To show the network name on an equipment graphic, ~device/~network.display-name. To show the network number on a dead module alarm, use the following field code and path: $source:~network.network-number$.
~geo | From a control program in the Network tree to the same item in the Geographic tree. | Use the manual command go ~geo.
~net | From a control program in the Geographic tree to the same item in the Network tree. | Use the manual command go ~net.
#### Relative path to heat, cool, demand, or custom source values To get a heat, cool, demand, or custom source value, use one of the following relative paths, replacing xxx with the reference name of the point you want to display and yyy with the reference name of a custom tree. ~heat/~parent/~geo/xxx ~cool/~parent/~geo/xxx ~dem/~parent/~geo/xxx ~changetree(yyy)/~parent/~geo/xxx NOTE You must do the following before you can display a source value using the above paths. In the EIKON® application, configure Analog Status microblocks in the child control program for outgoing heat, cool, and run requests. Also configure Total, Minimum, and Maximum microblocks for the incoming requests in the parent control program. In SiteBuilder, assign your child equipment to its parent on the Heat Source or Cool Source tab. See “Building source trees” in SiteBuilder Help.
#### Relative path to prime variables and thermographic colors To get a prime variable, use the relative path ~prime. The control program must contain a Prime Variable microblock. To get a thermographic color, use the relative path ~color. The control program must contain a Setpoint or Set Color If True microblock
#### Determining a path or microblock property To get the path to an area, equipment, or microblock In the WebCTRL® interface, right-click the item on the tree, then select Copy Path. Paste the path where you need it. To get the path to a microblock property value In the WebCTRL® interface, right-click the value, then select Global Modify. Click Show Advanced to see the full path to the property value and the Edit Privilege associated with the property.
#### Determining a path or microblock property in a converted SuperVision system Follow the procedure in Determining a path or microblock property to get the equipment path. For example, #o_a_conditions_1801. Select the equipment on the Geographic tree. Click Properties. Alt+click the value that you want the path to. In Global Modify, the Expression field shows the path to the microblock property. The full path of the microblock property is `#o_a_conditions_1`801/`legacy_fb/status/rtre/val` NOTES A status microblock does not have a property. For a graphic to display a trend graph for a microblock property in a converted SuperVision system, type the microblock property path followed by`/~trend` in the trend graph control's Trend location field. To add a comparison trend graph, type the path followed by`/~reports/<name of trend>`.