Setting up your first Cache Configuration Entry

Before you start using the Cache Refresh Framework you need to create a Cache Configuration List. These are created on the root site of Web Application.
To create the Cache Configuration List do the following:-
  • Browse to your Central Administration Site
  • Click on Manage Web Applications
  • Choose the Web Application that will host the Cache Configuration list
  • Click Manage Web Application Features
  • Click Activate against the Cache Configuration Feature

A new list will be created in the root site of the Web Application called CacheRefreshConfiguration.

This list can be accessed by:-
  • Browse to the Web Application
  • Click Site Actions->View All Site Content
  • Click the Cache Configuration List


Creating a Cache Configuration Entry
Once the Cache Configuration List has been created then you are ready to start the configuration.

Create a new item like you would with any SharePoint list.
Type in a CacheKey this is the unique identifier which will be used by your code and to identify items in the cache and also items in the cache configuration.

Type in the path for the file that will be used to refresh the cache. This file must be accessable by the account that is running the SharePoint Timer Service.

It is recommended that a folder naming structure like follows is used. Create a folder under the "c:\program files\"
  • e.g. "c:\program files\[your company name]\cache\[cachekey].config"

The timer job when run will create the file if it does not already exist.

Choose a time to wait in minutes between each time the cache is refreshed and finally choose whether the cache is enabled or not.

Creating the Cache Configuration Refresh Timer Jobs
Once you have created your configuration entries, we are ready to create the SharePoint Timer Jobs. These are created using PowerShell.

From your SharePoint Central Admin Server:-
  • Start a SharePoint 2010 Management Console
  • Type: Update-ITSPCacheConfigJobs -Url [The Web Application Url]

You should see an output of the list object that you created in the previous step.

Check and Run the Cache Configuration Refresh Timer Jobs
Staying on the SharePoint Central Admin Server:-
  • Start Central Admin
  • Click Monitoring->Manage Timer Jobs
  • Choose the Web Application filter
  • Choose the appropriate Web Application
  • Scroll down until you see Cache Configuration Refresh Timer Job ([Cache Key]
  • Click the Link
  • Click Run now.

If you open up Windows Explorer to the folder that you used for the Dependency File Location, you should now see a file with the specified filename. Opening the contents should show a file with a date/time stamp in it.

You are now ready to start using the Cache Refresh Framework!

Last edited Jun 18, 2012 at 10:32 PM by Quannum, version 1

Comments

No comments yet.