Adding relations
The Relations tab in the Template View is to define the desired relations between the root component of the template and other components in the station in which
the template is deployed.
- Click the Relations tab.
- Add a relation using either of these methods:
- To add from the installed tag dictionaries, select a
RelationIdin the left pane and click
(or double-click the RelationId). - To add an ad hoc relation (one not found in a tag dictionary), with nothing selected click and enter the desired
RelationIdin the popup window.
The added relation appears in the right pane.Typically, the default
Relation Directionis sufficient. However, you may need to change a relation direction to get the desired query results, that is, hierarchy results. - To add from the installed tag dictionaries, select a
- To change the relation direction, in the right pane, select the row containing the added relation and click
.You can add a givenRelationIdonly twice. The first time you add a relation, the default relation direction is inbound. If you add the sameRelationIda second time, by default it has the opposite relation direction. - To set up a NEQL query, in the right pane, double-click on the
RelateHintscell in the Set Value window, enter a NEQL search predicate value, and click OK.This step tags the relation with a string value, which the system uses as a NEQL search predicate during the deployment to search for and suggest potential related components.For example, if you add the hs:ahuRefRelationId, you might enter this search predicate: hs:ahu.If your entry is a valid NEQL search predicate, the system updates the table in the right pane with this value. If it is not valid, the system returns an error message in the table. - To provide relation guidance for the person deploying the template, double-click on the
UserTipcell of the row, and, in the Set Value window, enter a instruction text, and click OK.For example, you might enter: Select Related AHU.This updates the table in the right pane with theUserTip. - Optionally, the value in SlotPathScope column is used as the root component when the search for target relation binding is performed during template deployment
to a station. To use a slot path as the root for bind hint searches to resolve Relation bindings, double-click on the
SlotPathScopecell of the row, and in the Set Value window, enter the desired value. The value is a slot path definition, which is a list of hierarchical components separated by a slash. There are no leading or trailing slashes in the value. If you do not enter a value, the entire station will be searched, which is identical to the search performed in