Versions Compared

Old Version 4

changes.mady.by.user Sireesha Dugginapeddi [Appfire] (Inactive)

Saved on

compared with

New Version 5

changes.mady.by.user Kathryn Sandin

Saved on

Key

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

Table of Contents
maxLevel1
excludeOn this page
typeflat
separatorpipe

...

Table plus


ParameterDefaultMacro Browser LabelDescription
idautomatically generatedReference id

Defaults to an automatically generated sequence number. The id must be unique on the page. Specifying the id can improve performance during edit by reducing cache refreshes during macro browser refresh, preview, and save cycle. It also helps when re-ordering cache macros on a page. The can be used when doing cache macro specific refreshes - see Cache Refresh below. Since 5.1.0.

refresh

1d

(one day)

Cache refresh period

Cacheisrefreshed the next time page is viewed after the refresh period. Anunqualified numberistreated as seconds. A number followed by one of the following charactersistreated as follows:

  • s - seconds.
  • m - minutes.
  • h - hours.

  • d- days.

    Note

    Any data after a s, m, h, or d is ignored. For example, 10days is the same as 10d or 10 days.


cron
Cron expressionCron-like expression for finer grained cache expiration and refresh. See Cron Expressions. For example: 30 * * * * - cacheexpires30 minutes past each hour of the day.
checkAttachmentstrueCheck attachmentsIf true, the cache is refreshed if there is any change in the attachments on this page. This includes adding, removing, or changing the version of any attachment. For instance, if you are caching the rendering of the an excel spreadsheet, then the data is refreshed if the attached spreadsheet is updated.
showRefreshfalseShow refresh iconWhen shown, the icon can be clicked to cause the immediate refresh of the data.
showDatefalseShow dateShow the date and time of data was last generated. See also dateFormat.
indexfalseIndex contentAdd cached content to the Confluence search index. Whenever the cached data is updated, the page is re-indexed. This enables external content to be found using Confluence search.
titleRefreshTitleTitle to show when mouse is over the refresh icon.
dateFormatuser date formatDate formatDefaults to the system defined format modified by the users user's time zone. The refresh date can be have a specific format. Use a simple date format string. Since 6.1.
anchor
AnchorName of a page anchor used to position after refresh link is pressed. Use @default to have an anchor generated at the macro location. Since 6.7.
retryDefaultRetry featureSpecial handling for render errors that can be retried. See Retry Feature for more details. Since 6.8.


...

  • To force all cache macros on a page to refresh, use the refresh request attribute with value true

    • Example

      No Format
      http://localhost/display/DEMO/test?refresh=true


  • To force a specific cache macros macro on a page to refresh, use refresh request attribute with value equal to the cache macro id. If not specified, it defaults to a sequence number based on position on page

    • Example

      No Format
      http://localhost/display/DEMO/test?refresh=1

http://localhost/display/DEMO/test?refresh=myId


...