Methods (ISPCLCustomRetrieve) - Integration - Update 46 - Help - Hexagon

SmartPlant Integration .NET 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)

ProcessRetrieveData

Description

SP Client calls this method after retrieving a document from SmartPlant Foundation and before calling the publishing tool’s implementation of ISPAdapter.RetrieveDocument. This method can modify, add, or remove information from the retrieved document’s data before passing the data to the publishing tool’s SmartPlant adapter. 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 retrieved.

  • Manipulate data to represent special business rules.

  • 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 retrieved.

rblnValidateAfterCustomRetrieve

Boolean

Output

Whether SP Client should validate the retrieved data after its call to ProcessRetrieveData returns.

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.