Configuration parameters in appSettings

Prev Next

The following parameters can be configured for the dox42 Server within the <appSettings> element of the web.config file.

Parameters

Parameter

Requirement

Description

LicenseFilePath

optional

Indicates the path to the location of the license file. If no license file exists, the dox42 Server will contact the dox42 license server to verify the license key. If successful, the server will write the license file to the location under the path indicated in the configuration.

LicenseKey

mandatory

Specifies the license key of the dox42 Server.

MailServer

optional

Specifies the e-mail server for sending emails.

MailServerPort

optional

Specifies the e-mail server port.

dox42ServerMail

optional

Specifies the sender’s default address of the dox42 Server.

MailServerPassWord

optional

Specifies the password for the dox42 e-mail server.

SendErrorsToMail

optional

Specifies the standard e-mail address for error messages.

Certificate

optional

Specifies the certificate used for signing.

CertificatePassWord

optional

Specifies the certificate password.

CheckServiceHeader

optional

Indicates whether the service header is to be analysed or not:

  • true

  • false: no service header needs to be included.

UserPermissionODBCConnectionString

mandatory if CheckServiceHeader =true

Specifies the ODBC connection string to a database, which contains user permissions

CheckUserPermissionSQL

mandatory if CheckServiceHeader=true

The select statement, which is executed on the UserPermissionODBCConnectionString database.

Returns 1 or true: successfully authorised user.

Within the statement, the %username% and %password% tags will be replaced with the values, included in the header.

ThrowExceptionOnError

optional

Specifies how an error is returned:

  • true: The service returns an exception on error.

  • false (default):  An error will be returned as ResultMessage.

CustomErrorMessagesFile

optional

Specifies the path of a XML file containing custom error messages. Custom error messages allow for replacing error messages on the basis of a text search.

Check out the example.

HyphenationDictiorariesFile

optional

Specifies the path of a XML file containing hyphenation dictionaries.

Check out the example.

CheckTrustedTemplateLocations

optional

Specifies whether the check on trusted template locations should be performed:

  • true: The path/link of the template or data map must start with one of the paths/links listed in the section trustedTemplateLocations. If not, the call is cancelled.

  • false (default): No check is performed.

We strongly recommend to leave this check always switched on for security reasons!

If you switch off this check, everybody who is allowed to call your dox42 service can generate templates/data maps from any location including unknown URLs on your dox42 Server.

TempFolder

optional

Specifies the folder to be used by the dox42 Server to store temporary files. If not configured the Windows standard temp folder is used.

RESTInterfaceReturnsFullErrorInfoTempFolder

optional

If true more detailed error information is returned for the dox42 REST call.

RESTInterfaceReturnsHTTPError500

optional

If true the http status code 500 will be set on error for the dox42 REST call.

SOAPServiceReturnsFullErrorInfo

optional

If true more detailed error information is returned for the dox42 SOAP call.

SaveActionEnabled

optional

Specifies if the Output Action SaveAction can be used:

  • true: you can use the dox42 SaveAction to store generated documents on your server

  • false: you cannot use the dox42 SaveAction and an error will be returned.

RedirectURLEnabled

optional

Specifies if redirect URLs are enabled:

  • true: You can add the parameter &RedirectURL=https://www.<yourURL>.com to your calls to redirect to a certain URL after document generation.

  • false: The RedirectURL parameter will throw an exception, you will not be redirected

MailMethod

optional

Specifies a specific method to send your dox42 e-mails.

Possible values:

  • exchangeonline: You need to use this value, if you send e-mails via Microsoft Exchange Online.

  • aspose: uses Aspose to send mails

  • mailkit: uses MailKit to send e-mails

  • onmailkiterrortryaspose: uses MailKit to send mails, if MailKit method fails, uses Aspose to send mails

  • onasposeerrortrymailkit: When the Aspose Mail Method throws an error, the mailkit method is used to send dox42 e-mails.

LoadLocalFilesFromTrustedTemplateLocationOnly

optional

If true, you can only integrate files from trusted template locations in your data sources and dynamic fields.

AADLibrary (MSAL/ADAL)

optional

Specifies which Microsoft Authentication library is used.

  • MSAL (default)

  • ADAL

Example

<appSettings>

<add key="LicenseFilePath" value="c:\dox42\dox42WebService\License" />

<add key="LicenseKey" value="…"/>

<add key="MailServer" value="smtp.1und1.de"/>

<add key="dox42ServerMail" value="testserver@dox42.com"/>

<add key="MailServerPassWord" value="…"/>

<add key="SendErrorsToMail" value="monitoring@dox42.com"/>

<add key="MailServerPort" value="587"/>

<add key="MailMethod" value="onasposeerrortrymailkit"/>

<add key="Certificate" value="c:\dox42\dox42WebService\Certs\Certificate.pfx"/>

<add key="CertificatePassWord" value="…"/>

<add key="CheckServiceHeader" value="true"/>

<add key="UserPermissionODBCConnectionString"

value="Driver={SQL Server Native Client 10.0};Server=…;Database=…;Uid=…;Pwd=…;"/>

<add key="CheckUserPermissionSQL"

value="SELECT COUNT(*) FROM Users where Username =

'%username%' and Password = '%password%'" />

<add key="ThrowExceptionOnError" value="false"/>

<add key="CustomErrorMessagesFile" value="C:\dox42Server\CustomErrors.xml"/>

<add key="CheckTrustedTemplateLocations" value="true"/>

<add key="TempFolder" value="C:\dox42Server\WorkingDir"/>

<add key="RESTInterfaceReturnsFullErrorInfo" value="false"/>

<add key="RESTInterfaceReturnsHTTPError500" value="false" />

<add key="SOAPServiceReturnsFullErrorInfo" value="false" />

<add key="SaveActionEnabled" value="true" />

<add key="RedirectURLEnabled" value="true" />

<add key="LoadLocalFilesFromTrustedTemplateLocationOnly" value="false" />

</appSettings>