You can customize error messages thanks to a file containing these messages.
The file is filled-in by the E-SSO administrator with one message per line, such as: <message number><Tab><message text>.
Example: 0x82002015 <tab> this is the customized text!
However, you can associate one message with several error codes, such as:
<first message number>-<last message number><Tab><message text>.
Moreover, you can write a message text on several lines in the file (this will make the file easier to build and read rather than using \n in the text message). In that case, the syntax of the first line does not change. The next lines must follow this syntax: \+<rest of the text>.
0x82002001-0x8200208F Authentication error!
\+--Access is denied.
For more information on error codes, refer to One Identity EAM Console - Guide de l'administrateur.
The following conditions are mandatory:
NOTE: If the customized text of the message number cannot be retrieved from the file, the default message corresponding to the resource is used.
To define the message file, you must set:
There are two cases to localize and name the message file. When you have:
The search order of a message file is as follows (.<le> is the language extension):
The <language extension> is the Windows number (two-digit hexadecimal value: 09, 0C, 01...) corresponding to the E-SSO installation language.
The following <language extension> list is supported:
The customized messages files must be encoded with ANSI characters. However, you can use files encoded with UTF-8 characters by setting the following registry value: FrameWork\Config\EssoMessageFileUTF8 (REG_DWORD)
The possible values you can set are:
To display an error message, E-SSO performs a sequential search until it finds the customized message associated with the provided error code. If no customized message is set, the default message is used.
To speed up the search and display of an error message, you can activate the error message caching. When the message caching is activated, E-SSO:
To activate the message caching, set the REG_DWORD EssoMessageCacheUsed registry value to 1 under the E-SSO configuration registry keys.