GetRetrievableDocTypes As IEFDocTypes - 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 document types that the tool can retrieve as IEFDocTypes collection object. Tools will implement this method to obtain the list of retrievable document types by the tool, add them to IEFDocTypes collection object, and return the collection object.

Retrievable document types should also include PBS document type and WBS document types if the design tool will support retrieval of these types. A PBS document describes the Plant Breakdown Structure of a plant.

A WBS document describes Work Breakdown Structure. There will be two types of WBS documents. The first type describes project collection in a plant. The second type describes the Work Breakdown Structure within a project.

In a SmartPlant Foundation plant, there will be one PBS document, one WBS document that has all projects in the plant, and a separate WBS document per project describing the structure under a project.

Most of the tools will be interested in the PBS document and the WBS document that has the project collection. Only Intergraph SmartTM 3D will be interested in the WBS document that describes the structure below project. Except Smart 3D, all tools will return PBS document type and WBS document type (project collection) as retrievable document types along with other document types that they support in retrieve.

See SmartPlant Schema documentation for details on PBS document type and WBS document types.

Arguments

None.

Return Value

Retrievable document types as IEFDocTypes. If the method fails, the return value is Nothing.

Comments

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