The following parameters can be configured for the dox42 Server within the <appSettings> element of the web.config file.
Parameters
Parameter | Requirement | Description |
---|---|---|
| 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. |
| mandatory | Specifies the license key of the dox42 Server. |
| optional | Specifies the e-mail server for sending emails. |
| optional | Specifies the e-mail server port. |
| optional | Specifies the sender’s default address of the dox42 Server. |
| optional | Specifies the password for the dox42 e-mail server. |
| optional | Specifies the standard e-mail address for error messages. |
| optional | Specifies the certificate used for signing. |
| optional | Specifies the certificate password. |
| optional | Indicates whether the service header is to be analysed or not:
|
| mandatory if CheckServiceHeader =true | Specifies the ODBC connection string to a database, which contains user permissions |
| 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. |
| optional | Specifies how an error is returned:
|
| 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. |
| optional | Specifies the path of a XML file containing hyphenation dictionaries. Check out the example. |
| optional | Specifies whether the check on trusted template locations should be 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. |
| 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. |
| optional | If true more detailed error information is returned for the dox42 REST call. |
| optional | If true the http status code 500 will be set on error for the dox42 REST call. |
| optional | If true more detailed error information is returned for the dox42 SOAP call. |
| optional | Specifies if the Output Action SaveAction can be used:
|
| optional | Specifies if redirect URLs are enabled:
|
| optional | Specifies a specific method to send your dox42 e-mails. Possible values:
|
| optional | If true, you can only integrate files from trusted template locations in your data sources and dynamic fields. |
| optional | Specifies which Microsoft Authentication library is used.
|
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>