Naming Conventions in the SmartPlant Schema - Integration - Update 44 - Help - Hexagon

Integration Help

Language
English
Product
Integration
Search by Category
Help
Smart 3D Version
12.1 (2019)
Smart Construction Version
2019(7.0)
SmartPlant Foundation / SDx Version
10
Smart Electrical Version
2019 (9.0)
Smart Materials/Smart Reference Data Version
2020 (10.0)
Smart P&ID Version
9 (2019)
Smart Review Version
2020 (15.0)
Smart Engineering Manager Version
10 (2019)
Smart Interop Publisher Version
13.1 (2019 R1)
Smart Isometrics Version
7.0(2019)
Spoolgen Version
9.0(2019)

Before you begin modifying the SmartPlant schema, you need to understand the naming conventions used for objects in the schema. The following naming conventions are used in the schema:

  • Interface definitions are prefixed with "I". For example, IPump is an interface definition that expresses the role of a "pump."

  • Many class definitions are prefixed with information about the component schema that they are associated with. For example, EQDStrainer has a Componentization relationship with the EquipDataSheet component schema.

  • Properties may be prefixed with the name of the interface definition that exposes them. For example, Instrument_FluidType is exposed by IInstrument. This is called denormalization of an attribute.

  • Some relationship definitions are named according to their patterns, such as collection or composition. For example, PBSItemCollection is a collection, and PipingPortComposition is a composition. For more information about patterns, see Patterns and Abstract Roles.

  • Primary interface definitions for concrete objects generally end in "Occ," which is "the occurrence of an object." For example, the primary interface definition for PIDInstrument is IInstrumentOcc. For more information about occurrences, see Patterns and Abstract Roles.

  • Because class definitions, interface definitions, and property definitions can be implemented from within a programming language, these objects must not include spaces nor the following special characters in their names: !@#$%^&*()+=- []\{}:;"'?<>./.