Publish Custom Properties on Document Objects - Integration - Update 44 - Help - Hexagon

You can publish custom properties on documents from SmartPlant tools, which can be useful for automatically obtaining key properties for document management and control. You must create the required custom properties on SmartPlant Schema interfaces, and then map the custom properties with the corresponding custom properties of the tool map file. Then, create the corresponding custom properties with the same name in the SmartPlant Foundation Schema (SPFSchema).

The SmartPlant Schema document interfaces and the corresponding SPFSchema interfaces are listed in the table below:

The mapping relationship between the custom properties in the SmartPlant Schema and the SPFSchema is configured implicitly by creating identically named properties. This means that you cannot create custom properties that have different names in the SmartPlant Schema and SPFSchema interfaces and use mapping to get the property values copied.

While the names of the custom property in the SmartPlant Schema and SPFSchema must be the same, their respective UIDs must be different and unique.

You can view the published custom properties in the SmartPlant Foundation Desktop Client after the data is loaded and consolidated successfully.

During publish, the document master properties are written to the tool data XML file, and the document revision and version properties are written to the document metadata XML file.

The examples in the table below illustrate properties added to different levels of the complex document object.

The following section provides detailed instructions for creating two custom properties that will be published on a drawing from Smart P&ID. It illustrates how to create the custom properties in the Smart P&ID database, add them to the tool map schema, create them in the SmartPlant integration schema, and create the mapping relationships. Details are also provided for adding the custom properties to the SmartPlant Foundation authoring schema and loading all the schema changes into the SmartPlant Foundation database.

For more generic information about performing these tasks, you can find instructions for extending the SmartPlant integration schema to include custom properties in Extending the Schema for SmartPlant Integration. For generic instructions for creating custom properties in the SmartPlant Foundation schema, see Extend the Existing Stand-Alone SmartPlant Foundation Schema.