GetUserSelections - 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 will be called in the Publish dialog box by the EFCommonUI component when the user wants to select documents in the tool. Tools will implement this method to do the following:

Document selection the EFCommonUI is shown in context of the specified site, plant and project. In the case of Smart Instrumentation, the site is Domain.

User selects documents to publish.

For each selected document,

  • Create an instance for the document object in the oDocIContainer container.

  • Get the IObject and IDocument interfaces.

  • Populate the IObject and IDocument properties.

  • Get the IIssueRecordComposition and IDocVersionComposition interfaces.

  • Tools should be careful not to add an existing document object in a container. It is possible that the container has documents before this method is called.

  • 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 oDocIContainer:

    • 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

sSPFURL

String (maximum 128 characters)

Input

The SmartPlant Foundation URL that is currently connected to.

sSPFPlant

String (maximum 254 characters)

Input

Name of SmartPlant Foundation plant that is currently connected to.

sSPFProjectUID

String (maximum 128 characters)

Input

Unique ID of the SmartPlant Foundation project. If not connected to a project, it is NULL.

sSPFProjectName

String (maximum 256 characters)

Input

Name of the SmartPlant Foundation project. If not connected to a project, it is NULL.

oToolParameters

IEFToolParameters

Input

Collection of tool parameters that were passed in the Connect call of the IEFCommonUI interface. Typically, tools will pass a set of tool specific parameters for their internal use.

oDocIContainer

IContainer

Input/Output

IContainer pointer to documents container.

Return Value

None

Comments

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