Publish Functions - 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)

You can publish one or more documents with the Publish method.

Publish is handled as a transaction. There is a call to begin the publish operation (GetDocumentListContainerForPublish), a call to cancel the publish operation (ReleasePublishDocumentListContainer), and a call to proceed with the publish operation (Publish). The reason to have Publish in a transaction is for better management of Container Compositions and Containers and to avoid any possible memory leaks.

A design tool should always use these functions in a similar manner to calls made for a database transaction. For every GetDocumentListContainerForPublish call, there should also be a call made to ReleasePublishDocumentListContainer or Publish.

GetDocumentListContainerForPublish will create necessary Container Compositions and Containers, and the pointer to the container object will be returned. The design tool will use the container to identify the documents selected by the users and call the Publish.

The ReleasePublishDocumentListContainer call should be made after the GetDocumentListContainerForPublish call if an error occurs or if the operation is cancelled for some reason.