Create the adapter mapping document in SmartPlant Foundation - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The Tool Map Schema document can be created interactively or by using a load file.

To create the document interactively:

  1. Navigate the document category tree to System Documents.

  2. Use the Create Adapter command from the shortcut menu or the Adapter Document category. (Note that in 4.3.1 and before there is an error in this method. The relationship definition identified on the CreateAdapterDocument method should be SPFAuthAdapterClassClassDef.)

    1. Enter a suitable name such as PA Tool Schema.

    2. Enter the Adapter Code that will be used on the integration methods to identify the document, such as PA.

    3. Use the Attach Adapter command from the shortcut menu of the newly created document to attach the file. (Note that in 4.3.1 and before there is an error in this method. The AttachAdapter method identifies the SPFDesignFile class when it should be the SPFAuthAdapterFile class. This needs to be changed to ensure the code can find the adapter documents later. It is also a database file.)

To use a load file:

  1. Copy one of the sample load files, for example, ‘IPD Tool Map Schema Load.xml’ found on Smart Community. For more information, see Find sample data on Smart Community.

  2. Make the following changes to the load file.

    1. Change the name and UID of the document master, revision, and version consistently. The names of the document master, revision and version must be the same (for example, IPD Map Schema), and it is recommended that the UIDs contain master/revision/version and so on (for example, ToolMapSchema_IPDVersion).

    2. Change the name and file name of the SPFAuthAdapterFile object to match the tool map schema file name.

    3. Update the relationships matching the changing UIDs of the document and file.