Configure the database - Intergraph Smart 3D Web API - Update 2 - Installation & Upgrade - Hexagon

To configure the database used to store configuration information for both APIs, you use the Configuration Utility's Services page, database sections.

Both APIs share the same configuration.

If you want to create a new database, the utility will do that for you here.

Go to the Services page > Web API Database sections

1. On any machine where the web API services are installed, open the Configuration Utility:

   Start > Intergraph Smart 3D > Web API Configuration Tool

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

3. Click Next until the Services page shows the Web API Database section at the top.

Web API Database section

See an example of Oracle.

1. Select your database provider, either MSSQL or Oracle.

2. Enter the database connection details in the fields that appear.

   • If you chose MSSQL:

     • Server Name - SQL Server instance name

     • Database Name - Name of the MSSQL database

   • If you chose Oracle:

     • Protocol - Protocol used to connect to the database

     • Host Name - Name of the server hosting the database

     • Port Number - The port used to connect to the database

     • Service Name - the name of the database service to connect to

     • Database Name - The name of the schema

   If you use an existing Smart 3D site database, you will be prompted to migrate the database if its configuration is out-of-date. Migrating the database does not affect the Intergraph Smart 3D site, catalog, or model databases. If you do not want to migrate the database, click Cancel and set up a new database instead.

3. Pick your path:

   • If the database is new or has not been used to store API configuration in the past - Click Set Up New and follow the next steps for the Configure New Web API Database dialog box.

   • Otherwise - Skip to the steps for the Authorization section.

Configure New Web API Database dialog box

See an example of Oracle with Windows credentials, SQL with provided credentials, or Oracle with provided credentials.

1. Provide the admin credentials the utility will use to create the API information in the database:

   • To use the Windows Azure Directory or Windows Active Directory credentials that you used to log into the machine - Select Windows Credentials.

   • Otherwise - Select Provide Username and Password and enter the database user credentials in the boxes that appear.

   The credentials you use must have access to write, create tables, and optionally create the database.

2. Click Create. The Configure New Web API Database dialog box closes.

3. Click OK.

Authorization section

See an example of provided credentials.

1. Provide the credentials the API will use to connect to the configuration database:

   • To use the Windows Azure Directory or Windows Active Directory credentials that you used to log into the machine - Select Windows Credentials.

   • Otherwise - Select Provide Username and Password and enter the credentials in the boxes that appear.

2. If you changed the database connection for an existing IIS site and application for web API, restart the IIS application pool and the IIS web application.