Testing Relative Facility Links

Canvas > Using Relative Facilities > Configuring Relative Facilities > Testing Relative Facility Links

Testing Relative Facility Links

This topic describes how to test that your relative facility links resolve to the appropriate facility tags in your environment.

Test Facility Resolution

Click Test on the Relative Facilities dialog box to open the Relative Facility Tester.

Sample Relative Facilities Tester

Click to select a Source facility tag using the Select Facility Tag dialog box or enter the facility tag directly in the field provided. The source facility tag can be any facility in the relative facility path, although the tester will only resolve to facility tags down the path from the source facility.
Click to select the Relative link from the drop-down menu.
If the Relative link has an Order in type attribute configured, an Order in type field will display. Type the order-in-type value for the child facility.
Click Resolve to resolve to all down-path facilities.
The Resolved facility field displays the last resolved facility in the path.
The Associated definition set displays the name of the definition set with which the selected Relative link is associated.
Click Diagram to see a graphical representation of the definitions configured for this definition set.
Review the Path details to see all resolved facilities. The columns of information include:
- Link — The name of the relative link used to resolve to a facility tag.
- Order in type? — Indicates whether an order in type is used for this relative link.
- Resolved facility tag — The name of the resolved facility for the relative link and order in type (if configured).
If the relative link cannot resolve down to all facilities in the path an Error message will display. Review the message to identify the problem. Adjust the Relative link and Order in type and Resolve again. Click the following thumbnail to view a Relative Facilities Tester with an error message. In this example no Order in type value is specified so the Relative link (Tank) resolves to multiple tank types (_OT1, _OT2, _WT1, _WT1). If we were to specify the Order in type value (1), the Relative link will resolve to the correct tank, as in the example at the top of this page.

Click the thumbnail to see a
sample Relative Facilities Tester
showing Error message

Click Close to close the Relative Facilities Tester dialog box.

Dialog Box Properties

The Relative Facility Tester dialog box contains the following options and properties:

Option	Description
Source facility tag	Click to select a Source facility tag using the Select Facility Tag dialog box. The source facility tag can be any facility in the relative facility path, although the tester will only resolve to facility tags down the path from the source.
Relative link	The Relative link property specifies a list of all available relative facility paths. Click to reveal a drop-down menu of all available relative facility definitions (relative links). Select a link from the list. If an order-in-type attribute is specified for the selected link, the Order in type field will display.
Order in Type	Specifies the facility attribute used to represent the order in type (the facility ordinal) for this relative facility definition. The Order in type is used to account for multiple children of a certain type. For example, in a Tank Battery with multiple tanks, this attribute would specify the order of the child tanks in the tank farm. A blank attribute value means that the property is not to be used and will not be configurable when specifying a relative link on a Canvas screen or control. Options include a hard-coded list of generic text attributes including facility_info0, facility_info1, and facility_attr0 to facility_attr29. Note the following: Specifying an Order in type attribute reduces the number of relative facility definitions. Resolution must be the last resolved facility in the path or chain. Order-in-type-based definitions can allow for the creation of multi-parent configuration; this should be avoided. See Design Considerations for more information about creating Order-in-type-based definitions.
Resolve	Click Resolve to resolve to all down-path facilities.
Resolved facility	The Resolved facility field displays the last resolved facility in the path.
Associated definition set	The Associated definition set displays the name of the definition set with which the selected Relative link is associated.
Diagram	Click Diagram to see a graphical representation of the relative facility definitions configured for this definition set.
Path Details	Review the Path details to see all resolved facilities. The columns of information include: Link — The name of the relative link used to resolve to a facility tag. Order in type? — Indicates whether an order in type is used for this relative link. Resolved facility tag — The name of the resolved facility for the relative link and order in type (if configured).
Error	If the relative link cannot resolve down to all facilities in the path an Error message will display. Review the message to identify the problem. Adjust the Relative link and Order in type and Resolve again.