XML load formats for documents - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

To make it easier for XML to load documents, users can either fully define the document by specifying each class that makes up a document, or they can define the document in a shorthand format where only the document master is fully defined. This has special tags that make it easier to create the revision and version objects.

<SPFTemplateMaster> </SPFTemplateMaster>

<SPFTemplateRevision> </SPFTemplateRevision>

<SPFTemplateVersion> </SPFTemplateVersion>

If a revision or version property is detected on the document master class instance, then the revision and version are referenced automatically.

The name and description of the revision and version objects are the same as the document master.

The following XML creates a master:

<SPFTemplateMaster>

<IObject Description="Instrument List Template"

Name="Instrument List Template"

UID="InstrumentListTemplateMaster" />

<ISPFDocumentMaster />

<ISPFNonPublishedDocMaster />

<ISPFTemplateMaster />

<ISPFDocument SPFDocCategory="e1TemplateDocuments"

SPFDocType="e1DatasheetTemplate" SPFTitle=""

SPFDocState="RESERVED"/>

</SPFTemplateMaster>

The following XML creates a revision:

<SPFTemplateRevision>

<IObject Description="Instrument List Template"

Name="Instrument List Template"

UID="InstrumentListTemplateRevision" />

<ISPFDocumentRevision SPFExternalRevision="A1"

SPFMajorRevision="A" SPFMinorRevision="1" SPFRevState="WORKING"

SPFRevUnderChangeInSameConfig="False" SPFSignoffComments="" />

<ISPFNonPublishedDocRevision />

<ISPFTemplateRevision />

<ISPFWorkflowItem />

</SPFTemplateRevision>

The following XML creates a version:

<SPFTemplateVersion>

<IObject Description="Instrument List Template"

Name="Instrument List Template"

UID="InstrumentListTemplateVersion" />

<ISPFDocumentVersion SPFDocVersion="1"

SPFIsDocVersionCheckedOut="False"

SPFIsDocVersionSuperseded="False" />

<ISPFFileComposition />

<ISPFNonPublishedDocVersion />

<ISPFTemplateVersion />

</SPFTemplateVersion>