Upgrade using the command line - Intergraph Smart 3D Web API - Update 2 - Installation & Upgrade - Hexagon

You can upgrade using the command line configuration tool instead of the interactive Configuration Utility.

For more help, see Command Line Help.

Export the API config file

You only have to do this once. The configuration for both APIs is stored in the configuration database. When you export the API config file, it includes the configuration for both APIs.

1. Log onto the web server.

2. Export your existing configuration on the web API computer:

   • If the file is encrypted, use:

     start /wait Smart3DWebApiConfigurationUtility.exe /x /f <WebConfigFile> /p <EncryptionPassword>

   • If the file is not encrypted, omit the /p <EncryptionPassword>.

   Where:

   • WebConfigFile - The full directory path and name for the file.

   • EncryptionPassword - The password used to encrypt the file.

Upgrade software

You must repeat these steps for each machine used as a web server or to run the web services.

1. Log on to the machine.

2. Uninstall the web API from your computer.

   The following file remains on the machine: C:\Program Files\Smart3D\WebApi\Services\Bin64\S3DRuntime.config. Do not delete it.

3. If necessary, uninstall then reinstall Smart 3D and other prerequisites.

4. If you installed a new version of the Smart 3D software, migrate the Smart 3D database.

5. Install the new version of the web API. For instructions, see Installing Web APIs for Smart 3D.

Apply API configuration after upgrade

Note that:

• If you are making changes to the API configuration as part of the upgrade, you must make those changes to the exported configuration file before importing it.

• When a configuration file is decrypted, the decrypted file overwrites the encrypted file. If you want to keep the encrypted file, save a copy before you move on.

If you want to make changes to the API configuration before applying it, do that first:

1. If the API configuration file is encrypted, decrypt it:

   start /wait Smart3DWebApiConfigurationUtility.exe /d /f <WebConfigFile> /p <EncryptionPassword>

   1. Make your changes to the file. For help with the configuration file format, see API configuration files.Import the configuration file.

To apply API configuration, import the API configuration file.

1. Log on to the web server.

2. Import the API configuration file.

   • If the file is encrypted:

     start /wait Smart3DWebApiConfigurationUtility.exe /i /f <WebConfigFile> /p <EncryptionPassword>

   • If the file is not encrypted, omit the /p <EncryptionPassword>.

   You may see one or more prompts related to the configuration database, as follows.

3. If the database is out of date, you are prompted to migrate it. You can either:

   • Migrate the database from the command line:

     start /wait Smart3DWebApiConfigurationUtility.exe /m

   • Upgrade the database manually then return here to complete the API configuration.

4. If this is an Oracle database and the configuration file does not contain the full datasource string, you are prompted to enter the database server details. Enter the host name, service name, protocol, and port.

5. If either of the following is true, you are prompted to regenerate the metadata for enabled plants:

   • You upgraded to a newer version of Smart 3D

   • The catalog data for an enabled plant has changed

   To regenerate metadata:

   start /wait Smart3DWebApiConfigurationUtility.exe /m