Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Div
idProductTOC

On this page

Table of Contents
maxLevel2
excludeOn this page
typeflat
separatorpipe

Configure

...

Cache for Confluence

After upgrading or installing Cache installing Cache for Confluence, to navigate to the Global Configuration screen byCache for Confluence Configuration page:

Image Added

  1. Log in as a user with the System Administrator Global Permission.Select Add-onsthe system administrator global permission.
  2. Enter Cache in the Search box on the top corner of the page.
  3. Select Cache from the resulted list of options. The Cache for Confluence Configuration page is displayed.

OR

  1. Log in as a user with the system administrator global permission.
  2. Select Apps from the Administration menu (cog icon: Image Modified) at the top right corner of your screen. Then scroll
  3. Scroll down to Bob Swift Configuration on the left -hand nav bar and choose Cache Configurationsidebar, and select Cache Configuration.

The configuration settings are available in the following tabs:

Anchor
cache_config_globalConfig
cache_config_globalConfig
Global Configuration

This configuration page tab contains global settings that will control the behavior of the Cache for Confluence app, more specifically, cache settings for the Cache and Future macros. Once saved, settings will are immediately be applied to any macros in use.

Table: configuration options explained

...

Image Added

ParameterDefaultDescription
Default RetryDisabled

When enabled, the cache macro will recognize when a rendering indicates an error that can be retried. The cache macro will try to render Enable this option to control when the Cache macro must retry to render cached contents. The Cache macro renders previously cached data, if available, instead of the displaying an error, and will retry retries on the next cache render request. To override this behaviour in a specific macro, select the relevant option in the macro’s Retry feature parameter.

Default Retry Interval10Used as default by the future macro (retryinterval) parameter, this is 15

Enter the time in seconds that the Future macro will wait before a must wait, by default, to retry to render contents. This parameter corresponds to the macro’s Retry interval in seconds parameter.

Load Text OptionTitle

Text that is Select an option to control the text to be displayed by as the future Future macro while renders content is still being rendered to the page. Select "Title" to display the title parameter value set with the macro. Select "Text and Title" to display  The following options are available for selection:

  • Title - Default value. Displays the macro’s Title parameter value.
  • Text and Title - Displays the default load text
prefixed
  • followed by the
title
  • macro’s Title parameter value.
 The following options are available for selection:
  • Title - Default value
  • Text and Title
Maximum Number of Entries1000

This is Enter the number of cache entries that will to be keptstored. Entries above this value will force the forces older entries to be removed. 

Maximum Cache Size100Total amount of data

Specify the maximum data storage size (in Megabytes)

that will be kept in the

for cache.

Entries added that cause the total size to be exceeded this value then force the removal of older entries.

If this size is exceeded, the older cache entries are removed.

Note

This setting directly impacts JVM memory use.


Anchor
cache_config_cacheMgmt
cache_config_cacheMgmt
Cache Management

This tab allows administrators to refresh all cached content across all pages.

Image Added

ParameterDescription
Expire cacheClick this button to mark all cached content in all pages as expired. This action forces all Cache macros to refresh their contents when the pages are reloaded. 


Info

The Help us improve the product

...

 parameter was removed. We do not collect or transmit private user data or personally identifiable information

...

.

...

Next Step: Understanding Macros

With global settings now in place, the next step is to bring you up to speed on the Cache and Future Macros.

...

 Refer to the Appfire Trust Center for EULA and other policies.