Console modules are packaged as portal application archives (PAA). A portal application archive is similar to a standard JSR 168 portlet WAR file - it includes one or more portlets plus the servlet and portlet descriptors (web.xml and portlet.xml) However, the portal application archive includes two additional descriptors:
When a console module is deployed, Integrated Solutions Console reads these descriptors and uses that information to add the console module to the installation. The XML descriptor files must be well-formed and validate with the associated schemas. If the file is not valid, deployment ends and an error message is generated.
<base:nls-string lang="locale">string</base:nls-string>
<base:nls-ref key="key_name" locationName="path_to_resource_bundle"/>
where path_to_resource_bundle specifies a path relative to the /WEB-INF directory of the module's WAR file. For example, if the resource bundle is located in /WEB-INF/classes/nls/myresources.properties, specify /classes/nls/myresources.
If the resource bundle cannot be located, the key name is returned. That is, if the property string that could not be found is intended to be displayed in the console, the key name would be displayed instead.
<preference name="preference_name"> <base:value> <base:string>preference_value</base:string> </base:value> </preference>The preference value can be specified as a string, NlsString, or NlsRef.
To display the minor version of a product in the Welcome portlet without redeploying, add a Preference attribute to the ibm-portal-topology.xml file of your product. Then provide your own JSP to output the version string. Your JSP will be able to access any class in any of the WAS-embedded JAR files and return the version string.
This method will supersede the versionString specified under ApplicationDefinition element in the ibm-portal-topology.xml file. That method of specifying the version number is also supported.
When using the ibm-portal-topology.xml file to display the minor version of a product, add the preference attribute with name="versionInfoJSP". When you subsequently deploy your application, the component.xml file will be updated to include this information as described below. You would also need to create a JSP, using any name, to contain the version number.
<preference name="versionInfoJSP"> <base:value> <base:string>jsp/xyz.jsp</base:string> </base:value> </preference>The component.xml file would read as follows:
<registry:preference name="versionInfoJSP"> <base:value> <base:string>jsp/xyz.jsp</base:string> </base:value>The contents of xyz.jsp might read as follows:
<%@ page contentType="text/html; charset=UTF-8" %> <%@ page session="false" buffer="none"%> 1.0.0