DocuVieware Reference Guide
SetupConfiguration(Boolean,DocuViewareSessionStateMode,String,String,String) Method

GdPicture14.WEB Namespace > DocuViewareManager Class > SetupConfiguration Method : SetupConfiguration(Boolean,DocuViewareSessionStateMode,String,String,String) Method
Specifies if DocuVieware is hosted in a single server or in a Server Farm with sticky sessions (also known as session affinity).
To maximize performances, it is highly recommended to keep this property to true in the context of single server or Server Farm with sticky sessions hosting. (Default value is true)
Specifies the path of the cache folder, if any.
If available, the cache folder will be used to store large data blob.
It is highly recommended to setup such folder otherwise all data will be cached into the server memory.
The cache system has been designed to keep the memory footprint as low as possible.
No action is required from your side, the recycling and garbage collector mechanisms are already implemented and automatically at work when necessary.
Default value is null (no file caching).
Specifies the web application URI.
Specifies the route of the DocuVieware controler if you have implemented the controller from your web application IE: api/docuvieware3. This is required for .NET Core web applications. Using an empty string will leave DocuVieware to create the route.
Setup the configuration required by DocuVieware.
Syntax
'Declaration
 
Public Overloads Shared Sub SetupConfiguration( _
   ByVal StickySession As Boolean, _
   ByVal SessionStateMode As DocuViewareSessionStateMode, _
   ByVal CacheFolder As String, _
   ByVal ApplicationURI As String, _
   ByVal ControllerRoute As String _
) 

Parameters

StickySession
Specifies if DocuVieware is hosted in a single server or in a Server Farm with sticky sessions (also known as session affinity).
To maximize performances, it is highly recommended to keep this property to true in the context of single server or Server Farm with sticky sessions hosting. (Default value is true)
SessionStateMode
CacheFolder
Specifies the path of the cache folder, if any.
If available, the cache folder will be used to store large data blob.
It is highly recommended to setup such folder otherwise all data will be cached into the server memory.
The cache system has been designed to keep the memory footprint as low as possible.
No action is required from your side, the recycling and garbage collector mechanisms are already implemented and automatically at work when necessary.
Default value is null (no file caching).
ApplicationURI
Specifies the web application URI.
ControllerRoute
Specifies the route of the DocuVieware controler if you have implemented the controller from your web application IE: api/docuvieware3. This is required for .NET Core web applications. Using an empty string will leave DocuVieware to create the route.
Remarks
If sticky sessions mode is disabled, a cache folder that is reachable from all the servers in the farm must be provided.
See Also

Reference

DocuViewareManager Class
DocuViewareManager Members
Overload List