Configure Database Connection and Prerequisites - Intergraph Smart 3D Web API - Installation & Upgrade - Hexagon PPM

Intergraph Smart 3D Web API Installation and Configuration

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

Before starting, the prerequisites must already be installed.

  1. On the Smart 3D Web Server computer or on one of the Smart 3D Web Services computers, select Start > Intergraph Smart 3D > Web API Configuration Tool.

  2. On the Welcome page, select Configure Database Connection & Prerequisites.

  3. Click Next.

    The WebAPI Database page displays for entering the definition of the configuration database. This database information defines where the configuration information for this Web API instance is stored so it can be access by the various Smart 3D Web API components.

    A database can only store the configuration information for a single Smart 3D Web Server. If you have multiple Smart 3D Web Servers (for example, to support multiple Smart 3D sites), each server must have its own configuration database.

    There are no special requirements for this database other than the user who is executing the Configuration Tool must have access to write, create tables and optionally create the database. The database must be accessible for read/write access by the other Smart 3D Web API components. You can create this database by:

    • Using the already existing Smart 3D site database (easiest)

    • Creating a new database within this tool (least control over database attributes)

    • Creating a new database prior to using the Configuration Tool (most control over database attributes)

    • You are prompted to migrate an out-of-date Web API database. Click Migrate to upgrade the database, or click Cancel to configure a new Web API database. Migrating the Web API database does not affect the Intergraph Smart 3D site, catalog, or model databases.

      To define this database connection information:

    1. In the Database Provider field, select either MSSQL or Oracle.

    2. In the Server Name field for MSSQL, type the instance name. For Oracle, type the Oracle service name.

    3. In the Database Name field for MSSQL, type the name of the database. For Oracle, type the name of the schema.

    4. If this database does not exist or has not previously been used for storing Smart 3D Web API configuration, click Set Up New. This displays the Configure New Web API Database dialog. This dialog summarizes the database information previously entered and asks for Admin Credentials that are used to setup the database.

      1. In the Authorize Using section, choose either Windows Credentials (uses the current user login) or Provide Username and Password (requires the username and password of a database user with administrative permissions).

      2. Click Create to create the database if it does not already exist.

    5. In the Authorization section, choose Windows Credentials or Provide Username and Password and provide the username and password of a database user. This user is used by the Configuration Tool to store the remaining configuration information and is saved (with password encrypted) for use by the other Smart 3D Web API components.

      If a username/password is given, it is used only for accessing the Web API configuration information. For accessing the Smart 3D databases, the normal Smart 3D access mechanism is used.

    6. Click Test Connection to test connecting to the database with the given credentials.

    7. Click Next.

      The Cache Options page displays options for defining the location used for caching URL results.

  4. Select either Shared Redis Cache or Local Process Memory Cache. The Local Process Memory Cache option caches the results within the IIS process. If this option is selected no further input is required on this page. The Shared Redis Cache option will cache the results in a Redis service that was previously installed and configured (see Installing Redis (Optional)). If this option is selected, values must be entered into the following fields:

    1. In the Server Name field, type the computer name where the Redis service is running followed by a colon and then the port given during the Redis installation. For example, mymachine.domain.com:6379

    2. In the Redis Database field, type the number of the Redis database (by default 0-15) to change from the default of 0. Normally, this does not need to be changed.

    3. Check Allow Admin Connections to allow admin connections. Normally, this is not required.

    4. Click Test to verify the connection information.

    5. Click Next.

      The RabbitMQ Connection page displays. This page allows you to define the RabbitMQ instance that is used for messaging by the Smart 3D Web API.

  5. Define the RabbitMQ information.

    1. In the RabbitMQ Server Name field, type the computer name where RabbitMQ service is running. For example, mymachine.domain.com

    2. In the Port field, type the port number for RabbitMQ. The default is 5672 for non-SSL and 5671 for SSL.

    3. If you plan to use SSL encryption, select SSL encryption, User/Password based Authorization in RabbitMQ security options. See "Configure SSL for RabbitMQ" in Installing Rabbit MQ before selecting this option as you need certain prerequisites for selecting this option.

    4. In the Username and Password fields, type the login defined in the RabbitMQ management plugin.

    5. Click Next.