Activating tracking ID in templates - PingFederate

Activating tracking ID in templates - PingFederate - 11.1

PingFederate Server

bundle

pingfederate-111

ft:publication_title

PingFederate Server

Product_Version_ce

PingFederate 11.1

category

Administrator

Audience

Capability

DeploymentMethod

Product

SingleSignonSSO

Software

SystemAdministrator

pf-111

pingfederate

ContentType_ce

You can configure PingFederate to display the tracking ID in the user-facing error Velocity templates. When an error occurs, use the tracking ID to look for the related log messages.

You can find the Velocity template files in the <pf_install>/pingfederate/server/default/conf/template directory.

The Velocity variable is $TrackingId and is available in the following templates:

general.error.page.template.html
generic.error.msg.page.template.html
idp.slo.error.page.template.html
idp.sso.error.page.template.html
sourceid-wsfed-idp-exception-template.html
sp.slo.error.page.template.html
sp.sso.error.page.template.html
state.not.found.error.page.template.html

Open the applicable Velocity template file.
Search for the $TrackingId variable.
Follow the inline instructions to activate the variable.

Note: Template customization does not require a restart of PingFederate.
For a clustered PingFederate environment, repeat these steps on each engine node.

The following screen capture demonstrates the user experience after the $TrackingId variable is activated and an error has occurred. In this example, V3IwuUsy8PQp-9ZbE9UfUjOEo9c is the tracking ID.