PublishDocument Method - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

The implementation of IEFAdapter10_PublishDocument does the following:

  1. Collects all data associated with the specified document.

  2. Uses the schema component to create objects and relationships.

  3. Adds created objects and relationships to the document data container (passed as an input argument).

  4. Checks the value of bViewFileRequired. If it is true, add the graphic file interfaces to the document metadata container (passed as an input argument). A file object must be created for each view file and reference file for the publishing document. The adapter needs to create the necessary view file interfaces and relationships in the metadata container and set the FilePath property.

  5. Returns the type of publish.

Arguments

Name

Data type

Input/output

Description

oDocumentIObj

IObject

Input

IObject interface on the document object.

oDocContIContainer

IContainer

Input/Output

Document container.

oDocMetaIContainer

IContainer

Input/Output

Document metadata container.

oDocTombstonesIContainer

IContainer

Input/Output

IContainer pointer to instruction objects published in the context of the document.

bViewFileRequired

Boolean

Input

Indicates whether view files and the reference files need to be added to the metadata container. True is passed for normal publish operation. False is passed in cases where view files and reference files are not required. The case for False would be when only the XML is required.

p_eptPublishType

ePublishTypes

Input

ePublishTypes.Full indicates that this is a full publish. ePublishTypes.Delta indicates that this is a Delta Publish update publish.

oMapSchContIContainer

IContainer

Optional Input

Optional map schema container. This argument is passed only for the tools that support mapping schema.