Configure your Smart API to generate common metadata - Intergraph Smart Electrical - Installation & Upgrade

Intergraph Smart Electrical Smart API Installation and Configuration

Language
English (United States)
Product
Intergraph Smart Electrical
Search by Category
Installation & Upgrade
Smart P&ID Version
10
Smart P&ID Web API Version
2.0
Smart Electrical Web Version
2.1

You can configure the Smart Electrical Smart API to generate common metadata for item properties that are shared by all plants in all the registered sites, or to generate all item properties under the plant metadata (except for SP_IDs) as for previous Smart API versions. The common metadata configuration is required if you need to run your requests to support multi-tenant, multiple database platform, or multiple version environments, or within tools that support several applications, such as Hexagon Xalt.

  1. In the Smart Electrical Smart API installation folder, locate and open the web.config file.

  2. Go to the 'GenerateCommonMetadata' setting and set its value as follows:

    <add key="GenerateCommonMetadata" value="true" />

    This value sets the software to display in the common metadata all properties of items that are common to all the plants in all sites; properties that are not shared by all the plants appear in the plant metadata only.

  3. To set all item properties to appear in the plant metadata (except for the items' IDs), set the value of this key to 'false'.

  • Properties that appear under common metadata are unauthorized, that is, they can be viewed by any user. Properties that appear under the plant metadata require specific user credentials to generate an authorization token before the user can view them.

  • Regardless of the setting value, any properties that do not appear in all the plants appear under the plant metadata. For more details of how the settings affect the allocation of item properties between common and plant metadata, see Metadata configuration examples.

  • If the 'GenerateCommonMetadata' setting is missing from the web.config file, the software behaves as if it were present with its value set to 'true'.