See Installation configuration settings for a full list of settings.
The domain in the settings below must be lowercase. For example, server.yourorganization.com, not Server.YourOrganization.com.
Required.
Name | Description | Example value |
AppDomain | The full domain under which Advance is installed. This should be the same as the host used for your HTTPS binding in IIS. | server.yourorganization.com |
AuthUrl | URL for the Advance authorization application. You should update the URL to include the domain under which Advance is deployed. Leave in the {tenancy} placeholder value; this placeholder is required by Advance. | http://{tenancy}.server.yourorganization.com/HdaAuth |
ApiUrl | URL for the Advance APIs application. You should update the URL to include the domain under which Advance is deployed. Leave in the {tenancy} placeholder value; this placeholder is required by Advance. | http://{tenancy}.server.yourorganization.com/HdaApi |
RootUrl | URL for the Advance root application. You should update the URL to include the domain under which Advance is deployed. Leave in the {tenancy} placeholder value; this placeholder is required by Advance. | http://{tenancy}.server.yourorganization.com/HdaRoot |
Required. Settings for the Advance user interface and API.
Name | Description | Example value |
AssemblyServiceUrl | The URL for the HotDocs Core Assembly Service. The service is required to generate interviews and assemble documents. You should install the Core Assembly Service before deploying Advance. See Get the HotDocs Core Assembly Service URL for more information. | https://server.yourorganization.com/AssemblyService |
ApiSiteSettings.AppSettings.TemplateDownloadUrl | The URL that tells the Core Assembly Service where to download HotDocs templates from Advance. This is required by the Core Assembly Service when it generates interviews and assembles documents. Leave in the {tenancy} placeholder value; this placeholder is required by Advance. | http://{tenancy}.server.yourorganization.com/api/rest/v0.1/TemplatePackageVersions/ |
UiSiteSettings.AppSettings.AuthorDownloadUrl | URL for a link to download the HotDocs Author template authoring tool. You must store the executable for Author on your own server, to make it available for download. Note, this link is only available for Advance users with the 'Author' user role | https://server.yourorganization.com/AssemblyService/author/setup64.exe |
Required. Settings for the initial root user of Advance.
Name | Description | Example value |
ApiSiteSettings.InitialUser.FirstName | First name of the initial root user. The root user can log in to the Advance root application and create new tenancies. | |
ApiSiteSettings.InitialUser.LastName | Last name of initial user. | |
ApiSiteSettings.InitialUser.EmailAddress | Email address of initial user. | |
ApiSiteSettings.InitialUser.Password | Password for initial user. The user will be prompted to change their password when they first log in to Advance. |
Name | Description | Example value |
ApiSiteSettings.InitialUser.LoginName | Login name of the initial root user. The root user can log in to the Advance root application and create new tenancies. |
Optional. See client credentials for more information.
Name | Description | Example value |
AuthSiteSettings.AuthClientCredentials.ClientName | The client used to authorize requests to the Advance authorization application. It is recommended that you change this setting before deploying Advance. | |
AuthSiteSettings.AuthClientCredentials.ClientSecret | The secret for the AuthClient. It is recommended that you change this setting before deploying Advance. | |
AuthSiteSettings.AuthClientCredentials.PrincipalName | It is recommended that you change this setting before deploying Advance. | |
AuthSiteSettings.AuthClientCredentials.PrincipalPassword | The password for the authorization application Principal user. It is recommended that you change this setting before deploying Advance. | |
RootSiteSettings.RootClientCredentials.ClientName | It is recommended that you change this setting before deploying Advance. | |
UiSiteSettings.UiClientCredentials.ClientName | It is recommended that you change this setting before deploying Advance. |
Required. The connection strings for the Advance databases.
Name | Description | Example value |
ApiSiteSettings.ConnectionStrings.Root | Connection string for the Advance root database. | |
ApiSiteSettings.ConnectionStrings.TenancyDefaults | Default connection string for each Advance tenancy database. Each tenancy in Advance uses its own database to store tenancy-specific information. |
These settings are not required if you are using Active Directory with Advance.
Name | Description | Example value |
SmtpFromAddress | E-mail address used to send e-mails from Advance. For example, password reset e-mails and user activation emails. | noreply@yourorganization.com |
ApiSiteSettings.SmtpSettings.HostAddress | SMTP server host address | |
ApiSiteSettings.SmtpSettings.HostPort | SMTP server port number | |
ApiSiteSettings.SmtpSettings.UserName | Username used to connect to SMTP server | |
ApiSiteSettings.SmtpSettings.Password | Password associated with the user above |