Install DocuWare on-premises 7.11

To install DocuWare as an on-premise system, you need the DocuWare software package in the form of the ZIP file and your license file, which you have received by email from DocuWare.

During installation, you have to select at least one of three roles for the server machine on which you are installing it. The role determines the tasks that the server machine should perform in the DocuWare system.

  • Frontend role: Providing services for clients and users, includes Web Client, Platform Services, and DocuWare Configuration.

  • Backend role: Providing services for background processing, e.g. workflows, processes, and email capture.

  • Full text role: Providing services for full-text processing.

You also have to select a setup mode:

  • New installation: to install a completely new DocuWare system with a new database.

  • Extension: to install additional server machines for an existing DocuWare system with an existing database. For example:
    - to extend the existing system to another machine.
    - to restore the system after a machine failure (if there is a database)
    - to update DocuWare while moving to a new server

  • Update: to update or reinstall the DocuWare components on the current server machine and to add one of the above roles to an existing server machine

  • Uninstall: to uninstall all DocuWare services and applications from the current server machine

Installation comprises several steps. Every step can be repeated if it fails. The setup is logged in detail. The corresponding log files can be found in the directory <%AllUsersProfile%\DocuWare\SetupLogs>.

DocuWare services run under Windows Users. To be able to specify the Windows User(s) as part of the DocuWare setup, you should first create them.

Information about individual setup options can be obtained directly from within the dialog via the info icons.

Information on DocuWare version 7.11

You can find a complete list of all the new features of DocuWare version 7.11 in the DocuWare Knowledge Center under What's new in DocuWare version 7.11.

Before upgrading to version 7.11, please check the extent to which the changes with DocuWare version 7.11 are relevant to your system.

For the update to DocuWare version 7.11 you need at least DocuWare version 7. If you do not have it, please follow this update path:
Versions 6.6 - 6.11 > Update to 6.12 > Update to 7.1 > Update to 7.4 > Update to 7.9 > Update to 7.11

Please also check the system requirements.

To implement the update, please contact your authorized DocuWare partner. This is especially recommended if you are not updating directly from the previous version.

Check your DocuWare Platform configurations

Most of the configurations of the DocuWare Platform are moved from the file Web.config to the DocuWare.Platform.Web.dll.config

Check if your configuration files need to be adpated.

See also the Technical Release Notes 7.11 for more information


Documentation of the Platform configuration files

Default platform appsettings.json

Base Structure

The default platform appsettings.json looks like:

{
    "Logging": {
        "LogLevel": {
            "Default": "Information",
            "Microsoft.AspNetCore": "Warning"
        }
    },
    "AllowedHosts": "*",
    "MachineKey": {
        "ValidationAlgorithm": "HMACSHA512",
        "DecryptionAlgorithm": "AES",
        "ValidationKey": "F65ED98115E72931EAAF578AA0281954D53D41A9CC7CAB99566B6115FF2AB65EBDB80AAD72DFB65B50AC8A495DD82E0867FAAA0CB7EDE6B06C4619A799B22C1BFE3C2D668641D8E71B46E145A26BF97FF1F6DCFD47541C7A3F155EC6ADB361881354E98E1434C5DDC55E54C7154F8E9FF9B376312FE1D527941F44BF3F607735",
        "DecryptionKey": "E024261FE12C32D070C7521AF4952A50436F04DB76EE83189F81899E22EB2378"
    },
    "ThumbnailsConfig": {
        "DefaultThumbnailSize": "80x80"
    },
    "CacheProfiles": {
        "Default": {
            "Duration": 0,
            "Location": "Client",
            "VaryByHeader": "Cookie,Accept,Accept-Encoding"
        },
        "DefaultRendering": {
            "Duration": 1,
            "Location": "Client",
            "VaryByHeader": "Cookie,Accept,Accept-Encoding",
            "VaryByQueryKeys": [ "*" ]
        },
        "Aggressive": {
            "Duration": 8640000,
            "Location": "Client",
            "VaryByHeader": "Cookie,Accept,Accept-Encoding",
            "VaryByQueryKeys": [ "*" ]
        }
    },
    "LongRunningConfig": {
        "InitialRequestReleaseTime": 12,
        "CheckRequestReleaseTime": 12,
        "EraseThresholdTime": 6
    },
    "HealthCheckConfig": {
        "Enabled": false,
        "Organization": null,
        "User": null,
        "FileCabinetId": null,
        "DialogId": null,
        "Interval": 60000,
        "TooMuchLoadPeriod": 90000,
        "IncludesSettings": false,
        "FakeBroken": false
    },
    "SharedResourcesConfig": {
        "UseAiTracking": false,
        "Resources": [
            {
                "Name": "shared",
                "ResourcesBaseUrl": "/DocuWare/Resources",
                "ResourcesFolder": "Shared",
                "MapFilePath": "..\\Resources\\Shared\\resources.json"
            },
            {
                "Name": "web-client",
                "ResourcesBaseUrl": "/DocuWare/Resources",
                "ResourcesFolder": "WebClientCore",
                "MapFilePath": "..\\Resources\\WebClientCore\\resources.json"
            }
        ]
    },
    "WebClientSettings": {
        "ShowWindowsLogin": true,
        "UseNTLMForIntegrations": false,
        "UseNotificationsForIntegrations": true,
        "PTPAddress": "http://go.docuware.com/PTP?lang={0}",
        "DocuWareTraining": "https://go.docuware.com/academy?lang={0}",
        "DocuWareSubscribe": "http://go.docuware.com/client-register-news?org={0}",
        "DocuWareHelp": "http://go.docuware.com/usersupport?lang={0}",
        "DocuWareProductBlog": "https://go.docuware.com/blog-product-news?lang={0}",
        "EnableHelpDeskChat": true,
        "DefaultParallelCallsCount": 5,
        "TransferParallelCallsCount": 5,
        "SelectListsMaxCount": 100,
        "SelectListsTimeout": 400,
        "HelpDeskAddressEnglish": "http://www.docuware.com/forum",
        "HelpDeskAddressGerman": "http://www.docuware.com/de/forum",
        "UserVoiceAddressEnglish": "https://www.docuware.com/feedback/en/client/",
        "UserVoiceAddressGerman": "https://www.docuware.com/feedback/de/client/",
        "PlatformTimeout": 60,
        "ImageEnhancement": true,
        "ViewerDialogZoomMode": 2,
        "DocumentOverviewToolbarSectionBlock": 10,
        "TaskListCountLimit": -1,
        "LocalStorage": true,
        "UseHostIpAddress": false,
        "EnableTutorial": false,
        "WorkflowCalculateServerClientTimeOffset": false,
        "FormsBaseAddress": "http://localhost",
        "SurveyMonkeyEnabled": true,
        "DocumentsIndexingMaxCount": 10000,
        "UserlanePropertyID": false,
        "TrottleWorkflowEvents": true,
        "UXSurveyURL": "https://go.docuware.com/WebClientSurvey-UXRating",
        "TutorialAddress": "https://www.docuware.com/onlinetraining/webclient_tutorial/",
        "ToastrErrTrackingEnabled": true,
        "MicrosoftTeamsDomainTemplate": "https://teams.microsoft.com/share?href={0}&amp;msgText={1}&amp;referrer={2}",
        "TrashBinBatchOperationSize": 50,
        "JavaScriptInjection": ""
    },
    "MessageBus": {
        "MessageBusType": "DocuWare.MessageBus.MSMQ.Provider.HyperBus, DocuWare.MessageBus.MSMQ.Provider",
        "MessageBusConfigurationType": "DocuWare.MessageBus.MSMQ.Provider.HyperBusConfiguration, DocuWare.MessageBus.MSMQ.Provider",
        "MulticastIp": "234.1.1.2",
        "TransportFlags": "Default",
        "MaximumNumberOfThreads": 20,
        "QueuePrefix": ".\\private$\\"
    },
    "SecuritySettings": {
      "ContentSecurityPolicy": "frame-ancestors 'self'",
      "Cors": {
        "Enabled": false,
        "AllowedOrigins": ""
      }
    },
    "ApplicationInsights": {
        "ConnectionString": ""
    },
    "ChunkUploaderConfig": {
    "UseSystemStorage": false,
    "ExpirationTimeInMinutes": 10
  },
  "ServiceUriConfig": {
    "WorkflowServiceUri": "",
    "FormsServiceUri": "/DocuWare/Forms"
  },
  "PermanentLinkConfig": {
    "Duration": "48:00:00"
  },
  "SearchServiceConfig": {
    "Enabled": false
  },
  "RequestDelayConfig": {
    "UnauthorizedDelay": null,
    "ObsoleteDelay": null
  },
  "ErrorHandlingConfig": {
    "LogExceptions": true
  },
  "AuditConfig": {
    "AuditHttpClientTimeout": "00:00:05"
  },
  "DependencyContainerConfiguration": {},
  "SelectListsClientFeatureToggle": true,
  "SelectListsServiceAddress": "",
  "IsReadOnlyMode": false
}

ThumbnailConfig

  • DefaultThumbnailSize: Specifies the default dimensions for thumbnails.

LongRunningConfig

  • InitialRequestReleaseTime: Specifies the time in seconds that the initial request to be release if an operation continues longer.

  • CheckRequestReleaseTime: Specifies the time in seconds that the check request to be release if an operation continues longer.

  • EraseThresholdTime: Specifies the time in minutes after which the not deleted task can be erased.

HealthCheckConfig

  • Enabled: Whether health check is enabled on /DocuWare/Platform/HealthCheck

  • Organization: Specifies the id of the organization that will be used for the health check.

  • User: Specifies the id of the user that will be used for the health check.

  • FileCabinetId: Specifies the id of the file cabinet that will be used for the health check.

  • DialogId: Specifies the id of the dialog that will be used for the health check.

  • Interval: Specifies the time in milliseconds which will be the interval between each health check.

  • TooMuchLoadPeriod: Specifies the time in milliseconds which will be limit which indicates that the load is too much.

  • IncludesSettings: Specifies whether to check Settings Service in the health check.

SharedResourcesConfig

  • UseAiTracking: Whether Application Insights tracking is enabled. Important note: ApplicationInsights:ConnectionString should be configured.

WebClient settings

  • ShowWindowsLogin: Whether to show windows login option in the drop down of the login page. Should be set to False for online installation.

  • UseNTLMForIntegrations: Specifies whether WebClient should generate integration links with ntlm e.g. which should try windows login

  • UseNotificationsForIntegrations: Specifies whether to enable for push notifications for StoreView, Result,Task lists and Baskets. set this to false if there are problems with Outlook where the browser connections are very limited.

  • SelectListsTimeout: How client request for a select list should wait.

  • EnableHelpDeskChat: Specifies whether to have menu option to the help desk web site e.g. "Document Management Software & Workflow Solutions | DocuWare "

  • DefaultParallelCallsCount: Specifies how many parallel request can be executed for operations, except transfer, which are made on several documents e.g. delete, check out, undo check out, repeat intelix, update indexes of several documents

  • TransferParallelCallsCount: Specifies how many parallel request can be executed for transfer operations e.g. move, copy of documents and reassign and confirm workflow tasks

  • SelectListsMaxCount: Specifies how many results to get for select lists.

  • ImageEnhancement: Default value for viewer if to make image enhancement by default when user opens a document.

  • LocalStorage: Specifies  where to store user settings for his layout, such as result list sort, column order viewer options which are enabled etc.

  • UseHostIpAddress: Specifies whether to use host machine IP address when a QR code is generated for the mobile apps, I guess this was needed for demonstration purposes for the PO (Mirco).

  • EnableTutorial: Used to disable the tutorial.

  • ToastrErrTrackingEnabled: Enables events to AppInsights for every toast error shown in the Web Client

  • DocumentsIndexingMaxCount: Maximum number of documents which are allowed for changing of indexes of multiple documents or a result list

  • TaskListCountLimit: Specifies whether Task lists should update counts in the Task area menu. 0 - disables count, -1 - real number of documents (no limit), > 0 - gets no more than this number and sets + if the result is equal to the requested count.

  • JavaScriptInjection

ApplicationInsights

  • ConnectionString: Specifies the connection string that will be used for connecting to an Application Insights. If left empty, Application Insights logging will be disabled.

SecuritySettings

  • ContentSecurityPolicy: Specifies the value of the Content-Security-Policy which will be returned with every request. The default value is ‘frame-ancestors 'self'' which is equivalent to X-Frame-Options to be ' SAMEORIGIN’. For more information on how to set the Content-Security-Policy to satisfy the customer needs, see Content-Security-Policy - HTTP | MDN.

  • Cors:

    • Enabled: Specifies whether Cors will be supported. This includes support for preflight requests and response headers.

    • AllowedOrigins: Specifies which origins will be allowed to make CORS requests. Possible values are:

      • * - Will allow all origins.

      • List of origins separated by ,. For example - http://yourorigin, http://myorigin

ChunkUploaderConfig

  • UseSystemStorage: Specifies whether system storage is used for storing chunks of data.

  • ExpirationTimeInMinutes: Specifies the chunk expiration time in minutes.

ServiceUriConfig

  • WorkflowServiceUri: URI for accessing the workflow service.

  • FormsServiceUri: URI for accessing the forms service.

PermanentLinkConfig

  • Duration: Specifies the duration for which permanent links remain valid.

SearchServiceConfig

  • Enabled: Specifies whether to make requests for search to the Search Service.

RequestDelayConfig

  • UnauthorizedDelay: The default value is null which means no delay. The value is in milliseconds. Can be used to decrease the possible amount of spamming unauthorized requests to the Platform service.

  • ObsoleteDelay: The default value is null which means no delay. The value is in milliseconds. Can be used to decrease the possible amount of spamming obsolete requests to the Platform service.

ErrorHandlingConfig

  • LogException: Specifies whether exceptions should be logged

AuditConfig

  • AuditHttpClientTimeout: Timeout duration for HTTP client used in auditing operations.

Other configurations

  • SelectListsServiceAddress: Address for the select lists service.

  • SelectListsClientFeatureToggle: Specify whether to use the select lists service

    • IsReadOnlyMode

    • DependencyContainerConfiguration

Platform app.config

The app.config in the deployed Platform should be called DocuWare.Platform.Web.dll.config.

Base Structure - the default platform app.config looks like:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
	<configSections>
		<section name="ClientConfig" type="DocuWare.Platform.Model.Implementation.Config.ClientConfigHandler, DocuWare.Platform.Model.Implementation" />
		<section name="cachingConfiguration" type="DocuWare.Cache.CacheManagerSettings, DocuWare.Cache" />
		<section name="ImagingToolkitSettings" type="DocuWare.Imaging.Toolkit.SettingSectionHandler, DocuWare.Imaging.Toolkit" />
		<section name="wafServiceSettings" type="DocuWare.WAFServices.Configuration.WAFServiceSectionHandler, DocuWare.WAFServices" />
	</configSections>
	<ClientConfig SettingsStorage="bin\DocuWare.Platform.Web.dll.settings">
		<PlatformSettings TileSize="1024" UserTokenLifetime="1440" MultipleFcSearchLimit="1000">
			<CacheExpiration Session="00:10:00" />
			<RetryOperation Atempts="3" InitialPeriod="00:00:00.1000000" AtemptStep="00:00:00.2500000" />
		</PlatformSettings>
	</ClientConfig>
	<cachingConfiguration defaultCacheManager="InMemoryPersistence">
		<cacheManagers>
			<add name="InMemoryPersistence" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="01:00:00" />
			</add>
			<add name="HeadersCache" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="FullObjectsCache" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="DataProvidersCache" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:05:00" />
			</add>
			<add name="FileCabinetTable" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="PartialFileCabinetTable" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="ClientContextManager" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:05:00" />
			</add>
			<add name="OrganizationDatasources" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:05:00" />
			</add>
			<add name="SessionCache" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="OrganizationSettings" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="AbsoluteTime" expirationTime="00:00:30" />
			</add>
			<add name="ContainerCache" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="OrganizationReference" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="SettingsServerCache" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:10:00" />
			</add>
			<add name="SettingsServiceFacades" type="DocuWare.Cache.DotNetCacheManager, DocuWare.Cache">
				<Expiration expirationType="Sliding" expirationTime="00:30:00" />
			</add>
		</cacheManagers>
	</cachingConfiguration>
	<ImagingToolkitSettings disableEMFAnnotations="true" protocolType="BasicHttp" httpPort="9042" imagingPath="" processPoolType="Smart" processPoolSize="Medium" workerPriority="Normal" workerDurability="Medium" workerIdleTimeout="01:00:00">
		<ImagingServerSettings>
			<!-- Here Imaging Server core settings can be overridden -->
		</ImagingServerSettings>
	</ImagingToolkitSettings>
	<wafServiceSettings useCacheForDataProviders="true" selectListBlockSize="100" defaultWafSettingsFile="bin\DefaultWAFSettings.settings">
		<!--<CacheToProviderMap>
      <System.String DictionaryEntryKey="ServersDataProvider">FullObjectsCache</System.String>
    </CacheToProviderMap>-->
	</wafServiceSettings>
	<appSettings>
		<!-- Sets the size of the maximum length of the serialized JSON string. 
    The maximum length of JSON strings. The default is 2097152 characters, which is equivalent to 4 MB of Unicode string data. -->
		<!-- https://docs.microsoft.com/en-us/dotnet/api/system.web.script.serialization.javascriptserializer.maxjsonlength?view=netframework-4.7.2 -->
		<!-- The value below is 4194304 characters, which is equivalent to 8 MB of Unicode string data. -->
		<!-- <add key="MaxJsonLength" value="4194304" /> -->
		<!-- This key enables the adhoc rendering feature which is needed to configure DocuWare import. -->
		<add key="AdhocRenderingEnabled" value="true" />
		<!-- Imaging Toolkit Service address. Comment the bottom line to use the old adhoc implementation -->
		<!--<add key="ToolkitServiceAddress" value="http://localhost:57287/imaging/api" />
		<add key="ToolkitServiceDirectSectionAccess" value="false" />-->
		<!-- This key determines the storage implementation used by DocuWare Desktop. -->
		<add key="DesktopStorageImplementation" value="StoreViaPlatformClient" />
		<!--    
    <add key="PrivateMachineConfigFilePath" value="C:\ProgramData\DocuWare\ServerConfig\dwmachine-chw-dw-06.config"/>
-->
		<!-- Configure session to logout automatically when client is idle for specified in 
      bin\DocuWare.Platform.Web.dll.settings->PlatformSettings->CacheExpiration->Session period of time -->
		<add key="SignOutIdleSession" value="false" />
		<add key="ShowAllProductLicenses" value="false" />
		<add key="enableSimpleMembership" value="false" />
		<add key="ClientValidationEnabled" value="false" />
		<add key="UnobtrusiveJavaScriptEnabled" value="true" />
		<!--Workflow Engine Settings-->
		<!--Accepted values: Legacy, DwMessaging.   Defaults to DwMessaging-->
		<add key="SmtpProvider" value="DwMessaging" />
		<!--Option controlling if we try to group requests to Local data connector -->
		<add key="GroupLocalDataConnectorRequests" value="true" />
		<!--Allow Platform to work with WebDesigner tables-->
		<add key="AllowWebDesigner" value="true" />
		<!-- Enable this setting if you want your workflow instances to have a maximum limit of events. -->
		<add key="MaxEventsThreshold" value="10000" />
		<!-- Enable this setting if you your tables from Workflow database are together with FileCabinet ones. -->
		<add key="WorkflowTablesInSameDatabase" value="false" />
		<!-- Enable this setting if you want your event waiting instances to be cached. -->
		<add key="CacheEventWaitingInstances" value="false" />
		<!-- Add the base address if you want to use the definition service. -->
		<add key="DefinitionServiceBaseAddress" value="" />
		<!-- Enable this setting if you use MSSQL and it is configured to use correct certificate(Option add "Encrypt={value} to workflow connection string"). -->
		<!--<add key="WorkflowEncryptSqlConnection" value="false" />-->
		<!--End of Workflow Engine Settings-->
		<!-- Here you can configure how we create and cache bundles. -->
		<!-- 
      You should disable the bundle cache only in case the Platform application is not allowed to write into its temporary folder. 
      It is typically safe to enable this. It should be disabled only for diagnostic purposes.
    -->
		<add key="UseBundleCache" value="true" />
		<!-- 
      Enable this when you want to have external JavaScript libraries like jQuery to be downloaded as separate files from
      either a CDN or from the Platform application host. You should enable this always.
      
      In case you want to use a real CDN you can customize the CDN access using the "cdnMappings" section.    
    -->
		<add key="UseBundleCDN" value="true" />

		<!-- 
      Use StaticResourcesExternalUrl when you want to specify a CDN url.
      It must include the protocol ("http//", "https//" or just "//") and additional path if any e.g. //cdn.docuware.com/v12345
    -->
		<add key="StaticResourcesExternalUrl" value="" />

		<!-- 
      StaticResourcesBasePath is the virtual path in the IIS where the "Web.Resources" folder is mapped.
      It is used when resolving the real path of the resources.json file.
      When it is empty or not specified his value is "/DocuWare/Resources"
    -->
		<add key="StaticResourcesBasePath" value="" />

		<!-- 
      This flag lets your Platform application host be the host for fat JavaScript libraries. You should enable this flag only if your clients
      do not have access to the Internet.
  
      For better performance you should set the value to "false".
      
      If the flag is set to "false", the fat JavaScript libraries are downloaded from a CDN. 
      Such CDNs can deliver the fat files better than your host,
      your web server is offloaded and your bandwidth is saved. This typically reduces your
      transfer cost and decreases the initial WebClient load.
      
      In case you want to use a real CDN you can customize the CDN access using the "cdnMappings" section.
    -->
		<add key="UseLocalCDN" value="false" />
		<!-- This allows you to specify whether you allow CORS (http://en.wikipedia.org/wiki/Cross-origin_resource_sharing). 
    This is needed when you want to embed Platform / WebClient views
    into web pages from other domains. By default, CORS is disabled. 
    
    At the moment you can spcify either an empty string or *. The empty string disables CORS for all domains while * enables CORS for all domains.
    -->
		<!-- Overrides the default error page transformation -->
		<!--<add key="ErrorPageXslt" value=""/>-->
		<!-- Set the number of messages of Platform's in-memory log.
    You should not change this value unless you have really a need for displaying many messages
    or your machine runs out of memory.
    
    If the specified number of messages is reached older messages are thrown away.
    -->
		<add key="MaxNumberOfLoggedMessages" value="3000" />
		<!-- Set the length of exception texts in the Platform's in-memory log. 
    If you set the value to 0, then the exception text is never logged.
    The exception message is always logged, independently from the size of this value.
    
    In case of diagnostic sessions you can increase this value. It should not exceed a value of 5000.
    -->
		<add key="ExceptionStackTraceLength" value="1500" />
		<!-- Choose who is allowed to display the Platform log. The following values are valid:
    Any: Anybody can inspect the log. Use this in case you get errors even before being logged on.
    Users: A system administrator should see all entries; An organization administrator should see all entries for the organization; A user should see only those messages which were created within the context of this user.
    None: The log cannot be inspected by anybody.
    -->
		<add key="LogViewEnabledRoles" value="Any" />
		<!-- Choose which items are logged into the Platform's memory log, which you can inspect with the web browser:
    Debug: All messsages, including debug messages, are logged. This can grow the log and should be enabled for diagnostic purposes only.
    Info: All messages except debug messages are logged. This is recommended for production environments and provides good balance between the number of log entries and an overview.
    Warning: All messages which describe an unexpected or strange behaviour are logged.
    Error: All errors and critical problems are logged.
    Critical: All critical errors are logged. Critical errors indicate heavy errors which might the system prevent from working.
    -->
		<add key="LogLevel" value="Debug" />
		<!-- Define if Platform instance is in Read Only mode. In this mode any application login using ReadOnly license and has only read permissions (restricted write, update and delete permissions).
    <add key="ReadOnlyMode" value="False"/>
    -->
		<!-- Enable this setting if you want to use Application Insights to track the performance of the WebClient. To make the tracking work, you must also place the ApplicationInsights.config file
    in the Platform's application directory. The easies way to install this file is to use the Application Insights status monitor tool. Then you can also instrument the
    web application. Details at https://azure.microsoft.com/documentation/articles/app-insights-monitor-performance-live-website-now/. 
    -->
		<add key="UseAITracking" value="false" />
		<!-- Specify an URL which is loaded when the WebClient is opened. You can use this to add specific behaviour to the WebClient. -->
		<!--
    <add key="JavaScriptInjection" value="/docuware/platform/static/foo.min.js"/>
    <add key="JavaScriptInjection" value="https://my.domain.com/assets/foo.min.js"/>
    -->
		<!-- A different logger can be used to push log messages directly to Application Insights or any other logging service of your choice -->
		<!--
    <add key="LoggerFactory" value="DocuWare.ApplicationInsights.Logging.ApplicationInsightsUserAwareLoggerFactory,DocuWare.ApplicationInsights.Logging"/>
    -->
		<!-- To enable the test controller for analytics purposes, you can set the value to true. Due to security reasons it recommended to keep the test controller disabled. -->
		<add key="EnableTestController" value="true" />

		<!-- Expiration time for chunk folders in case of using temp folder.If not set the default value is 10 minutes.-->
		<!--<add key="ChunkExpirationTimeInMinutes" value="10"/>-->

		<!--<add key="SkipLockParallelTask" value="false"/>-->

		<!-- Enable this setting if you want your workflow instances to have a maximum limit of events. -->
		<!--<add key="MaxEventsThreshold" value="200" />-->

		<!-- Enable this settings to export csv files shitf-jis encoded -->
		<!--<add key="EncodeToJapanese" value="true"/>-->

		<add key="MaximumNestingParserLevel" value="1000" />
		<add key="UseBufferedLog" value="true" />
		<add key="ShowPII" value="false" />

		<add key="EnableExpiredLicenseTokensCleaner" value="true"/>
		<add key="LicenseTokensCleanupRowsPerLoop" value="20"/>
		<add key="ShouldUsePredefinedHostId" value="false"/>
		<add key="ShouldVerifyAssignedNamedLicense" value="true"/>
		<!-- Runs every 10 minutes -->
		<add key="LicenseTokensCleanupCronExpression" value="0 0/10 * 1/1 * ? *"/>
		<!--SLS Integration-->
		<add key="SelectListsClientFeatureToggle" value="true"/>
		<!--<add key="SelectListsServiceAddress" value="http://localhost:5136"/>-->

	</appSettings>
</configuration>

Platform settings

By default Platform settings are embedded app.config, but also point to DocuWare.Platform.Web.dll.settings, which is deployed with the setup.

Security options of Platform

There are following options in app.config that can be used to increase security in platform:

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

For diagnostic/support purposes can be set to true so exceptions will contain also stacktrace.

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

Retry policy

There is a retry mechanism for SQL transient errors.

In Platform settings there are few properties which can be changed.

See RetryOperation tag in PlatformSettings section in app.config

The implementation is made with story 137186

The transient error codes are described this in Microsoft article

Some of the error codes are used in sql on premise too.

Property name

Type

Default Value

Min Value

Description

Atempts

int

3

0

A value indicating how many times the retry mechanism to try the operation again.

InitialPeriod

Timespan

00:00:00.1000000

00:00:00

Time initial period which has to be postponed before the first retry.

AtemptStep

Timespan

00:00:00.1500000

00:00:00

Defines the time between two retry operations.

Windows User for DocuWare Server

DocuWare servers must be able to log in to the Windows system. For this, they require a Windows User with local administrator rights. During setup, you must specify a corresponding Windows User; either choose an existing one or create a new one. We recommend using a special Windows User exclusively for DocuWare services.

Ports used

DocuWare uses the following ports by default:

  • Authentication Server: 9000

  • Workflow Server: 9002

  • Notification Server: 9005

  • Full-text server: 9012

If no other programs on the server machines used communicate via the preselected ports, no change is necessary.

Upgrade Simulation

DocuWare setup offers an upgrade simulation for the system database (DWSYSTEM):

It is checked whether the database of your existing DocuWare system can be updated. The productive DocuWare system will not be changed.

We recommend running the simulation to avoid problems during setup and system downtime. If the simulation is successful, you may go with the system upgrade. If errors are thrown, you should cancel the setup and contact your DocuWare sales partner or DocuWare Support.

Notes:

  • Discontinuation of Oracle as a supported database: With DocuWare 7.10 Oracle as a database is not supprted anymore. If the DocuWare Server Setup detects an Oracle database server, the update is aborted with an error message. DocuWare will offer a migration from an Oracle to a Microsoft SQL Server database.

  • If you are using a MySQL database server and run the update by remote, none of the upgrade simulation options are available.

  • Wildcards in IIS configuration not supported: Internet Information Server 10 (IIS 10) allows the use of wildcards in the host name binding of the website configuration. Such wildcards are not supported by DocuWare. To ensure that wildcards are not used, the DocuWare Server Setup prevents the user from selecting the websites configured with wildcards during any installation and displays an error message.

  • As of DocuWare Version 7.8, Dell EMC Centera and Dell EMC ECS systems are no longer supported as storage media. If such a storage location is found during an upgrade, the setup is aborted and a corresponding error message is displayed. A simulation can be run despite the error message.

Customer Experience Improvement Program

Using the Customer Experience Improvement Program (CEIP), DocuWare would like to gain more information about use of DocuWare software for further improving user-friendliness and customer experience, from which you can then also benefit.

When setting up/upgrading, the "Customer Experience Improvement" component is installed. This creates an additional database table called DWAnalytics in the database used for your DocuWare system in which the statistical information is stored. You can also see the information in the database table using the normal database tools.
Even if you do not take part in CEIP, the "Customer Experience Improvement" component is installed, the database created, and the corresponding information written there. However, the data are then not transferred to DocuWare.

More information about CEIP, e.g. what kind of data is collected?