Expose interface definitions (modified in an update) - HxGN SDx - HxGN SDx - Reference - Hexagon

HxGN SDx Modified and Retired Functionality

Language
English
Product
HxGN SDx
Search by Category
Reference
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)

The following applies if you are using a version of the software before Update 57. For the latest information, see Expose interface definitions.

  1. In the Desktop Client, find the class definition.

  2. In the Find Interface Definition window, right-click the class definition and click Create API Entry Point.

  3. In the New API Entry Point form, enter a name and description for the new API entry point.

  4. In the API Entry Point details section, type the name for the interface definition that you want to expose in the Metadata Entity Single Name box. For, example, Tag.

  5. In the Metadata Entity Collection Name box, type the name for the collection of interface definitions you want to expose. For example, Tags.

    You can use the Property Comparison box to optionally configure additional query criteria for the exposed type using standard property comparison syntax.

  6. In the ColumnSet list, select the column set to be exposed to the selected class definition.

    The column set's related properties and relationship definitions are exposed to the selected interface definition.

    If none is selected, the column set is automatically selected.

  7. In the GUI display details section, type the name for the new API entry point in the Display as box.

  8. In the Access Control details section, select the access groups applicable from the Required Access Groups list, and click Finish.