Generate OpenXML Word report for an object - 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

You can generate an OpenXML Word report for an object of any class definition. The Word Open XML Template classification has been added to the Template Documents classification tree to support the creation of OpenXML Word report templates.

You can create a custom report template based on the Word Open XML template classification. After creating a custom report template, you then must create a template file (.docx) and a control file (.xml), and attach them to the custom report template. The template file (.docx) contains the layout of the OpenXML Word report, and the control file (.xml) contains mapping information that links fields in the template file to properties in view definitions.

After configuring a custom report template, you can create a new method using the OpenXMLWordReport client API to generate a report based on that custom template.

  • For more information about creating custom OpenXML Word reports, see Create custom OpenXML Word reports.

  • Five OpenXML Word report templates are delivered with the software: DocumentTemplate, External Transmittal Word OpenXML Template, Internal Transmittal Word OpenXml Template, Cancelled External Transmittal Word OpenXML Template, and Cancelled Internal Transmittal Word OpenXML Template. DocumentTemplate is used to generate OpenXML Word reports for classified objects, such as documents. The other four templates are used to generate OpenXML Word reports for transmittals, which are non-classified objects.

OpenXMLWordReport client API

The OpenXMLWordReport client API is delivered in the Core.Core_Admin container and provides the ability to generate an open XML Word report for a selected object. This client API is used by the following delivered methods:

  • DocumentRevisionOpenXMLWordReport

  • ExternalCancelledXmtlOpenXMLWordReport

  • InternalCancelledlXmtlOpenXMLWordReport

  • RunExternalXmtlOpenXMLWordReport

  • RunInternalXmtlOpenXMLWordReport

  • SCLBTechnicalQueryReportPreview

  • SDAXmtlReportPreview

  • The DocumentRevisionOpenXMLWordReport method is used to generate an OpenXML word report for classified objects, such as design documents. The other four methods are used to generate OpenXML word reports for transmittals.

  • For more information about how the software filters the template documents for classified objects when a report category is specified, see Filter template documents to generate OpenXML Word reports for classified objects.