You can configure Smart P&ID Web 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 as for previous software 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.
-
In the Smart WebAPI SPID installation folder, locate and open the web.config file.
-
Go to the 'IsGenerateCommonMetadata' setting and set its value as follows:
<add key="IsGenerateCommonMetadata" 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.
-
To set all item properties to appear in the plant metadata, set the value of this key to 'false', and use proper namespace for the request.
For example, to request a specific property in Query options: https://ilzvspidwapiida.ingrnet.com/webapi/spid/v2/Sites(‘SPPID2014_R1_Site’)/Plants(‘PlantName’)/Vessels/Com.Ingr.SPID.V2.SPPID2014_R1_Site.PlantName.Vessel/?$select=Description
The namespace value is 'Com.Ingr.SPID.V2.SPPID2014_R1_Site.PlantName'. Entity type is concatenated to the namespace indicating the Odata to search the property under 'Vessel'.
The namespace value can be found in the Common Metadata references for plant metadata.
For Smart P&ID Version 3.0.5 and above, the 'IsGenerateCommonMetadata' is set to 'False' by default.
-
When the ‘IsGenerateCommonMetadata’ parameter is set to 'false':
-
Common metadata contains only static information about plant reference data, entities, and their navigation properties only. All the non-navigation properties appear in plant metadata.
-
The plant metadata loads only on demand.
-
-
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 'IsGenerateCommonMetadata' setting is missing from the web.config file, the software behaves as if it were present with its value set to 'true'.