Get started with a Configuration Utility - 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

The Smart 3D Web API and Smart 3D Admin Web API each has its own Configuration Utility. For each web API, you use its utility anytime you need to:

  • Configure the web API after installation

  • Change that configuration later

  • Reconfigure a web API after its upgraded

While many of the steps are the same and the same help topics are used for both, you must configure each web API on a machine separately using its utility.

Open a Configuration Utility

  1. If you are configuring the API for the first time on this machine, make sure all the prerequisites are installed.

    Before you can configure a web API on a machine, make sure that the following are already installed.

  2. Click Start > Intergraph Smart 3D.

  3. Choose the tool for the Web API you're configuring, either Web API Configuration Tool or Admin Web API Configuration Tool.

    The Configuration Utility opens to the Welcome page, which looks something like this.

    The Welcome page has separate option for each configuration task.

    Learn more about what each option covers.

    Each option gathers specific information:

    • Configure Database Connection & Prerequisites - Provide information like database connection, caching, and messaging.

    • Setup Web Server - Provide information like the website name and authorization provider.

      Completing this task in the Configuration Utility does not complete the Web Server set up. Using other tools, you configure other parts of the environment like the application pool, web server file permissions, access claims, and app settings.

    • Configure Smart 3D Data or Configure Smart 3D Admin Data - Choose how many service instances to run. If you're configuring the Smart 3D web API, you also choose the sites and plants to use.

Choose an option on the Welcome page

  1. Choose an option based on what you're doing.

    If you are

    Do this

    Starting first-time configuration of a web API on this machine

    Select Configure Database Connection and Prerequisites to get started.

    Continuing first-time configuration of a web API on this machine

    Select the option following the section where you left off.

    Changing the web API configuration on this machine

    Choose any option to make changes.

    Reconfiguring the web API after its upgraded

    Clear all the options, and follow the tasks laid out in Upgrading Web APIs for Smart 3D.

    While you do use the same utility for upgrades, the instructions are very different from first-time configuration or later changes.

    The Configuration Database Connection & Prerequisites option might be checked automatically.

    The database connection and/or RabbitMQ service is not configured. After you click Next, the utility will take you through the incomplete sections first.

  2. Click Next.

    The Smart 3D Service Manager page might appear.

    The Smart 3D Service Manager page appears if the Intergraph Smart 3D WebApi Service Manager Windows service is not running.

    To start the service, 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.

From here, you'll complete the steps for the option you chose: