ISPAdapter5 Interface (SmartPlant Schema Versions Supported) - 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)

This interface is added for tools to communicate the SmartPlant Schema (EFSchema.xml) versions supported by the tool.

When tools are integrated, the SmartPlant integration components have a requirement to know the version of the SmartPlant Schema supported by tools. There are two ways of a tool communicating the SmartPlant Schema versions supported.

  1. By adding a property called SupportedSchemaVersions in the tool’s mapping schema (tool schema). The mapping schema (tool schema) is the schema delivered by a tool that defines the mappings between SmartPlant Schema classes and tool object classes. The SupportedSchemaVersions property is defined on the ISchemaDependentItem interface on the instance of the SPMapSoftware classdef as shown below.

    <SPMapSoftware>

    <IObject UID="SPPIDMap" Name="SPPIDMap" />

    <ISchemaDependentItem SupportedSchemaVersions="03.08,04.02" />

    <IMapSoftware />

    </SPMapSoftware>

  2. If the tool does not have a mapping schema (tool schema), then it needs to implement GetSupportedSchemaVersions method on ISPAdapter5 interface to communicate the SmartPlant Schema versions supported.

If a tool does not support either of the above example shown, then SPCLCommonUI (SmartPlant Client) will assume that tool will support the version that is being used in the SmartPlant integrated environment. The versions of the SmartPlant Schema supported in the integrated environment in the current release are then 03.08 and 04.02.

The tool will need to convey only the major and minor numbers of the SmartPlant Schema as "xx.xx".