ProcessPublishData
Description
SP Client calls this method after calling the publishing tool’s implementation of ISPAdapter.PublishDocument and before publishing a document to SmartPlant Foundation. This method can modify, add, or remove information from the document’s data. For example, this method can:
-
Manipulate the document’s data in cases where this cannot be done by the publishing tool’s SmartPlant adapter.
-
Filter information to be published.
-
Calculate additional information based on the publishing application data, such as finding the beginning P&ID number for a pipeline.
-
Manipulate data to represent special business rules.
-
Validate data.
-
Add error and warning messages to the publishing tool’s implementation of ISPCLCustomPublish.MessageIContainer.
-
Raise an error to be caught and logged by SP Client.
-
Call EventHandlerObj.ShowStepInProgressbar to add custom steps to the progress bar and logging.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
poDocumentIObject |
IObject |
Input |
IObject interface for a document object to be published. |
|
poDocIContainer |
IContainer |
Input |
Document data container. |
|
poDocMetaIContainer |
IContainer |
Input |
Document metadata container. |
|
poMapSchContIContainer |
IContainer |
Input |
Tool map component container. |
Comments
If the method fails, the tool will raise an error.