Cache Manager Basics


To increase the speed and responsiveness of our websites, Ektron employs a caching strategy for some of our sites. On a scheduled basis, pages are rendered and the resulting HTML is stored in a cache. Pages are served from the cache according to user requests without the need to render each page at the time of the request or to render a page repeatedly for multiple requests.

Because pages are cached, content changes may not be immediately visible upon publishing or approval for websites that employ caching. There are also templates, such as the "archive" or "summary" templates (http://www.moodyministries.net/crp_NewsSummary.aspx?id=100328) that aggregate content and are not necessarily aware when the content that they aggregate has changed. For these situations, a mechanism to clear the cache is needed. The Cache Manager is this mechanism.

The Cache Manager is accessible at the following address (no login or permissions are required to use the Cache Manager and the Cache Manager is also available outside the Moody firewall):

http://www.moodyministries.net/cachemanager.aspx

Using the Cache Manager


Below is how the Cache Manager version 2 window appears:

Screen Shot 2013-08-12 at 1.16.25 PM.png

  1. Using the Select Website drop-down list, select the website on which the page you want to clear is hosted.
  2. In the Production group, select the domain for the website.
  3. In the Target(s) group, make sure all target domains are checked (they should all be checked by default).
  4. Use one of the following "refresh" options to clear the cache for the newly created content/item.
  5. The Status box on the right (or a message next to the button in the case of Refresh Menus) will update to notify you of the results of the cache clearing operation.
  6. View the content on the website by navigating to it or entering a URL to access it directly. NOTE: If the changes are not visible as expected,try "force-refreshing" the page by holding down Shift when you reload the page (Shift+click the reload button -or- Shift+F5 in many browsers), or make sure to clear your browser's cache if that fails to work, before repeating any work or cache clearing or notifying a Web liaison or the Web team.

Refresh by Template


This clears the cache for ALL PAGES that use the single specified template, and in the case of templates that aggregate other site content, updates the aggregated information as well.

In the text input field, enter the name of the template (you can find this on a content block's Properties tab, in the row titled Template, see below) you wish to clear from the cache. Then, click the Refresh Template button to clear that content from the cache.

Screen Shot 2013-08-12 at 1.51.36 PM.png

NOTE: remember, EVERY PAGE that is assigned to this template will be cleared from the cache. This is a potentially "expensive" operation for templates such as brd_programmainpage.aspx, brd_programtoday.aspx, crp_main.aspx, etc.

Refresh by Content ID


This is the basic and preferred method of clearing cached content. This clears the cache for a single specified content block, and in the case of content using a template that aggregates other site content, updates the aggregated information as well.

In the text input field, enter the ID number of the content block (you can find this on a content block's Properties tab, in the row titled Content ID, see above) you wish to clear from the cache. Then, click the Refresh Content button to clear that content from the cache.

Refresh Menus

If you are a user who has permissions to edit a site's menus, you may use this feature to clear the site's menu cache after making changes to the menus. Simply click the Refresh Menus button to clear the menus from the cache.

NOTE: Cache Manager version 1 required templates to be refreshed after a menu refresh in order to display the edited items. This was required for every template on which the edited menu items appeared. This may or may not be necessary with Cache Manager version 2 [Not yet tested. Please update this wiki after testing.]

List Items


Use of this advanced feature is not covered by this wiki. You're not missing anything. Click to see the ugliness and confusion, if you dare!

Clearing the Cache for Content that Appears on Archive/Summary Templates


There are some rather common scenarios in the case of CMs who edit news and radio program content that require some additional steps to make visible recently edited or newly added content:

1. You edit content for an already existing and therefore already cached radio program or news content item. The changes are not immediately visible, so you use the ID of the content block you just edited and clear the cache using the Cache Manager. The changes are now visible on the content's page accessed by navigating to it or using its URL, BUT the changes do not appear on the news or radio archive/summary pages.

-or-

2. You create a new radio program, news, etc. content item. Because the content item is new and not yet cached, it is immediately visible when accessed directly using its URL, BUT it does not appear on the news or radio archive/summary pages.

To remedy these situations, you need to take the additional step of clearing the cache of any archive/summary templates that need to reflect the recently edited or newly added content. You can find the ID of the archive/summary pages by navigating to them on the website and noting the ID in the URL. In the case of an aliased page, you may need to locate the page's content block in the Ektron WorkArea to find the ID (you may call the Web liaison or the Web team for help if you cannot locate the content block in the WorkArea). With the content ID of the archive/summary page, then follow the instructions above for Refresh by Content ID.