Provide database configuration information - Intergraph Smart 3D Web API - Installation & Upgrade - Hexagon PPM

Intergraph Smart 3D and Smart 3D Admin Web API Installation and Configuration

Language
English
Product
Intergraph Smart 3D Web API
Subproduct
Smart 3D Web APIs
Search by Category
Installation & Upgrade
Smart 3D Version
13

Use the Configuration Utility's Web API Database page to define the database where the configuration information for this instance of the web API is stored. This makes the instance accessible by other API components.

This page is different depending on your database provider, MSSQL or Oracle.

How do I get to this page?

For both the Smart 3D Web API Configuration Utility and the Smart 3D Admin Web API Configuration Utility, the Web API Database page is the first page that appears when you are configuring database connections and prerequisites, after you select the Configure Database Connection and Prerequisites option on the Configuration Utility's Welcome page.

MSSQL

Oracle

Tell me more about database creation and configuration.

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 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)

  • Migrating an out-of-date configuration database, when prompted. At the prompt, click Migrate to upgrade the database, or click Cancel to configure a new one. Migrating the database does not affect the Intergraph Smart 3D site, catalog, or model databases.

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

  2. Complete the information for your database provider:

    • For MSSQL - For Server Name, enter the instance name. For Database Name, enter the database name.

    • For Oracle - For Protocol and Host Name, Port Number, and Service Name enter the details for connecting to the database. For Database Name, enter the schema name.

  3. Your next step depends on whether this database has already been set up for Smart 3D web services:

    • If this database does not exist or has not previously been used for configuring Web APIs for Smart 3D - Click Set Up New and continue with the next topic, Configure database for use with web APIs.

    • Otherwise - Click Test Connection to test connecting to the database with the given credentials.

  4. Click Next, and continue with Define caching location.