PublishDocument - 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)

Description

When a user selects one or more documents to publish, EFServicesManager will call the PublishDocument method for each document. EFServicesManager will get the IObject, IDocument, IissueRecordComposition, and IDocVersionComposition interfaces and will populate the properties on the IObject and IDocument interfaces before calling this method.

The implementation of this method will do the following

  1. Collect all data associated with the specified document.

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

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

  4. Check 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 should 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.

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.

bViewFileRequired

Boolean

Input

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

oMapSchContIContainer

IContainer

Input

Optional. Map schema container. This argument will be passed for only the tools that support mapping schema.

Comments

If the method fails, the tool will raise an error and set Err.Number and Err.Description appropriately.