Previous Topic: Configure the Federation SettingsNext Topic: Configure the Proxy Service Settings

Administration Guide › Administrating CA SiteMinder® SPS › Configuration Methods of CA SiteMinder® SPS › Configure the Custom Error Messages Settings

Configure the Custom Error Messages Settings

CA SiteMinder® SPS supports the custom error pages feature, which lets you customize the error pages that the Web Server displays when a client request fails.

You can configure the settings manually or using Administrative UI.

To configure manually, perform the following steps:

  1. Open the server.conf file.
  2. Navigate to the <customerrorpages> section.
  3. Configure the following parameters:
    enable

    Specifies how CA SiteMinder® SPS manages the web server error pages. If the value is set to yes, you can customize the Web Server error pages and the Web Server displays the customized error pages when a client request fails. If the value is set to no, the Web Server displays the default HTTP 1.1 error pages when a client request fails. CA SiteMinder® SPS reads the value at the startup.

    locale_type

    Specifies the locale of the custom error pages. If the value is set to 0, CA SiteMinder® SPS uses the locale settings of the CA SiteMinder® SPS server to display the custom error messages. If the value is set to 1, CA SiteMinder® SPS uses the locale settings of your browser to display the custom error messages.

    showcallstack

    Specifies if the call stack must be retrieved to track exceptions that you want to debug. If the value is set to true, CA SiteMinder® SPS retrieves the call stack and displays it on the custom error page. If the value is set to false, the call stack is hidden.

    Important! For security reasons, we recommend that you do not enable the showcallstack option unless you want to track the complete details of an exception that you want to debug. Disable showcallstack after you complete debugging.

To configure using Administrative UI, perform the following steps:

  1. Navigate to Administration, Custom Error Pages.
  2. Select Enable Custom Error Pages.
  3. Set the following locale settings:
    Locale Type

    Specifies the locale of the custom error pages. If you select Server, the CA SiteMinder® SPSses the locale settings of the CA SiteMinder® SPS server to display the custom error pages. If you select Web browser, CA SiteMinder® SPS uses the locale settings of your browser to display the custom error messages.

    LocaleCountry

    Specifies the locale country.

    Locale Language

    Specifies the language.

  4. Click Save.
Modify the Default Custom Error Pages

By default, CA SiteMinder® SPS provides a list of possible request errors that are received from CA SiteMinder® SPS and web servers.

The error messages in the SPSErrorMessages.properties and WebServerErrorMessages.properties files are in the following format:

exception|error code=error message|URL

Where

exception|error code

Defines the exception or the error code that CA SiteMinder® SPS or web server returns when a user request fails.

Limits: 100 characters

error message|URL

Defines the error message CA SiteMinder® SPS or web server displays when an exception or error code is returned. You can specify either the error message in plain text or the targeted URL that the user must use.

Limits: 4096 characters

Modify the Default CA SiteMinder® SPS Error Pages

By default, CA SiteMinder® SPS displays an error page when a user request fails due to inappropriate configuration settings of the CA SiteMinder® SPS server. Each error page is mapped to an error code. When a user request fails, CA SiteMinder® SPS checks for the error code and displays the corresponding error page.

The following table lists the default errors that CA SiteMinder® SPS displays due to inappropriate configuration settings of the CA SiteMinder® SPS server:

Error Code

Error Message

VirtualHostNotFound

Virtual host might not have been configured properly. Verify the virtual host settings in the server.conf file

SessionSchemeNotFound

The defined session scheme is not found. Verify the session scheme settings in the server.conf file

SessionCreateError

The session store might have been corrupted during creation. Restart SPS

SessionUpdateError

The session store might have been corrupted during update. Restart the SPS CA SiteMinder® SPS

WebAgentException

CA SiteMinder® SPS might not be communicating with the Web agent. For more information about the error, see CA SiteMinder® SPS logs

Noodle_GenericException

There might be an error during processing a request at noodle stage. For more information about the error, see CA SiteMinder® SPS logs

Noodle_FilterException

There might be an error during pre/post processing of filters at noodle.

Noodle_UnknownHostException

The IP address of the targeted host could not be determined

Noodle_ConnectException

An error occurred while attempting to connect a socket to a remote address and port

Noodle_NoRouteHostException

An error occurred while attempting to connect a socket to a remote address and port because of an intervening firewall or unavailability of an intermediate router

Noodle_InteruptedIOException

An input or output transfer is terminated because the thread that is performing the transfer was interrupted

Noodle_SocketException

An error occurred in the underlying protocol

Noodle_NoSuchMethodException

CA SiteMinder® SPS does not support the method

Noodle_ProxytoProxyNotSupported

CA SiteMinder® SPS does not support proxy Web Server

Noodle_CouldNotConnectToBackEndServer

Could not connect to backend web server due to lack of processing threads at the SPS

Noodle_NoAvailableConnections

There are no connections available to serve the request

Redirect_NoTargetURLParameter

No URL is specified during Redirect

FedRequest_Redirect_ImproperURL

The redirect URL is not specified or is malformed. Verify the federation settings or the RelayState in the client request

FedRequest_Redirect_RewriteLocationHeaderFailure

Unable to create a redirect session because the memory holding the session keys might have crashed while processing the federation request

FedRequest_CookieProcessingError

Unable to create a cookie while processing the federation request

FedRequest_ResponseProcess_AddSessionError

An error occurred while adding the session during the federation request processing, the memory holding the session keys might have crashed

FedRequest_ResponseProcess_LocHeaderModifyError

An error occurred while updating the location header during federation request processing, the memory holding the session keys might have crashed

SPSException

An error occurred while processing the request. For more information about the error, see CA SiteMinder® SPS logs

You can modify the error message of an error page manually or using Administrative UI.

To modify manually, perform the following steps:

  1. Open the SPSErrorMessages.properties file.

    Default Path: <SPS_installation_folder>\Tomcat\properties\

  2. Navigate to the error record you want to modify.
  3. Make the necessary changes.
  4. Save the changes.

To modify using Administrative UI, perform the following steps:

  1. Navigate to Administration, Custom Error Messages.
  2. Edit the error message of the error code in CA SiteMinder® SPS Custom Error Messages.
  3. Click Save.
Modify the Web Server Error Pages

By default, CA SiteMinder® SPS supports all HTTP 1.1 error codes and the web server displays the default HTTP 1.1 error pages when a client request fails. When you enable the custom error pages feature, you can customize the error pages and the web server displays the customized error details when a client request fails. Each error page is mapped to an error code.

If you enable the feature and customize an error page, the web server displays the customized error page when the error occurs. If you enable the feature and do not customize an error page, the web server displays the default error page returned by the web server when the error occurs.

You can add, modify, or delete an error code or error message of a web server error page manually or using Administrative UI. If you delete the error message of an error code, the CA SiteMinder® SPS displays a page with the following message:

No custom message to display. Find more details in logs.

To manage manually, perform the following steps:

  1. Open the WebServerErrorMessages.properties file.

    Default Path: <SPS_installation_folder>\Tomcat\properties\

  2. Navigate to the error record you want to modify.
  3. Make the necessary changes.
  4. Save the changes.

To manage using Administrative UI, perform the following steps:

  1. Navigate to Administration, Custom Error Messages.
  2. To edit an error message, perform the following steps:
    1. Click the Edit icon of the error message in Webserver Custom Error Messages.
    2. Modify the message.
    3. Click OK and Save.
  3. To delete an error code, error code, perform the following steps:
    1. Click Actions, Delete of the error code you want to delete in Webserver Custom Error Messages.
    2. Click Save.
  4. To add an error message to the default webserver error codes, perform the following steps:
    1. Click Add, and enter the error message details.
    2. Click Add.