SmartPlant Schema Documentation - 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 modify the SmartPlant schema in any way, you must understand the objects that the SmartPlant schema contains and the rules that apply to those objects. However, the Schema Editor documentation does not contain topics that cover the objects in the SmartPlant schema because the schema is constantly undergoing changes.

The SmartPlant schema contains internal documentation about many of the objects contained in the schema. The Description property contains brief documentation for some of the class definitions, interface definitions, relationship definitions, property definitions, and units of measure in the SmartPlant schema.

Not all objects in the SmartPlant schema have documentation defined for them. For example, concrete objects, such as pumps, are not typically documented within the SmartPlant schema because most users know what pumps are. Some abstract objects, like streams, have a description if a description was available when the schema was modified.

You can use the Tree/Multi-Tab view in the Schema Editor to view the existing documentation for objects in the SmartPlant schema. The Description field on the Properties tab in the Tree/UML view allows you to view information about an object selected in the tree view.

For example, the following graphic displays the description for the IAltDgnPoint interface in the Tree/Multi-Tab view.

See Also

Naming Conventions in the SmartPlant Schema
SmartPlant Schema Overview
View SmartPlant Schema Documentation