After installing Smart Electrical Web API, you need to configure it before you can start using it to send requests. Most of the required configuration is done using the Intergraph Smart® Configuration Utility, which includes the modules required for your application. There are also optional configurations such as setting automatic deletion of temporary files and generating common metadata for item properties.
To send OData requests, your user credentials must be authenticated; therefore Smart Electrical Web API will need to be registered with an authentication server such as:
-
Hexagon's Intergraph Smart API Manager (SAM) (recommended). For details, see Configure and register Smart Electrical Web API with SAM.
-
Okta
-
To register, you must be an Admin user with configuration permissions for the authentication server.
-
In the web.config file, located in the path ..\Program Files (x86)\SmartPlant\SEL Web API\, the value for the licensing tag licensing projectName must correspond to one of the projects that appears in the Client Settings > Project list in Intergraph Smart Licensing for the selected .cci file.
-
The configuration settings are saved in the customConfigSection.xml file located in the Smart WebAPI SEL folder in the installation path of the Smart Electrical server. All configuration should be performed using the Configuration Utility and not from this file. Also, unless otherwise stated in the Help, do not change the values of configuration parameters directly from the web.config file.
From Smart Electrical Web API Version 2.1.4 and higher, when the Configuration Utility is launched, the software checks for installed IIS required features and if any are missing, the following message screen appears:
To fix this issue, do the following:
-
Click the features link to see the list of missing IIS features, for example:
-
Click the here link to open the main Server Manager window, from where you can install the required IIS features. For details of the required IIS features and how to install them, see Install Internet Information Server on Windows Server.
-
After installing the IIS features, click Continue to proceed to the main Configuration Utility window.
The following video (approx. 3½ minutes) shows how to configure Smart Electrical Web API to work with your site and to obtain a valid authentication token for sending requests (the example shown is for Intergraph Smart® P&ID Web API):