Configure for Server Connection - Intergraph Smart Review - Help

Intergraph Smart Review Help
Language
English
Product
Intergraph Smart Review
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart Review Version
2020 (15.0)

For connection to a Smart 3D, SPF, or SDx server, you must first register Smart Review as a client application to define an authorized or secure client-server connection. This section contains information on configuring a connection based on the server authentication application.

  • To enable connection to an SPF or SDx server, register Smart Review as a client application through either the legacy Intergraph Authorization Server, the Smart API Manager, or a third party authentication management software.

  • To enable connection to a Smart 3D server, register Smart Review as a client application through either the Intergraph Smart API Manager or a third party OAuth 2.0 authentication management software.

Smart Review is pre-configured for new HxGN SDx sites when the authorization server uses the Security Token Service (STS). For existing or new sites that use a different authorization server type, such as Okta, you must manually register Smart Review. For more information, see Register Smart Review with Integrated Windows Authentication (IWA) server in the SmartPlant Foundation Desktop Client Help.

Use the Intergraph Authorization Server for SPF/SDx Server Connection

From the Intergraph Authorization Server application on your server system, Smart Review as a client requires the following settings:

  • Client ID

  • Client Name

  • Flow

  • RedirectURI

  • Client Secret

  • Redirect URI

You can define additional server application settings as you need. For more information on the available options, see Client application settings and Register applications in the SmartPlant Foundation with HxGN SDx Help.

  1. Before you open the Intergraph Authorization Server application, you must obtain the token audience ID for your server that is required for the scope setting. You can get the token audience ID from the description of the server URL. Enter the server description URL in a browser.: 

    • Example description query: https://[MachineName].[DomainName]/[ServerName]Server/API/V2/description

    • Example retrieved token audience: EE9C5479-A52E-4D11-80AE-BFDDCE9A603F

  2. From the Intergraph Authorization Server, select Applications from the vertical menu, and define the following:

    1. For the Client Name, type SmartReview.

    2. For Flow, select AuthorizationCodeWithProofKey.

    3. For the Client ID and associated secret, type the ID and secret values for Smart Review provided in the ConnectionSettings.ini file located in [Install drive]:\Program Files\SmartPlant\Review\Api\SmartReviewConnector.
      -OR-
      Use your own custom ID and secret.

    4. For the Secret:

      • ClientSecretType: use the default value null.

      • Value: type the secret ID value.

      • Description: use the default value null or type your own brief description.

    5. If you use your own client ID and secret, you must add the client ID and secret values to the [Install drive]:\Program Files\SmartPlant\Review\Api\SmartReviewConnector\ConnectionSettings.ini file. The client ID and secret in the ConnectionSettings.ini file must match the ID and secret in the authentication application.

    6. For Redirect URIs, type http://127.0.0.1:8077.

    7. Make a copy of your updated ConnectionsSettings.ini file to distribute to all Smart Review users requiring server connection. Smart Review only connects to the server you configure. To connect to another server, type the same client ID and secret in the authorization server application and in the ConnectionSettings.ini file.

  3. To create a scope for your Smart Review client, select Scopes on the vertical menu > Add New Scope, and then define the following:

    1. Select Resource as the Type.

    2. For the Name, type the audience token ID server description obtained in step 1.

    3. For the Display Name, you can use the Name value (audience token ID server description) or a different name for display.

  4. Save your edits and then restart the Internet Information Server (IIS) service.

  5. Continue to Open from SmartPlant Foundation or Open from SDx Operations.

Use a Third-Party Authentication Management Application for SPF/SDx or Smart 3D Server Connection

For detailed information on registering and creating a client, see the documentation provided with your OAuth 2.0 authorization server.

  1. From your Oauth 2.0 authentication server application, create the client with the following values required for Smart Review:

    • Flow: AuthorizationCodeWithProofKey

    • Client Name: SmartReview

    • RedirectURI: http://127.0.0.1

  2. For the Client ID and Client Secret, enter the values for Smart Review provided in the ConnectionSettings.ini file located in [Install drive]:\Program Files\SmartPlant\Review\Api\SmartReviewConnector.
    -OR-
    Use your own ID and secret:

    1. Obtain and enter your client ID and secret.

    2. Add the client ID and secret values to the [Install drive]:\Program Files\SmartPlant\Review\Api\SmartReviewConnector\ConnectionSettings.ini file. The client ID and secret in the ConnectionSettings.ini file must match the ID and secret in the authentication application.

    3. Make a copy of your updated ConnectionsSettings.ini file to distribute to all Smart Review users requiring server connection. Smart Review only connects to the server being configured. To connect to another server, make sure that you enter the same client ID and secret in the authorization server application and in the ConnectionSettings.ini file.

  3. Continue to Open from SmartPlant Foundation, Open from SDx Operations, or Connect to a Smart 3D Server.

Use the Intergraph Smart API Manager Application for SPF/SDx or Smart 3D Server Connection

The Smart API Manager contains a generic Smart API Client for Smart Review connection.

  1. Add the following values to the generic Smart API client required for Smart Review:

    • Flow: AuthorizationCodeWithProofKey

    • RedirectURI: http://127.0.0.1

  2. Use the Client ID and Client Secret already populated for the generic Smart API Client.
    -OR-
    Use your own ID and client secret:

    1. Obtain and enter your client ID and secret.

    2. Add the client ID and secret values to the [Install drive]:\Program Files\SmartPlant\Review\Api\SmartReviewConnector\ConnectionSettings.ini file. The client ID and secret in the ConnectionSettings.ini file must match the ID and secret in the authentication application.

    3. Make a copy of your updated ConnectionsSettings.ini file to distribute to all Smart Review users requiring server connection. Smart Review only connects to the server being configured. To connect to another server, make sure that you enter the same client ID and secret in the authorization server application and in the ConnectionSettings.ini file.

  3. Save your edits and continue to Open from SmartPlant Foundation, Open from SDx Operations, or Connect to a Smart 3D Server.