Configuring HotDocs Web Services

You must configure HotDocs Web Services with the appropriate settings to authorize API requests to HotDocs Hub.

Note: You only need to follow the configuration steps below if you are:

• Integrating your own application with an installation of either:
• Hub with User Management
• Hub with User Management and Active Directory
• And using the RetrieveFromHub feature of HotDocs Web Services

In this Topic ShowHide

Prerequisites

• Install HotDocs Server and Web Services
• Configure HotDocs Hub to use HotDocs Web Services
• You should be able to log in to HotDocs Hub

To configure HotDocs Web Services for integrations

Edit the HotDocs Web Services web.config file

1. Navigate to the HotDocs Web Services installation directory; by default, this is C:\Program Files (x86)\HotDocs Server\HDSWebAPI.
2. Open the web.config file in a text editor.
3. Edit the following key's values, replacing the placeholder values with the values copied to your own text file:
• ClientScope – to find and set your client scope:
1. Open the HotDocs Hub UI.
2. Click the Config button (top-right corner) to download the Upload Plugin Configuration (.hdrepoconfig) file.
3. Navigate to the location of the downloaded .hdrepoconfig file.
4. Edit the .hdrepoconfig file in a text editor; the last line in the file is the client scope used to connect to Hub, typically UploadPlugin.
5. Navigate to the HotDocs Web Services installation directory; by default, this is C:\Program Files (x86)\HotDocs Server\HDSWebAPI.
6. Open the web.config file in a text editor.
7. Check that the last line in the .hdrepoconfig file matches the ClientScope value used in your HotDocs Web Services web.config file.
1. If the client scope does not match, change the Web Services ClientScope value to the value from the .hdrepoconfig file.
2. Save your changes.
• EnableOAuth2Security – set to true
• UserServiceBaseUrl – set to https://{servername}/HotDocsIdentityServer/core/, where servername is the name of the server on which Hub is installed.
4. Save your changes to the web.config file

HotDocs Web Services is now configured to connect to HotDocs Hub.

Next Steps

• Install HotDocs Developer for template users