Reference Guide
GdPicture14.WEB Namespace / DocuViewareManager Class / SetupConfiguration Method / SetupConfiguration(Boolean,DocuViewareSessionStateMode,String,String,String) Method
Specifies if DocuVieware is hosted into an environment with sticky session (also known as session affinity).
Use true if DocuVieware is hosted into a single server or into a load balanced environment using session affinity. Use false otherwise (server farm with no 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)
A member of the DocuViewareSessionStateMode enumeration specifying how DocuVieware stores session data.
DocuViewareSessionStateMode.File must be used if DocuVieware is hosted into a farm with no session affinity.
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.

In This Topic
    SetupConfiguration(Boolean,DocuViewareSessionStateMode,String,String,String) Method
    In This Topic
    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 _
    ) 
    public static void SetupConfiguration( 
       bool StickySession,
       DocuViewareSessionStateMode SessionStateMode,
       string CacheFolder,
       string ApplicationURI,
       string ControllerRoute
    )

    Parameters

    StickySession
    Specifies if DocuVieware is hosted into an environment with sticky session (also known as session affinity).
    Use true if DocuVieware is hosted into a single server or into a load balanced environment using session affinity. Use false otherwise (server farm with no 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
    A member of the DocuViewareSessionStateMode enumeration specifying how DocuVieware stores session data.
    DocuViewareSessionStateMode.File must be used if DocuVieware is hosted into a farm with no session affinity.
    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