Jump to: navigation, search

Difference between revisions of "View Cache"

(→‎GetViewStateDetails)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{{ReleaseStatus/Beta}}
+
The View Cache feature increases the performance of the [[web Service]] by caching the data to be published and sent to the clients. All content data as well as the hierarchies, as defined by the [[View]] and in the [[ACM]], is evaluated and cached internally. Be aware, that this data does not encompass the physical documents linked to the objects, hence the documents have to be loaded if requested from the client.
−
The View Cache feature increases the performance of the [[web Service]] by caching the data to be published and sent to the clients. All content data as well as the hierarchies, as defined by the [[View]] and in the [[ACM]], is evaluated and cached internally. Be aware, that this data does not encompass the physical documents linked to the objects, hence the documents have to be loaded if the requested from the client.
+
  
 
A client's request for hierarchical data, covering '''two or more hierarchy''' levels, will be handled using the cached data. Any request covering only one hierarchy level will by-pass the view cache and be treated directly. For example, browsing through the objects using the [[Content Browser]] does not use the View Cache, whereas preparing the [[HowTo:Switch_to_Offline_Mode|Offline Mode]] utilizes the cache to improve performance.
 
A client's request for hierarchical data, covering '''two or more hierarchy''' levels, will be handled using the cached data. Any request covering only one hierarchy level will by-pass the view cache and be treated directly. For example, browsing through the objects using the [[Content Browser]] does not use the View Cache, whereas preparing the [[HowTo:Switch_to_Offline_Mode|Offline Mode]] utilizes the cache to improve performance.
  
 
Once the cache has been initialized, its status and additional information can be retrieved by [[#Web Service Interface|web service methods]].
 
Once the cache has been initialized, its status and additional information can be retrieved by [[#Web Service Interface|web service methods]].
−
{{Attention|Up to now the View Cache needs to be initialized and updated manually after every (re)start of the web service, due to a missing automatism!}}
+
{{Attention|Up to now the View Cache needs to be initialized and updated manually after every (re)start of the web service. This can be done manually or by using an automatism!}}
  
 
== Using the View Cache ==
 
== Using the View Cache ==
 
=== Initialization / Update of View Cache ===
 
=== Initialization / Update of View Cache ===
−
The cache needs to be initialized after a web service has been (re)started by calling the method [[#TriggerViewStateUpdate]].
+
The cache needs to be initialized after a web service has been (re)started by calling the method [[#TriggerViewStateUpdate|TriggerViewStateUpdate]].
 +
If a client commits data via a web service having the View Cache enabled, the cached data gets updated. Consequently, any other client connected to this web service receives this updates as well.
 +
{{Attention|Be aware, that the View Cache's scope is valid only within a web service instance. A client connected to a different web service does not receive updates happening in a different web service's View Cache.}}
  
−
=== Enabling ===
+
=== Application Pool Settings ===
−
The View Cache features needs to be enabled in the [[Configuration_File_Example#tab=web_config|web.config]] file of the corresponding web service.
+
[[File:UI ApplicationPool AdvancedSettings.png|thumb|Application Pool / Advanced Settings]]
 +
Any in-memory data of a web service, respectively an application pool, is lost whenever application pools are (automatically) recycled. Although there is no downtime during a recycle, this empties the View Cache's memory.
  
−
{| class="wikitable" | width = "88%"
+
Due to the missing automatism for a periodic initialization or update, the default interval settings for recycling '''must''' be changed, such that the application pool and the related web services are not recycled automatically.
 +
 
 +
The according settings of the application pool are
 +
{| class="wikitable sortable"
 
|-
 
|-
−
! Area!! Setting!! Description
+
! Setting !! Default value !! Recommended value !! Comment
 
|-
 
|-
−
| appSettings|| UBIK.Service.EnableViewCachage || Enable (1) / Disable (0) the view cache feature for this web service
+
| {{Menu nav|Advanced Settings|Recycling|Regular Time Interval (minutes)}} || 1740 || 0 || Application pool will be recycled after this time
 +
|-
 +
| {{Menu nav|Advanced Settings|Process model|Idle Time-out (minutes)}}|| 20 || 0 || Application pool will be terminated after this time without any traffic
 
|}
 
|}
−
 
+
{{Attention|The value of the ''Idle Time-out (in minutes)'' property must be less than the value of the ''Regular Time Interval (in minutes)'' property (Source: [https://support.microsoft.com/en-us/kb/954871 Microsoft Support]).}}
−
<syntaxhighlight lang="xml">
+
−
  <appSettings>
+
−
    ...
+
−
    <add key="UBIK.Service.EnableViewCache" value="1" />
+
−
  </appSettings>
+
−
</syntaxhighlight>
+
  
 
=== Testing ===
 
=== Testing ===
−
Test the View Cache's result for a single object, given by its {{Guid}}, via the method [[#TestViewState]].
+
Test the View Cache's result for a single object, given by its {{Guid}}, via the method [[#TestViewState|TestViewState]].
 
The result will not retrieve the physical documents.
 
The result will not retrieve the physical documents.
  
Line 51: Line 52:
 
         string GetViewStateInformation(string appName, string contextName, string authentication);
 
         string GetViewStateInformation(string appName, string contextName, string authentication);
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
 +
To call this in a web browser, one can access
 +
<syntaxhighlight lang="html4strict">
 +
https://ContentServerAddress/ContentServicePath/GetViewStateInformation/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537
 +
</syntaxhighlight>
 +
to fetch data. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.
 +
 +
Once the view cache is ready, the response should say something like "Cache State <<ONLINE>>"
  
 
=== TriggerViewStateUpdate ===
 
=== TriggerViewStateUpdate ===
Line 69: Line 79:
 
         bool TriggerViewStateRefresh(string appName, string contextName, string authentication);
 
         bool TriggerViewStateRefresh(string appName, string contextName, string authentication);
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
 +
To call this in a web browser, one can access
 +
<syntaxhighlight lang="html4strict">
 +
https://ContentServerAddress/ContentServicePath/TriggerViewStateUpdate/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537
 +
</syntaxhighlight>
 +
to trigger an update. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.
 +
 +
 +
=== GetViewStateDetails ===
 +
Gets detail information abut the view cache, it's state and the duration for loading its components.
 +
 +
<syntaxhighlight lang="csharp">
 +
        /// <summary>
 +
        /// Gets detail information abut the view cache, it's state and the duration for loading its components.
 +
        /// </summary>
 +
        /// <param name="appName">Name of the application.</param>
 +
        /// <param name="contextName">Name of the context.</param>
 +
        /// <param name="authentication">The authentication.</param>
 +
        /// <returns>Detail information abut the view cache, it's state and the duration for loading its components</returns>
 +
        [OperationContract]
 +
        [WebInvoke(UriTemplate = "GetViewStateDetails/{appName}/{contextName}/{authentication}", Method = "GET",
 +
                  RequestFormat = WebMessageFormat.Json,
 +
                  ResponseFormat = WebMessageFormat.Json)]
 +
        UBIK.Service.DTO.V360.ViewCacheInfoItem[] GetViewStateDetails(string appName, string contextName, string authentication);
 +
</syntaxhighlight>
 +
 +
To call this in a web browser, one can access
 +
<syntaxhighlight lang="html4strict">
 +
https://ContentServerAddress/ContentServicePath/GetViewStateDetails/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537
 +
</syntaxhighlight>
 +
to fetch details. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.
 +
 +
As long as the ViewCache is not initiliazed (not online yet) you will only receive details about the Data Pool and its size.
 +
 +
[[Category:Installing|View Cache]]
 +
[[Category:Web service|View Cache]]
  
 
=== TestViewState===
 
=== TestViewState===
Line 88: Line 135:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
[[Category:Installing]]
+
== See also ==
−
[[Category:Web service]]
+
* [http://weblogs.asp.net/owscott/why-is-the-iis-default-app-pool-recycle-set-to-1740-minutes Why is the IIS default app pool recycle set to 1740 minutes?]
 +
 
 +
[[Category:Installing|View Cache]]
 +
[[Category:Web service|View Cache]]

Latest revision as of 14:55, 14 March 2024

The View Cache feature increases the performance of the Web Service by caching the data to be published and sent to the clients. All content data as well as the hierarchies, as defined by the View and in the ACM, is evaluated and cached internally. Be aware, that this data does not encompass the physical documents linked to the objects, hence the documents have to be loaded if requested from the client.

A client's request for hierarchical data, covering two or more hierarchy levels, will be handled using the cached data. Any request covering only one hierarchy level will by-pass the view cache and be treated directly. For example, browsing through the objects using the Content Browser does not use the View Cache, whereas preparing the Offline Mode utilizes the cache to improve performance.

Once the cache has been initialized, its status and additional information can be retrieved by web service methods.

IC Attention.pngUp to now the View Cache needs to be initialized and updated manually after every (re)start of the web service. This can be done manually or by using an automatism!

Using the View Cache

Initialization / Update of View Cache

The cache needs to be initialized after a web service has been (re)started by calling the method TriggerViewStateUpdate. If a client commits data via a web service having the View Cache enabled, the cached data gets updated. Consequently, any other client connected to this web service receives this updates as well.

IC Attention.pngBe aware, that the View Cache's scope is valid only within a web service instance. A client connected to a different web service does not receive updates happening in a different web service's View Cache.

Application Pool Settings

Application Pool / Advanced Settings

Any in-memory data of a web service, respectively an application pool, is lost whenever application pools are (automatically) recycled. Although there is no downtime during a recycle, this empties the View Cache's memory.

Due to the missing automatism for a periodic initialization or update, the default interval settings for recycling must be changed, such that the application pool and the related web services are not recycled automatically.

The according settings of the application pool are

Setting Default value Recommended value Comment
Advanced Settings→Recycling→Regular Time Interval (minutes) 1740 0 Application pool will be recycled after this time
Advanced Settings→Process model→Idle Time-out (minutes) 20 0 Application pool will be terminated after this time without any traffic
IC Attention.pngThe value of the Idle Time-out (in minutes) property must be less than the value of the Regular Time Interval (in minutes) property (Source: Microsoft Support).

Testing

Test the View Cache's result for a single object, given by its Guid, via the method TestViewState. The result will not retrieve the physical documents.

Web Service Interface

Use the these web service members to gain status and runtime information of the View Cache. More detailed information and a comprehensive list of all members and data types are located in the UBIK® class documentation.

GetViewStateInformation

Get information about the current state of the View Cache.

        /// <summary>
        /// Gets information abut the state of view cache.
        /// </summary>
        /// <param name="appName">Name of the application.</param>
        /// <param name="contextName">Name of the context.</param>
        /// <param name="authentication">The authentication.</param>
        /// <returns>Information about the state of the view cache as human readable string</returns>
        [OperationContract]
        [WebInvoke(UriTemplate = "GetViewStateInformation/{appName}/{contextName}/{authentication}", Method = "GET",
                   RequestFormat = WebMessageFormat.Json,
                   ResponseFormat = WebMessageFormat.Json)]
        string GetViewStateInformation(string appName, string contextName, string authentication);


To call this in a web browser, one can access

https://ContentServerAddress/ContentServicePath/GetViewStateInformation/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537

to fetch data. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.

Once the view cache is ready, the response should say something like "Cache State <<ONLINE>>"

TriggerViewStateUpdate

Start or trigger reinitialization of the View Cache.

        /// <summary>
        /// Triggers a refresh of the view cache.
        /// The current cache stays valid until the new cache was fully built.
        /// </summary>
        /// <param name="appName">Name of the application.</param>
        /// <param name="contextName">Name of the context.</param>
        /// <param name="authentication">The authentication.</param>
        /// <returns>true as the refresh was triggered successfully, false otherwise</returns>
        [OperationContract]
        [WebInvoke(UriTemplate = "TriggerViewStateUpdate/{appName}/{contextName}/{authentication}", Method = "GET",
                   RequestFormat = WebMessageFormat.Json,
                   ResponseFormat = WebMessageFormat.Json)]
        bool TriggerViewStateRefresh(string appName, string contextName, string authentication);


To call this in a web browser, one can access

https://ContentServerAddress/ContentServicePath/TriggerViewStateUpdate/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537

to trigger an update. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.


GetViewStateDetails

Gets detail information abut the view cache, it's state and the duration for loading its components.

        /// <summary>
        /// Gets detail information abut the view cache, it's state and the duration for loading its components.
        /// </summary>
        /// <param name="appName">Name of the application.</param>
        /// <param name="contextName">Name of the context.</param>
        /// <param name="authentication">The authentication.</param>
        /// <returns>Detail information abut the view cache, it's state and the duration for loading its components</returns>
        [OperationContract]
        [WebInvoke(UriTemplate = "GetViewStateDetails/{appName}/{contextName}/{authentication}", Method = "GET",
                   RequestFormat = WebMessageFormat.Json,
                   ResponseFormat = WebMessageFormat.Json)]
        UBIK.Service.DTO.V360.ViewCacheInfoItem[] GetViewStateDetails(string appName, string contextName, string authentication);

To call this in a web browser, one can access

https://ContentServerAddress/ContentServicePath/GetViewStateDetails/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537

to fetch details. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.

As long as the ViewCache is not initiliazed (not online yet) you will only receive details about the Data Pool and its size.

TestViewState

Test the View Cache's result for a single object, without retrieving the physical documents.

        /// <summary>
        /// Test member for testing the View Cache.
        /// </summary>
        /// <param name="appName">Name of the application.</param>
        /// <param name="contextName">Name of the context.</param>
        /// <param name="ownerUID">UID of the object the test should be executed for (e.g. root object). All data below this object will be delivered.</param>
        /// <param name="authentication">The authentication.</param>
        /// <returns>data stored in the view cache as BCHierarchyDeltaShipments</returns>
        [OperationContract]
        [WebInvoke(UriTemplate = "TestViewState/{appName}/{contextName}/{owneruid}/{authentication}", Method = "GET",
                   RequestFormat = WebMessageFormat.Json,
                   ResponseFormat = WebMessageFormat.Json)]
        DTO.V211.BCHierarchyDeltaShipments TestViewState(string appName, string contextName, string ownerUID, string authentication);

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=View_Cache&oldid=26012"