You use the Configuration Utility to configure the following for Smart 3D Web APIs:
-
Configuration database for the API configuration information
-
Caching for the web services
-
Messaging for the web services
-
Smart 3D sites and plants enabled for use with the APIs
-
Web server setup to run the web services
-
Authorization Server for the APIs
-
Web services machines (machines where the services will run) and the number of instances to run on each machine
The APIs share the same database, sites and plants, and machines configuration. The
APIs can share the web server and authorization server configuration or have separate
configurations.
When to use the Configuration Utility
The Configuration Utility is a multi-purpose tool. You use it anytime you need to:
-
Configure the API components for the first time or after an upgrade
-
Change the configuration of a component
-
Configure an additional instance of a component on a new machine.
Where to find the Configuration Utility
The Configuration Utility is available on any machine where Smart 3D Web APIs are installed. To open it, go to:
Start > Intergraph Smart 3D > Web API Configuration Tool
How the Configuration Utility works
When you open the Configuration Utility, you see the Welcome page.
The Configuration Utility is dynamic. The options you pick on the Welcome page determine what pages appear as you move through the utility.
|
Option |
Utility page |
Used to configure |
|
Configure Database Connection & Prerequisites |
|
|
|
Configure Smart3D Data |
|
|
|
Setup Smart3D Plant Web Server |
|
|
|
Setup Smart3D Admin Web Server |
|
|
|
Any or none |
|
When you pick any option, the About the Summary page page appears. It shows the full configuration for both APIs.
How to Use the Configuration Utility
Most pages in the utility have several sections. You move through the pages, and sometimes through multiple sections for the same page, using the Next button.
For step-by-step instructions, see one of the sections in this help:
-
Basic Configuration Quick Guide - Use this section to step through the end-to-end workflow. This is best for simple, first-time configuration on a machine.
-
Configuration Help - Use this section to find topics for specific configuration needs. This is best for changing or expanding existing configuration.
What happens when you finish with the Configuration Utility
The configuration is saved to the database. The next time you use the utility, the existing configuration settings will appear.