×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Error context

Steffen Burzlaff

Steffen Burzlaff Last update: Feb 15, 2018

If a request results in an error (for example if a page could not be found, a user does not have permissions and so forth), the template is rendered in the error context.

  • error.vm — The default (and mandatory) error template. It is used for all situations, when no specific error template is available.
  • error<statusCode>.vm — Error-code specific templates are used if if statusCode matched the 3-digit HTTP status code that indicates the reason of the error.

For example, error404.vm will be used to render the error page if a page could not be found.

Methods

Name Type Description
alternativeUrl String

A relative link to the default language version of the page that could not be accessed because of an error, assuming the following conditions are met (in any other case the return value is null):

  • integration with Scroll Content Management is enabled
  • translations are enabled for the viewport
  • the request URL has the form of a page URL
  • the requested page is in a language other than the default language

attributionLine HtmlSafeString

an HTML snippet containing the attribution line that must be included in Scroll Viewport themes.

baseUrl String

The base URL for the current prefix, not including the viewport path prefix. May be different from the base URL of Confluence if the viewport is configured for a specific domain.

blog Blog

An object for accessing information about blog posts. This is an alias for: $repository.blog

comments Comments

A helper that provides access to the comment API.

contentContext String

The context describing the content the user was navigating when the error occurred. Send as query parameter when changing properties (like version and language) from a non-existing page. May be null if the error did not result from changing properties.

contextPath String

The web application context path of Confluence, for example: /confluence

find Find

a placeholder for find.

hasBlogPosts boolean

True if blog posts are enabled in the current viewport, otherwise false.

hasPages boolean

True if pages are enabled in the current viewport, otherwise false.

i18n I18n

An object for retrieving I18n resources.

include Include

A helper for including templates from the viewport theme and pages and blog posts from the Confluence system.

isBlogOverview boolean

True if the current page displays a blog overview, otherwise false.

isError boolean

True if the current page displays an error, otherwise false.

isPage boolean

True if the current page displays a page or a blog post, otherwise false.

isSearch boolean

True if the current page displays search results, otherwise false.

languages Languages

The language properties or null if languages are not enabled. This is an alias for: $repository.languages

link Link

A helper that can be used to construct links to content in Confluence, such as pages, blog posts and spaces.

originalUrl String

The original URL that could not be loaded due to the error.

page Page

The page or blog post to be rendered.

pages Pages

An object for accessing information about the pages. This is an alias for: $repository.pages

redirect Redirect

a placeholder for redirect.

repository Repository

The content repository of the current viewport.

space Space

The space for which the viewport is configured.

statusCode String

The 3-digit status code of the current HTTP response. Will typically be 200 if no error occurred.

statusText String

The reason phrase of the HTTP status response. Will usually be Ok if no error occurred.

stringEscapeUtils StringEscapeUtils

A helper object for escaping strings in the template. See StringEscapeUtils for more information.

stringUtils org.apache.commons.lang.StringUtils

A helper object for modifying strings in the template. See StringUtils for more information.

theme Theme

The current theme. Use to reference resources like CSS, JavaScript and image files from the theme, for example: $theme.baseUrl/css/theme.css

tree Tree

A helper object for rendering the page tree of the current viewport.

Caution: The tree rendered by this helper contains all pages in the space and can potentially be very large.

upp Upp

A placeholder for accessing extended user properties provided the "User Profile Plugin". For example: $upp.getProperty($user, "Department"). Note that the User Profile Plugin has to be installed for this to work.

url Url

The current URL.

urlEscaper UrlEscaper

Helper object for escaping strings for URLs.

user User

The currently logged in user.

variants Variants

The variant properties or null if variants are not enabled. This is an alias for: $repository.variants

versions Versions

The version properties or null if versions are not enabled. This is an alias for: $repository.versions

viewport Viewport

The current viewport.

webPanels WebPanels

Placeholder for accessing Confluence web panel modules.

xsrfToken XsrfToken

A placeholder for generating an XSRF token to be included into follow-up form submissions or AJAX requests.

2x2.11
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok