PublishDocument
Description
The PublishDocument method should be implemented by any tool that needs to publish documents to the project level in SmartPlant Foundation.
|
Interface |
Method |
Description |
|---|---|---|
|
ISPAdapterProject |
PublishDocument |
This method needs to be implemented by the tool to support publishing of documents at project level. (see the following table for arguments details) |
When a user selects one or more documents to publish, EFServicesManager calls the PublishDocument method for each document. EFServicesManager gets the IObject, IDocument, and IDocVersionComposition interfaces, and populates the properties on the IObject and IDocument interfaces before calling this method.
The implementation of this method does the following:
-
Collects all data associated with the specified document.
-
Uses the schema component to create objects and relationships.
-
Adds created objects and relationships to the document data container (passed as an input argument).
-
Adds instructions information to the claims container (passed as an input argument) for the objects and relationships claimed to the project. Do not add claim instructions for the objects and relationships created in the project.
-
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 is 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 |
Document container. |
|
oDocMetadataIContainer |
IContainer |
Input |
Document metadata container. |
|
oDocClaimsIInstructionContainer |
IContainer |
Input |
Document claims container. (Add claim instructions for objects claimed to the project to the container. Do not add claim instructions for the objects and relationships created in the project.) |
|
bViewFileRequired |
Boolean |
Input |
Indicates whether view files and the reference files need to be added to the metadata container. TRUE will be passed for a normal publish operation. FALSE is passed in cases where view files and reference files are not required, such as when only the XML is required. |
|
ePublishType |
ePublishTypes |
Input/Output |
Enumerated publish type. |
|
oMapSchContIContainer |
IContainer |
Input |
Map schema container. This argument is passed for only the tools that support mapping schema. |
Properties
The ProjectNameInTool property holds the name of the tool project that is currently connected to the SmartPlant Foundation project, and the ProjectNameInSPF property holds the project name in SmartPlant Foundation. ProjectNameInTool and ProjectNameInSPF must be the same.
|
Interface |
Property |
Description |
|---|---|---|
|
ISPAdapterProject |
ProjectNameInTool |
Holds the name of the tool project that is currently connected to the SmartPlant Foundation project. |
|
ISPAdapterProject |
ProjectNameInSPF |
Holds the name of the SmartPlant Foundation project to which it is connected. |