GetDocTypeHierarchyForToolDocTypeID As Long - 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)

Some tools, such as Smart Instrumentation, have tool-specific publishable document types mapped to the SmartPlant schema document type hierarchy (document category, document type, and document subtype), defined in the tool metadata schema in EFSchema.xml. When interfacing with SmartPlant Common UI, the tool needs to know the mapping between a tool publishable document type and the SmartPlant schema document type hierarchy. This method returns the SmartPlant Schema document type hierarchy found in the tool metadata schema for a given tool document type.

The tool document type ID is defined by the tools in the tool meta-data schema (in EFSchema.xml) as a property, called ToolDocTypeID on the interface IDocumentType on the class DocumentType.

Tool metadata (for example, Intools_Meta.xml):

Class – DocumentType

Interface – IDocumentType

Property – ToolDocTypeID

For a given tool document type ID, the method searches the tool meta-data, and returns the SmartPlant schema document type hierarchy (document category UID, document type UID, and document subtype UID). If a tool document type ID is not found in the tool metadata schema, null values are returned for document category UID, document type UID and document subtype UID.

Arguments

Name

Data type

Input/output

Description

sToolDocTypeID

String

Input

The ID of the tool document type for which the document hierarchy needs to be found.

sDocCategoryUID

String

Output

The UID of the document category

sDocTypeUID

String

Output

The UID of the document type

sDocSubTypeUID

String

Output

The UID of the document subtype

Return Value

  • 0 if method is successful.

  • A negative number if method fails (check the LastErrorMessage property for error message).

Comments

None.