Create an Interface 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 InterfaceDef in the Create tree.

3. In the New Interface Definition dialog box, type a name, display name, and description.

   Do not start the name of the new interface with the "ISPF" prefix. That prefix is reserved for use by Hexagon.

4. If you want to specify a category for properties that are exposed on this interface, click beside the Property category box and choose the category you want to assign to those properties. For more information, see the Properties Categories section of the Interface Definitions topic.

5. If you want to specify class definitions that will realize this new interface, click beside the Realized by class definitions box.

6. In the Selectable list in the Possible RealizedByClassDefs dialog box, check the boxes for the classes that will realize the new interface, and then click OK. You can select one or multiple classes.

7. If the new interface will be the primary interface for any class definitions, click beside the Primary interface for class def box. In the Selectable list, check the boxes for any class definitions for which this interface will the primary interface. Click OK.

8. Beside the Implies interface definitions box, click , and then select the interfaces that will be implied by the new interface. You can select one or multiple interfaces.

   

   • All interfaces must imply at least one other interface.

   • An interface will inherit all properties exposed by interface that it implies.

9. If necessary, click beside the Implied by interface definitions box, and then select the interfaces that will imply the new interface.

   The new interface should be implied by the primary interfaces of all class definitions that realize it.

10. If you want to create properties to be exposed by the new interface definition now, click beside the Exposed property definitions box, and click New on the Possible ExposedPropertyDefs dialog box. For more information, see Create a Property Definition.

    

    • An interface may expose any number of properties, but it does not have to expose any.

    • Since properties are exposed by only one interface definition, there are no selectable properties on the Possible ExposedPropertyDefs dialog box until you create new ones.

11. Beside the Implementation of enumeration box, click , and then select the enumerated list used by this interface, if one is used.

12. In the New Interface Definition dialog box, click OK.

See Also

Interface Definitions
Create New Schema Objects
Naming Conventions in the SmartPlant Schema
SmartPlant Schema Overview