Structure of the XML returned - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

When a transmittal report is run, it produces an XML representation of the transmittal object, its workflow, and any related documents. This translates into the following XML structure which is returned from the report:

XML structure 1

XML structure 2

The <IObject> node contains attributes: OBID, UID, DomainUID, CreationDate, TerminationDate, LastUpdatedDate, UniqueKey, Config, CreationUser, TerminationUser, Name, and Description.

<SPFReportItem> contains <ReportAttribute> sub nodes that have the following attributes: AttrName, AttrDisplayAs, and AttrValue. The data that appears in the ReportAttribute node is directly related to the view definition. When the view definition is updated, the ReportAttribute nodes will contain data that reflects the change.

For example, the <SPRReportItem> node for the transmittal using the delivered view definition will return the name, description, and issue state of the transmittal. For external transmittals, the report would show the raw XML similar to the following:

External Transmittal Reports XML

This is a result of the delivered view definition for an external transmittal containing the lines:

+ISPFCExternalTransmittal/IObject/Name/Name/Identification/1,

+ISPFCExternalTransmittal/IObject/Description/Description/Identification/2,

+ISPFCExternalTransmittal/ISPFTransmittal/SPFXmtlIssueState/Issue State/Miscellaneous/3