SetEventHandlerObj
Description
This method must be implemented to use the IEFCustomPublishEventHandler member object in IEFCustomPublish. StepProgressBegin() and StepProgressEnd() must be called on this object to update the publish progress bar with steps. SmartPlant Client implements the IEFCustomPublishEventHandler interface, and SmartPlant Client acts as the oEventHandler parameter for this method in SmartPlant Client.
Arguments
Name |
Data Type |
Input / Output |
Description |
---|---|---|---|
oEventHandler |
IEFCustomPublishEventHandler |
Input |
This is an object used to update the publish progress bar. |
ListOfProgressSteps
Description
This method is called by SmartPlant Client to retrieve all additional steps to be displayed in the publish progress bar while processing the data. In the implementation of this method, add the required additional steps that need to be displayed in the progress bar while processing the data. These steps are displayed during the publish process along with the rest of the publish process steps with status icons. The StepNames array must be filled with individual steps to be displayed during the publish process.
Arguments
Name |
Data Type |
Input / Output |
Description |
---|---|---|---|
StepNames |
StringArray |
Input / Output |
Contains a list of additional progress steps to be displayed in the publish progress bar. |
ProcessPublishData
Description
This method is called by SmartPlant Client and needs to be implemented to modify, add, or remove information from the data to be published before transmitting to SmartPlant Foundation. This implementation can also validate the published data and raise messages during the publish process. It can also update the publish progress bar with the status of each step.
By implementing this method, you can achieve the following:
-
Modify or add information to the published data that cannot be handled by the tool adapters.
-
Filter and limit information from the data being 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 and raise an "invalid" state to EFClient to stop the publish process.
-
To log messages, make sure MessageIContainer is set, and add the messages to MessageIContainer. The messages are saved to a log file.
-
To display progress steps in the publish progress bar, implement ListOfProgressSteps(). For each step, call StepProgressBegin(stepName) before and StepProgressEnd(stepName) after. Use the member variable of type IEFCustomPublishEventHandler with SetEventHandlerObj().
See Sample Implementation (IEFCustomPublish).
Arguments
Name |
Data Type |
Input / Output |
Description |
---|---|---|---|
oDocumentIObject |
IObject |
Input |
IObject interface on the document object. |
oDocIContainer |
IContainer |
Input / Output |
Document container. |
oDocMetalContainer |
IContainer |
Input / Output |
Document meta-data container. |
oMapSchContlContainer |
IContainer |
Input |
Optional. Maps the schema container. |