Difference between revisions of "View Cache"

Revision as of 12:34, 7 May 2015

This feature is a beta version. If you experience unexpected issues, please Contact us for support.

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. Once the cache has been initialized, its status and additional information can be retrieved by web service methods.

Enabling the View Cache

The View Cache features needs to be enabled in the web.config file of the corresponding web service.

Area	Setting	Description
appSettings	UBIK.Service.EnableViewCachage	Enable (1) / Disable (0) the view cache feature for this web service

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.

[OperationContract]
[WebInvoke(UriTemplate = "GetViewStateInformation/{appName}/{contextName}/{authentication}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
string GetViewStateInformation(string appName, string contextName, string authentication);

TriggerViewStateUpdate

Start or trigger reinitialization of the View Cache.

[OperationContract]
[WebInvoke(UriTemplate = "TriggerViewStateUpdate/{appName}/{contextName}/{authentication}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
bool TriggerViewStateRefresh(string appName, string contextName, string authentication);

TestViewState

Test the View Cache's result for a single object (given by its Guid), without retrieving the physical documents. <syntaxhighlightlang="csharp">

       [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);

</syntaxhighlight>

@@ Line 20: / Line 20: @@
 == Web Service Interface ==
-Use the these web service members to gain status and runtime information of the View Cache. Mmore detailed information and a comprehensive list of all members and data types are located in the {{UBIK}} class documentation.
+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 ===
-The web service provides a method to add content to be pushed to the clients:
+Get information about the current state of the View Cache.
 <syntaxhighlight lang="csharp">
          [OperationContract]
@@ Line 33: / Line 33: @@
 === TriggerViewStateUpdate ===
-The push web service provides access to its current status via a debug - info method. Use this to retrieve information about the current status of the web service.
+Start or trigger reinitialization of the View Cache.
-This method can also be called via a web browswer by browsing the according URL.
 <syntaxhighlight lang="csharp">
          [OperationContract]
@@ Line 44: / Line 43: @@
 === TestViewState===
-To trigger reinitialization (reset) of the push web service from extern, call this method via a web browser.
+Test the View Cache's result for a single object (given by its {{Guid}}), without retrieving the physical documents.
 <syntaxhighlightlang="csharp">
          [OperationContract]