Console identity string
You can define a console identity string to be displayed in the console banner and in the browser's title bar. This string can be fixed or you can use a variable that is resolved at run time with a Java system property or environment variable.
The console identity string is rendered differently
in the banner and browser title bar.
- Console identity in the banner The console identity string is displayed in the console banner after the greeting to the console user, separated by a dash. For example, if the identity string is set to
Jupiter
and the user is logged in asconsoleadmin
, the banner displays the following greeting.Welcome consoleadmin - Jupiter
On the login page, the console identity is displayed without the greeting.
- Console identity in the browser title bar The console identity string is displayed in the title bar after the console brand name, separated by a space. For example, if the identity string is set to
Saturn
, the title bar displays the following information.Integrated Solutions Console Saturn
After installation, there are two ways provided to customize the
identity string.
- Use Console Identity in the administrative console. To open, log in to the administrative console and click .
- Set the value for the string in an XML file, consoleProperties.xml,
which is located in app_server_root/profiles/profile_name/config/cell/cell_name/applications/isclite.ear/deployments/isclite/isclite.war/WEB-INF.
You should keep a backup copy of the most recent working consoleProperties.xml before
making changes to this file.
The keys that are used to set the console identity string to be displayed in the banner and title bar are defined in an XML <console-property/> element. The required attributes id and value for this element determine the key name and value pairs. The following initial settings are provided in consoleProperties.xml.
(Some keys are split on multiple lines for printing purposes.)Table 1. Console identity key values. The following table describes the console identity key values. Key (id) Initial setting (value) Description ISC.CONSOLE.ID ISC.CONSOLE.ID.CUSTOM Specifies the ID attribute of another <console-property/> element that contains the actual console identity string ISC.CONSOLE.ID.MAXLEN 27 Specifies the maximum length of the resolved console identity string. The string will be truncated to this length if necessary. ISC.CONSOLE.ID.CUSTOM empty string A custom string to be displayed in the banner and title bar. ISC.CONSOLE.ID.DEPLOYER. unique_suffix
None Specifies a custom string that can be selected using the Console Identity application under System Administration. By providing multiple <console-property/> entries with the
id attribute, you can provide multiple identity strings for console users to select from. Each entry of this type should have a distinct unique_suffix from the other entries. If multiple entries are provided with the same unique_suffix, then only the first value with this suffix is displayed in the selection list for the console user.ISC.CONSOLE.ID.DEPLOYER. unique_suffix
Examples:- In the following example, the deployer wants to create custom
strings that indicate different departments served by their respective
host consoles. Console users will be able to select which identity
is displayed in each department's console interface. To achieve this
goal, the deployer provides the following custom keys in the installation
package. Out of the box, the blank value for ISC.CONSOLE.ID.CUSTOM
is used.
<?xml version="1.0" encoding="UTF-8"?> <consoleproperties:ibm-portal-consoleproperties xmlns:consoleproperties= "https://www.ibm.com/websphere/appserver/schemas/6.0/ibm-portal-consoleproperties.xsd" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "https://www.ibm.com/websphere/appserver/schemas/6.0/ibm-portal-consoleproperties.xsd ibm-portal-consoleproperties.xsd"> <consoleproperties:console-property id="ISC.CONSOLE.ID" value="ISC.CONSOLE.ID.CUSTOM"/> <consoleproperties:console-property id="ISC.CONSOLE.ID.MAXLEN" value="27"/> <consoleproperties:console-property id="ISC.CONSOLE.ID.CUSTOM" value=""/> <consoleproperties:console-property id="ISC.CONSOLE.ID.DEPLOYER.sales" value="Sales & Marketing"/> <consoleproperties:console-property id="ISC.CONSOLE.ID.DEPLOYER.finance" value="Finance"/> <consoleproperties:console-property id="ISC.CONSOLE.ID.DEPLOYER.research" value="Research & Development"/> <consoleproperties:console-property id="ISC.CONSOLE.ID.DEPLOYER.dist" value="Distribution"/> </consoleproperties:ibm-portal-consoleproperties>
- The administrator wants to append information about the host console to the banner and title
bar. This can be accomplished by updating the ISC.CONSOLE.ID.CUSTOM key to include the
PROCESSOR_ARCHITECTURE environment variable (which works on Windows machines) along with the
os.name Java system property. The other keys are
unchanged.
Since the ISC.CONSOLE.ID.MAXLEN key indicates a maximum display of 27 characters, the resulting string, which is resolved at run time, is rendered in the banner as follows for a Windows 2003 Server environment.<?xml version="1.0" encoding="UTF-8"?> <consoleproperties:ibm-portal-consoleproperties xmlns:consoleproperties= "https://www.ibm.com/websphere/appserver/schemas/6.0/ibm-portal-consoleproperties.xsd" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation= "https://www.ibm.com/websphere/appserver/schemas/6.0/ibm-portal-consoleproperties.xsd ibm-portal-consoleproperties.xsd"> <consoleproperties:console-property id="ISC.CONSOLE.ID" value="ISC.CONSOLE.ID.CUSTOM"/> <consoleproperties:console-property id="ISC.CONSOLE.ID.MAXLEN" value="27"/> <consoleproperties:console-property id="ISC.CONSOLE.ID.CUSTOM" value="Platform: %PROCESSOR_ARCHITECTURE% OS: %os.name%"/> </consoleproperties:ibm-portal-consoleproperties>
Platform: x86 OS: Window...
- In the following example, the deployer wants to create custom
strings that indicate different departments served by their respective
host consoles. Console users will be able to select which identity
is displayed in each department's console interface. To achieve this
goal, the deployer provides the following custom keys in the installation
package. Out of the box, the blank value for ISC.CONSOLE.ID.CUSTOM
is used.
Note: After the console identity string is saved, the settings are
applied across the console. For an administrative agent configuration,
this means that the changes are applied to the administrative agent
and all of its registered application servers, regardless of where
the changes were actually saved.