Editing the Configuration Files

The Cisco Service Selection Dashboard (Cisco SSD) includes several configuration files that can be configured to meet the specific requirements of your installation. These include a file that allows you to customize web page names, a file that contains the Cisco SSD configuration settings, and a localization file that makes it easy to translate messages and errors.

Alias File

The alias file (alias.conf) allows you to associate URLs with files used by the Cisco SSD. The following is the default content of the alias file:

/=/templates/user.html
/user=/templates/user.html
/dashboard=/templates/user.html
/dashboard/user=/templates/user.html
/guest=/templates/guest.html
/dashboard/guest=/templates/guest.html

For example, to associate the URL http://www.cisco.com/home with the user.html file (the user logon web page), add the following line to the alias file:

/home=/templates/user.html

Dashboard Configuration File

The Dashboard configuration file (dashboard.conf) contains the settings made during installation and with the Dashboard Configuration Utility web page. Although these settings are generally configured through the Dashboard Configuration Utility web page, you can manually edit this file.

For information on these parameters, see "Configuring the Cisco Service Selection Dashboard."

Localization File

The Cisco SSD uses a localization file (LocalizationDB.conf) to associate message strings and error codes with customizable text. The text can be modified to contain specific references to your organization or it can be translated into another language.

Errors Section

Common Servlet Errors

This section describes common Java errors.


Message Code	Default Message
0	No Such Error.
1	An unhandled exception was received.

ConfigAdmin Servlet Errors

This section describes errors generated by the Configuration Utility.


Message Code	Default Message
100	Unable to find configuration file.
101	Unable to save changes to the configuration file.
102	Unable to save changes to the configuration file because an error occurred while trying to save the original file.

Messages Section

SSG Localizable Messages

This section describes messages generated by the Cisco Service Selection Gateway (Cisco SSG) and stored in the system log. If an error requires user intervention, the message is also forwarded to the user


Message Code	Meaning
1	The logon request failed because the username or password was missing.
2	The user could not log on to the service because the user is not logged on to the Cisco SSG.
3	The user attempted to exceed the maximum number of concurrent services and must log off of at least one service before trying a service logon request again.
4	The user attempted to log on to a service to which the user is not subscribed.
5	The user attempted to log on to a service that requires sequential access. Sequential services can only be accessed if no other services are logged on. The user must log out of all other services before attempting to log on again.
6	The service logon request failed because an active service requires sequential access. Services that require sequential access restrict any other service from being logged on simultaneously.
7	The logon request failed because the Cisco SSG does not have enough memory to create a connection object.
8	The logon request failed because the Cisco SSG does not have enough memory to create a host object.
9	The user account is unknown.
10	The user was logged out because the maximum allotted time for the session was exceeded.
11	The user's request could not be fulfilled because the Cisco SSG is out of memory.
12	The service logon request could not be completed because the home gateway information configured for this service is incomplete.
13	The service logon request failed because no more memory is available in the Cisco SSG to create a tunnel object.
14	The service logon request failed because the supplied username and password could not be authenticated.
15	The service logon request failed because the home gateway for the service was unable to allocate an IP address.
16	The packet destined for the specified service was denied because the user is not allowed to access the service or the service connection is down.
17	The user was logged out of the service because the maximum allotted time for the service session was exceeded.
18	The home gateway for the specified service is no longer available.
19	The user was logged out of the service because the home gateway closed the connection.
20	The service logon request to the specified service failed because the home gateway is unavailable.
21	The user was logged out because it has been idle for more than the maximum allotted time.
22	The user was logged out of the service because the connection to this service has been idle for more than the maximum allotted time.
23	The service logon request failed because the service definition contains no valid Service Route attributes.

Dashboard GUI Localizable Messages

This section describes errors and messages that are sent to users by the Cisco SSD.


Message String	Default Message
AUTHENTICATION_FAILED_MSG	Indicates that authentication failed. The user should check the username and password and try logging on again (default: Authentication failed).
YOU_ARE_ABOUT_TERMINATE_ ALL_SERVICES_MSG	Informs the user that he or she is about to terminate connections to all services (default: You are about to terminate connectivity to all services).
CONTINUE_LOGOFF_QUERY	Prompts the user to log off (default: Do you wish to continue logoff?).
SSG_SERVER_NOT_RESPONDING_ MSG	The Cisco SSG is not responding to requests from the Cisco SSD (default: SSG server not responding).
PLEASE_RELOGON_TO_RESYNCH_ MSG	Prompt requesting the user to log on again to resynchronize with server (default: Please re-logon to attempt resynchronization with server).
PLEASE_RELOGON_MSG	Generic prompt requesting the user to logon again (default: Please re-logon).
SSG_ERRORS_REPORTED_MSG	Preamble to the list of errors reported by the Cisco SSG (default: Errors reported by SSG server).
SESSION_TIMED_OUT_MSG	The user's session exceeded the time specified by the Idle-Timeout attribute (default: Your session has timed out).
ERRORS_ON_WEBSERVER_MSG	Preamble to the list of errors reported by the Cisco SSD (default: Errors reported on web server).
SERVICE_SESSION_LOST_MSG	Generic prompt indicating that the service session ended (default: Service session lost).

Miscellaneous Section

This section contains miscellaneous words and phrases that can be customized or translated.


Message String	Meaning
unknown	Used when an unknown error not listed in this file is generated (default: Unknown Error).
errorPreamble	The textual preamble to an error (default: An error has occurred:). For example, "An error has occurred:" is the preamble to the error message "An error has occurred: XXXX".
error	The local word for "error" (default: error).
postErrorNumberPunctuation	The punctuation that follows a numeric error code. The default is punctuation is a colon (:).
wordForNone	The local word for "none" (default: none).
wordForNoneAllCaps	The local word for "none" in capital letters (default: NONE).
success_msg	Indicates a successful update (default: Updates completed successfully). Used by ConfigAdmin servlet.
cancel_msg	Indicates a cancelled request (default: Request has been cancelled). Used by ConfigAdmin servlet.
authentication_fail	Indicates failed authentication (default: Authentication Failure). Used by ConfigAdmin servlet.
authentication_fail_msg	Indicates the user is not a valid administrator (default: is not a valid administrator). Used by ConfigAdmin servlet.
wordForConfiguration	The local word for "configuration" (default: Configuration). Used by ConfigAdmin servlet.
wordForSorry	The local word for "sorry" (default: Sorry). Used by ConfigAdmin servlet.
no_messages	Indicates the subscriber has no messages from the Message server (default: This subscriber has no outstanding messages). Used by UserMessages servlet
invalid_ip	Indicates the user entered an invalid IP address (default: Please enter a valid IP address of the form '#.#.#.#', where each '#' must be between 0 and 255). Used by UserMessages servlet.
config_msg	Indicates the SSG was unable to load the system configuration file (default: Unable to load the system configuration file).
account_logon_failed	Indicates account logon failed (default: Account logon failed).
account_ping_failed	Indicates account ping failed (default: Account ping failed).
service_logon_failed	Indicates service logon failed (default: Service logon failed).
service_ping_failed	Indicates service ping failed (default: Service ping failed).
vsa_failed	Indicates the SSG failed to build vendor-specific attribute (default: Failed to build vendor-specific attribute).
bad_radius_code	Indicates bad RADIUS code (default: Bad RADIUS code).
bad_radius_id	Indicates a bad RADIUS packet ID (default: Bad RADIUS packet ID).
bad_radius_auth_vector	Indicates a bad RADIUS authentication vector (default: Bad RADIUS authentication vector).
invalid_encryption	Indicates an invalid encryption algorithm (default: Invalid encryption algorithm).
ssg_timeout	Indicates a failed SSG connection (default: Failed to connect to the SSG: retry timeout).
service_retrieval_failed_primary	Indicates the Cisco SSD was unable to retrieve service information from the primary AAA server.
service_retrieval_failed_secondary	Indicates the Cisco SSD was unable to retrieve service information from the secondary AAA server.
group_retrieval_failed_primary	Indicates the Cisco SSD was unable to retrieve service group information from the primary AAA server.
group_retrieval_failed_secondary	Indicates the Cisco SSD was unable to retrieve service group information from the secondary AAA server.
aaa_timeout	Indicates the Cisco SSD was unable to connect to the AAA server.

Servlets File

The servlets file (servlets.conf) cannot be modified.

Table of Contents

Editing the Configuration Files