Difference between revisions of "View Cache"
| Line 2: | Line 2: | ||
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. | 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. | ||
| − | == | + | {{Attention|Up to now the View Cache needs to be initialized and updated manually! There is not automatism available yet!}} |
| + | |||
| + | == Using the View Cache == | ||
| + | |||
| + | === === | ||
| + | |||
| + | === Enabling == | ||
The View Cache features needs to be enabled in the [[Configuration_File_Example#tab=web_config|web.config]] file of the corresponding web service. | The View Cache features needs to be enabled in the [[Configuration_File_Example#tab=web_config|web.config]] file of the corresponding web service. | ||
| Line 18: | Line 24: | ||
</appSettings> | </appSettings> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| + | |||
| + | === === | ||
== Web Service Interface == | == Web Service Interface == | ||
Revision as of 13:29, 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.
 | Up to now the View Cache needs to be initialized and updated manually! There is not automatism available yet! |
Contents
Using the View Cache
= Enabling
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 |
<appSettings>
...
<add key="UBIK.Service.EnableViewCache" value="1" />
</appSettings>
...
<add key="UBIK.Service.EnableViewCache" value="1" />
</appSettings>
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);
/// 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);
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);
/// 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);
TestViewState
Test the View Cache's result for a single object (given by its Guid), 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);
/// 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);
