Create an Edge Definition - Integration - Update 44 - Help - Hexagon

1. Open the Editor view. For more information, see Create New Objects and Relationships in the Schema.

   Tell me more

   To open either of the editor views, on the View menu, click the type of file that you want to modify. Then click Editor or Editor2 in the Form box on the simple View dialog box or on the View tab of the advanced View dialog box. For example, to use one of the editor views to modify the active schema, click View > Schema (All).

2. Double-click EdgeDef in the Create tree.

3. In the New Edge Definition dialog box, type a name for the new edge definition in the Edge name box on the Overview tab.

   

   • The property category helps organize properties in the Properties window in SmartPlant Foundation.

   • If no property definition is defined for the edge definition, properties across the edge definition are assigned a property category based on the property category defined for the interface definition that exposes the properties.

4. Provide a display name for the edge to define how it will appear in SmartPlant Foundation Desktop Client menus.

   When this edge definition appears on a shortcut menu in the Desktop Client, the label will be "Show [Display name value]". So, to have the label appear as "Show Nozzles" on the menu, type "Nozzles" in the Display name box.

5. Click beside the Starting interface box, and select the starting interface definition for the new edge definition. Every edge definition must have a starting interface and traverse across at least one relationship definition.

6. If you plan to use SmartPlant Foundation security to restrict which users will see this edge definition in the Desktop Client, select the Filter out edge in display check box. If this check box is clear, the edge definition will be available to all Desktop Client users.

   For example, if you create an edge definition to traverse from a contract to all related documents and you leave the Filter out edge in display check box clear, all users will see a command on the shortcut menu of a contract to show the related documents, regardless of the roles of the user. However, if this check box is selected, SmartPlant Foundation will evaluate the role of the user to determine whether they should see that command.

7. Click the Path tab.

8. In the End interface tree, select the ending interface definition or class definition that will be the starting point for the path of the edge definition.

   

   The End interface tree displays the interface definition at the end of the current path and defines what appears in the Edges list. You can expand Implied nodes under each interface definition to select from interface definitions implied by the interface definition at the end of the current path. You can expand the RealizedBy node to select from class definitions that realize the interface definition.

9. In the Edges list, select the role at the other end of an edge (relationship definition or edge definition) that you want to include in the new edge definition. For more information about roles and relationship definitions, see Relationship Definitions.

   

   

   • By default, the edges (relationship definitions or edge definitions) that appear in the Edges list are those that start at the end interface definition or at an interface definition implied by that end interface definition. You can change the list of available relationships by selecting a different interface definition or class definition in the End interface tree.

   • When viewing edges in the Edges list, you will not see the names of relationship definitions used to traverse the interfaces. Instead, you will see the name of the role assigned to the other end of the relationship from your starting point, as selected in the End interface tree.

   • When you select an edge, the software displays the UML for that edge definition in the Edge preview pane under the Edges tree.

     

10. Click Add to Path to add the path for the selected edge to the path for the edge definition you are defining.

    

    • When you add the edge to the path, the UML in the Current edge definition pane is updated, and the End interface tree and Edges list are also updated for the new ending interface definition.

    • To remove edges from the path definition, click Remove Last Edge from Path on the Path tab. Clicking Remove Last Edge from Path only removes one edge at a time starting with the last one added.

Add a Property Filter to an Edge Definition

If you would like to filter the results that will be returned by an edge definition when it is used in SmartPlant Foundation Desktop Client, use the following steps to further configure the edge definition. For example, you can create an edge definition to find documents associated with a specific contract and then add a filter so that the edge definition returns only documents with a status of CURRENT.

1. Go to the Filter tab.

2. Click Add Filter.

3. If necessary, change the value in the Ending interface, Relationship path, or Interface at end of path list to the interface that exposes or inherits the property you want to filter on.

4. Choose the property that you want to filter on in the Property list.

5. From the Operator list, choose the operator to use when evaluating the value for the selected property. The options include equal to (=), less than (<), greater than (>), or not equal to (<>).

6. Type a value in the Comparison value box for the selected property. Or, if the property is scoped by an enumerated list or UoM list type, click to open the Possible Values dialog box. On the Possible Values dialog box, select one or more acceptable values from the list, and click OK.

   If you want the criteria to include multiple values for a specific property, you can enter multiple values by separating them with a pipe character (|).

7. If you want to define criteria for multiple properties, click Add Filter again and provide the criteria for the next property.

8. If the path specified for the edge definition includes traversal across an ordered relationship definition, click Numeric position, and type the position number that identifies a specific object from the set of objects at the end of the path.

   

   

   • For example, if you want to return the fifth nozzle on a piece of equipment, the numeric position should be set to 5.

   • If you specify a position, a maximum of one object will be found when the edge definition is traversed.

Add an Interface Filter to an Edge Definition

If you would like to filter the results that will be returned by an edge definition to only include objects that have instantiated a specific interface, use the steps below to further configure your edge definition. For example, if you want to create an edge definition to display the P&ID an object is on, you could select IPIDDrawing in this list to make sure that only P&IDs, and not other objects that participate in the DwgRepresentationComposition relationship, are returned by the edge definition.

• On the FIlter tab, click beside the End objects must support one of the following interfaces box, and select the interfaces.

See Also

Naming Conventions in the SmartPlant Schema
SmartPlant Schema Overview