Mapping topics to interfaces - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10

The topic for a rule identifies what kind of item the drawing text expresses. A topic name can be TAG, DOCUMENT, or an interface name. If the topic is an interface name, SmartPlant Foundation will limit the query to items that realize that interface. For example, if you have a rule with a topic IEquipmentOcc, SmartPlant Foundation will look for equipment only when text satisfying that rule is selected. If the TAG topic is used, SmartPlant Foundation will query items realizing the IObject interface. If the DOCUMENT topic is used, SmartPlant Foundation will query items realizing the IDocument interface.

When the DOCUMENT topic is used, SmartPlant Foundation will locate a document revision rather than a document master. SmartPlant Foundation uses the "Revision Status for hotspotted document tags" argument on the Navigate Client API to determine which revision to choose. For example, if you want users to see the latest revision, specify the LATEST keyword in the "Revision Status for hotspotted document tags" argument. If you only want users to see the current revision, use the CURRENT keyword.

You can override the default behavior of the TAG and DOCUMENT topics by modifying the entries in the TopicInterfaceMap section in the SPFHotspotter.ini. The format of each entry in this section is <Topic>=<Interface>. For example, if all your tags with the DOCUMENT topic represent P&ID drawings, you can set the DOCUMENT topic to use the IPIDDrawing interface as shown here:

[TopicInterfaceMap]

Document=IPIDDrawing