Configure Spoolgen Web API - Intergraph Spoolgen - Installation & Upgrade - Hexagon

Before you can view your piping data, you must configure the Spoolgen Web API service to authenticate your credentials.

This procedure explains how to use the Configuration Tool to configure settings for:

• Automatic configuration of Spoolgen Web API in IIS

• Registration with Smart API Manager

The Configuration Tool is a wizard-style application that steps you through the configuration process. The application starts automatically (unless you clear the Run Configuration Tool after Installation check box in the setup). To start the Configuration Tool, browse to and double-click the executable file: [Spoolgen Web API Install Folder]\Configuration folder, and double-click the Intergraph.Spoolgen.WebApi.ConfigurationTool.exe file.

• You must have Intergraph Smart API Manager installed and configured before you can register Spoolgen Web API with Smart API Manager.

• When configuring Spoolgen Web API, you must use an account with database administration rights on the SQL Server instance to create databases and tables.

• Make sure that IIS has been restarted after installing the .NET Core Runtime 2.1 Hosting Bundle. You can do this by restarting the server.
  

1. Click Next on the Welcome page.

2. On the Service Database Configuration page, use the SQL Server Name and Database Name boxes to specify the SQL Server URL and the name of the Spoolgen service (piping) database.

3. In the System Administrator Account section, provide credentials for the database user used to create or modify the database structure or schema. Select Use Windows Authentication to connect to SQL Server via Windows authentication using your current Windows credentials. Select Use User Name / Password to connect to SQL Server via SQL Server authentication using the login/user credentials you enter.

4. Click Test to ensure that the connection is successful.

5. In the Runtime Account section, provide credentials for the database user used to connect to database at runtime. The user account you enter must have read/write access to the database but does not require administrative privileges. Using Windows authentication is the preferred method for your runtime account.

6. Click Test to ensure that the connection is successful.

7. Click Next to go to the API Registration page.

8. Type the URL for the Smart API Manager server to use for authentication.

9. Type the User Name and Password that you specified when setting up the Smart API Manager administrator account.

10. To verify that the login credentials are valid, click Test.

11. Click Generate to generate a service secret and display the string in the Service Secret box.

    

    • Secrets consist of at least one uppercase character, one lowercase character, one number, one of the following special characters: &!@#%*=., and must be between 8 and 64 characters in length.

    • If this is the first time you are registering a service, only the Register New Service option is available.

    • For a new service, the Service Id is generated automatically at the end of the registration process.

12. Click Next to go to the IIS Configuration page.

13. If needed, click Override in the Base Address section and modify the base address for the Spoolgen Web API. Overriding the base URL is optional and only becomes important for load balancing or handling redundancy behind the scenes.

    By default, Application Name is set to Spoolgen and is not editable.

14. Click Next.

15. Review your configuration settings on the Configuration Preview page. Click Back to make any changes.

16. If needed, click Save Config to save your configuration settings to a file that you can run in unattended mode.

17. Optionally, select Run Health Checks to run diagnostics after configuration completes. The diagnostics confirm all major components for Spoolgen Web API are running and configured properly.

18. Click Finish to apply all settings and begin the configuration.

    A page displays showing the status or each activity and an overall progress bar.

19. After applying the configuration and running the health diagnostics, click Finish to exit the configuration utility.

To find your Web API URL, select Open Spoolgen Web API in Browser before exiting the configuration utility. The software opens your default browser and displays the URL in the address bar.