Configure and register Smart Electrical Web API with SAM - Intergraph Smart Electrical - Installation & Upgrade

Intergraph Smart Electrical Web API Installation and Configuration

Intergraph Smart Electrical
Search by Category
Installation & Upgrade
Smart P&ID Web API Version
Smart Electrical Web Version
Smart Instrumentation Web Version

Before you can view your plant data, you must follow configure the Smart Electrical Web API server to authenticate your user credentials. This procedure explains how to configure the settings for:

  • Automatic configuration of Smart Electrical Web API in IIS

  • Registration with the Smart API Manager (SAM)

  • Monitoring

  1. In the path where you installed the Smart Electrical server, navigate to the ConfigurationTool folder and right-click Intergraph.Configuration.Utility.exe.

  2. On the shortcut menu, click Run as administrator.

  3. In the Smart Configuration Utility, click the Smart API Manager Module icon.

    The Smart API Manager Module - Configuration Utility window opens on the Welcome page.

  4. Click Next.

  5. On the Smart API Registration (Step 1) page, do the following:

    1. In the API Manager Url box, type the Url for the Smart API Manager server you will use for authentication.

    2. Choose one of the following user authentication options:

      • Use Windows Authentication

      • Use User Name / Password

        Whichever option you choose, your login credentials must first be registered on SAM.

    3. To verify that your login credentials are valid, click Test.

      You will see an appropriate message.

    4. Choose one of the following registration options:

      • Register New Service

      • Update Existing Service

        If this is the first time you are registering a service, only the Register New Service option is available.

    5. For a new service, choose a prefix from the Service Prefix list, representing the software application and version.

    6. If updating an existing service, choose the service you want to update from the Service Id list.

      For a new service, the service Id is generated automatically at the end of the registration process.

    7. Type a string in the Service Secret box or click Generate to generate a secret automatically.

      The secret must consist of at least one uppercase character, one lowercase character, one number, one of the following special characters: &!@#$%*=. , and must be between 8 and 64 characters in length.

    8. Click Next.

  6. On the IIS Configuration (Step 2) page, in the Application Name and Application Pool fields, type new values, for example:

  7. Beside the Application Identity field, do the following:

    1. Click Change.

    2. In the Application Pool Identity dialog box that opens, click Custom account.

    3. Enter the user name in the Login field and type the password.

    4. Click Test to ensure that the login values are valid.

    5. Click OK to close the Application Pool Identity dialog box.

      The Application Identity user must have Domain Admin rights on the machine where IIS is installed. This is an essential requirement because this user must have permissions to:

    • write log messages under the installation folder.

    • save temp files, such as %temp%.

    • access network resources, such as .ini path and plant reference data.

  8. Fill in the remaining information on the page.

    • Ensure that the Enable Https check box is selected and that you have a valid https certificate.

    • For the port settings, we recommend entering port number 80 for http and port number 443 for https.

  9. Click Next.

  10. On the Monitoring Configuration (Step 3) page, accept the default values or make changes and then click Next.

  11. On the Configuration Preview (Step 4) page, review your settings.

    SHARED Tip To save your configuration settings in a file to run in unattended mode, click Save To File.

  12. Click Finish to save your changes and begin the configuration.

    A page opens showing the status of each activity and an overall progress bar.

  13. On completion of the configuration, click the close box to exit the Smart Configuration Utility.