Product
Hosting Environment
Operating System
Capability
Task Type
Draft Beta
Close

Customize and localize PingAccess

Updated 94

Add to MyDocs | Hide Show Table of Contents

Customization of user-facing pages

PingAccess supplies templates to provide information to the end user. These template pages use the Velocity template engine, an open-source Apache project, and are located in the PA_HOME/conf/template directory.

You can modify most of these pages in a text editor to suit the particular branding and informational needs of your PingAccess installation. (Cascading style sheets and images for these pages are included in the PA_HOME/conf/static/pa/assets subdirectory.) Each page contains both Velocity constructs and standard HTML. The Velocity engine interprets the commands embedded in the template page before the HTML is rendered in the user’s browser. At runtime, the PingAccess server supplies values for the Velocity variables used in the template.

Important: If you have modified the reserved application context root using the PingAccess Admin API, file system requests to the configured reserved application context root will be translated to /pa. This allows the file system behavior for PingAccess resources to remain unchanged. Thus, if the reserved context root is set to /ping, templates and other resources would still be stored on the file system in the /pa directory, as indicated by this document.

For information about Velocity, refer to the Velocity project documentation on the Apache Web site. Changing Velocity or JavaScript code is not recommended. The following variables are the only variables that can be used for rendering the associated Web-browser page.

Variable Description
title The browser tab title for the message. For example, Not Found.
header The header for the message. For example, Not Found.
info The information for the message. For example, No Resource configured for request.
exchangeId A value that identifies the request/response pair. This can be used to locate messages in the PingAccess logs.
trackingId A value that identifies either the tracking ID (identified with a tid: prefix) or an Access Token ID (identified with a atid: prefix). This can be used to identify the session in the PingAccess and PingFederate logs.

At runtime, the user's browser is directed to the appropriate page, depending on the operation being performed and where the related condition occurs (see the table below). For example, if Rule evaluation fails, the user's browser is directed to the Policy error-handling page. The following table describes each template.

Template File Name Purpose Type Action
admin.error.page.template.html Indicates an error occurred while the admin console was processing a request Error Consult PA_HOME/log/pingaccess.log to determine the underlying cause of the issue.
general.error.page.template.html Indicates that an unknown error has occurred and provides an error message. Error Consult PA_HOME/log/pingaccess.log to determine the underlying cause of the issue.
general.loggedout.page.template.html Displayed when a user logs out of PingAccess. Normal User should close the browser.
oauth.error.json Indicates that Rule evaluation has failed and provides an optional error message. To customize this information, see Error-Handling Fields for OAuth Rules documentation. Normal If necessary, consult the audit logs in PA_HOME/log for details about why the policy denied the request.
policy.error.page.template.html Indicates that Rule evaluation has failed and provides an optional error message. To customize this information, see Error-Handling Fields for Rules documentation. Normal If necessary, consult the audit logs in PA_HOME/log for details about why the policy denied the request.
Note: The templates stored in PA_HOME/conf/template/system are system templates, and should not be modified.

Tags Product > PingAccess > PingAccess 5.2; Product > PingAccess