Configuring the Smart 3D Service - Intergraph Smart 3D Web API - Installation & Upgrade - Hexagon PPM

Intergraph Smart 3D Web API Installation and Configuration

Intergraph Smart 3D Web API
Installation & Upgrade
12 (2018)

Perform the following configuration steps on each computer that hosts the Smart 3D Service.

You must install Intergraph Smart 3D, including the 64-bit services option, on each computer before starting this procedure.

  1. Select Start > Intergraph Smart 3D > Web API Configuration Tool.

  2. On the Welcome page, select Configure Smart 3D Data.

  3. If you did not configured your Web API Database Connection and RabbitMQ service previously, the Configure Database Connection & Prerequisites check box is automatically selected and the steps defined in the Configure Database Connection and Prerequisites section are invoked before starting the Web Site configuration. Click Next.

  4. If the Intergraph Smart 3D Web API Service Manager Windows service is not running, the Smart 3D Service Manager page displays.

    1. Type the username and password for the service to run under.

      Because this login is used to run a Windows service, it must have Log on as a service rights on the computer. Unless you have set up Smart 3D to support database user access, this login is also used to access the Smart 3D databases so it must also have database access.

  5. If the Smart 3D site has not already been defined by configuring another computer, the Add Site page displays.

    1. Type a name in the Site Alias field. This alias is used in the Web API URL requests to represent the combination of the Smart 3D site database name and the server on which it is installed.

    2. Type the Smart 3D database server name in the Server Name field.

    3. Type the Smart 3D site database name in the Database Name field.

    4. Select the database provider.

    5. Click Add Site.

      The Sites page displays.

  6. Review the Smart 3D site connection information on the Sites page.

    1. To connect to a different site, select the row containing the site information, and then click the red X. Do this before going to the next page. After the connection is established, it is persistent throughout the lifetime of the application.

    2. Click Next.

      The Enable Plants page displays.

  7. On the Enable Plants page, you select which plants within the site are exposed through the Smart 3D Web API.

    1. Select the plants you want to expose.

    2. Click Enable Selected Plants. This sets the plant as enabled and extracts metadata from the plant’s schema that is used to construct the Web API EDM.

      If the plant’s metadata changes, you must come back to this page and click Regenerate Metadata.

    3. Click Next.

      The Local Smart 3D Instances page displays.

  8. On the Local Smart 3D Instance page, you configure the number of Smart 3D Service instances to run on the local computer for each enabled plant.

    The table lists only the plants with instances defined to run on the local computer. The Machines page, which displays after you apply the configuration, shows all computers. Use this page to modify instances on any configured computer.

    1. Press + to add one or more instances for an additional plant on the local computer.

      1. From the Plant Name field, select the plant for which instances are to be added.

      2. In the Count field, type the number of instances to start on the current computer.

      3. Click Add.

    2. For plants that already have instances defined to run on the current computer, you can change the number of instances by:

      1. Double-click on the cell in the Count column for the plant to edit.

      2. Type the number of instances for the plant.

      3. Press Enter.

  9. Click Next.

    The Configuration Summary page displays.

  10. Review the configuration. If there are errors, click Back to go to the page where the correction can be made. If everything is correct, click Finish.

    A status box displays the results of the operation.

  11. Click Close on the status box.

    The Machines page displays. This page allows you to review and modify all of the Web Server and Service instances defined on each computer.

  12. Click Close.