Configure the installed Smart Instrumentation server - Intergraph Smart Instrumentation - Version 2.3 - Installation & Upgrade

Intergraph Smart Instrumentation Web API Installation and Configuration Guide
Language
English
Product
Intergraph Smart Instrumentation
Subproduct
Web API
Search by Category
Installation & Upgrade
Smart Instrumentation Web Version
2.3

The following procedure for configuring Smart Instrumentation Web API server to your site and authenticate your user credentials requires that you edit certain values in the Web.config file using a text editor such as Notepad++.

SHARED Tip You should make a copy of the Web.config file before making changes.

Navigate to where you installed Smart Instrumentation, by default C:/Program Files (x86)/SmartPlant/Instrumentation/Web Services/SI WEB API <version number>.

  1. Locate the Web.config file and open it in a text editor of your choice.

  2. In the open text document, locate fields separated by %_%, for example %BaseURL% and replace the string (including the %%) with your data. The table below, shows the list of variables and required replacement values.

    Look for:

    Replace with:

    %BaseURL%

    Replace with your full server name, for example: https://Name.Domain.com

    %SAM_Resource_Identifier%

    Change to the following temporary identifier: 77FB732E-463F-4358-A04C-E2AD3620D354

    %SAM_Secret%

    Change to the following temporary secret:
    samAPISecret

    %SAM_Issuer%

    Replace with your SAM Issuer

    %Swagger_Client_Identifier%

    F3D38862-81F2-4839-A774-B76C351BD087

    Enables access to the Smart API Explorer from the browser without having to log into SAM.

    • The SAM_Resource_Identifier and the SAM_Secret are temporary values that you replace after registering your API.

    • This version of Smart Instrumentation Web API requires Intergraph Smart Licensing Client (ISL).

  3. In the open text document, locate the tag <licensing projectName=.

  4. For the Project Name, after the equals sign, type in the exact name of the project in quotation marks as it appears in the Intergraph Smart Licensing configuration. For example, = "SI_WebAPI_Project".

  5. Locate the tag <license tag= and do one of the following:

    • If you have purchased a Read/Write license, after the equals sign, type in quotation marks "InstrumentationWebWrite".

    • If you have purchased a Read Only license, after the equals sign, type in quotation marks "InstrumentationWebRead".

  6. Save the changes to your configuration file.

Test your Server Connection

  1. On the machine where you installed the API server, open a browser window, for example Internet Explorer.

  2. In the address line, type the following: https://Your Base URL/api/si/<version number>/Description. The result is a payload with the API description.

SHARED Tip If no payload is returned with the API description, check all your settings are correct and try again.

Register a Web API in Smart API Manager

You should now register your API with the SAM Issuer and then edit the Web.config file by copying the SAM_Resource_Identifier and the SAM_Secret from your SAM settings to the fields in the Web.config file where you inserted the temporary identifiers and secrets.