Before you can author anything, you must define the schema for what you intend to create and publish to the data warehouse. It is best to create the data warehouse schema first as this will most likely share many of the existing SmartPlant schema interfaces. For example, if you want to share data between the tools and see inconsistencies in data, the same interfaces and properties are used by all the tools, such as IHeatTracedItem. Most major published items are typed, so typically equipment classes should realize the IEquipment interface.
Every published item must have a certain minimum set of interfaces:
|
Interface |
Description |
|---|---|
|
INonDrawingItem |
To relate the published items to the published document with the NonDrawingItemCollection relationship definition. |
|
ISPFTEFPublishedItem |
To relate the published item to the shared object via the SPFTEFComprisedOf relationship definition. This interface is not part of the base integration schema and is not part of the published schema in the .cmf file but is needed within the SmartPlant Foundation database. It is left off initially and is added automatically by the schema extraction process described in Extract the schema file to load. |
|
IPBSItem |
Usually realized to support the relationship to the PBS tree. |
When any item is published, it must be associated to a document object. It is necessary to model a published SmartPlant integration document in the published schema component.
For example, PpmPPDocument realizes the following interfaces:
|
Interface |
Description |
|---|---|
|
IDocVersionComposition |
|
|
IDocument |
|
|
INonDrawingDocument |
|
|
INonDrawingItemCollection |
To relate the published items to the published document via the NonDrawingItemCollection relationship definition. |
|
IObject |
|
|
IPpmDocument |
|
|
IPpmPPDocument |
|
|
IReferencedDocumentCollection |
|
|
ISPFTEFPublishedItem |
To link this via the SPFTEFComprisedOf relationship definition to the shared document (SPFTEFPublishedMaster). This is not part of the published schema in the .cmf file but is added before loading into SmartPlant Foundation as described above. |
The document category and type for this document are identified in the adapter header file. If a new category and type are required, then this needs to be added into the document category enum hierarchy. For example, Process Published Document under Process Documents (UID=EE73). A sample schema to create this is provided below:
<EnumEnum>
<IObject UID="e1PpmPPDocument" Name=" Process Published Document " Description="Process Published Document"/>
<IEnumEnum/>
<ISchemaObj/>
</EnumEnum>
<Rel>
<IObject UID="EE73.e1PpmPPDocument"/>
<IRel UID1="EE73" UID2="e1PpmPPDocument" DefUID="Contains" IsRequired="True" OrderValue="0"/>
<ISchemaObj/>
</Rel>