FindDocsToPublish - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM 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)

Description

This method should return the documents that need to be published. Some design tools will keep the required information (last published date, last modified date) in their database to determine if a document needs to be published. Design tools will implement this method to compare the last published date and the last modified date, and to add the document to the container passed if the last modified date is later than the last published date. If any documents have been created but not published yet, they need to be added to the second container passed to this method.

This method will be called for only those tools that support this functionality. That determination will be made by calling the SupportsFeature method with the FindToPublish argument as described in SupportsFeature As Boolean.

The default hierarchy for documents in the tree on the EFCommonUI Publish dialog box is Category > Type > Document. To make documents appear in a custom hierarchy, add objects and relationships to oDocsToPublishIContainer and oNewDocsToPublishIContainer:

For each custom folder create an instance of PublishDocumentFolder. Property IObject.Name will appear next to the folder’s icon in the Publish dialog box tree.

To make a folder appear with a custom icon, get the IPublishDocumentFolder interface of the folder object and populate the PublishDocumentFolder_NormalIconPath property with the full path to the icon to use when the folder is not selected and the PublishDocumentFolder_SelectedIconPath property with the full path to the icon to use when the folder is selected. Both properties may use the same icon.

To make one folder be the parent of another, create a DocumentFolderCollection relationship where the child is end 1 and the parent is end 2.

To make a document appear in a folder, create a DocumentsInFolders relationship where the document object is end 1 and the folder object is end 2.

Arguments

Name

Data type

Input/output

Description

oDocsToPublishIContainer

IContainer

Input/Output

IContainer pointer to documents container. Documents to be published should be added to this container.

oNewDocsToPublishIContainer

IContainer

Input/Output

IContainer pointer to documents container. New documents (not published previously) should be added to this container.

Comments

If the method fails, the tool will raise an error and set Err.Number and Err.Description appropriately.