Console module elements - guidelines for unique identifiers

Console module elements - guidelines for unique identifiers

+
Search Tips | Advanced Search

A console module consists of XML descriptors that must provide element identifiers that are unique throughout the application. This topic provides guidelines for setting the these identifiers to help ensure uniqueness. Some development tools, like WebSphere Application Server Toolkit, assign randomly-generated unique names for you. If manage unique names yourself, follow these guidelines.
IBM recommends that product or product suite teams define a naming convention for their console modules. For maximum effectiveness, the conventions should be defined before console modules are developed to allow time for refinement and avoid rework. The following convention provides one guideline that can help manage the unique names for an application.
namespace + module_name + element name + identifier
The identifier is necessary to distinguish different elements in the same descriptor. For example, the following unique names are used in the portal topology descriptor of the TreeMerge sample:
<component-tree         uniqueName="com.ibm.isclite.TreeMerge.appTree"                   ...
<portlet-definition     uniqueName="com.ibm.isclite.TreeMerge.appElementDefinition.A"    ...
<portlet-entity         uniqueName="com.ibm.isclite.TreeMerge.appElement.A"              ...
<portlet-definition     uniqueName="com.ibm.isclite.TreeMerge.appElementDefinition.B"    ...
<portlet-entity         uniqueName="com.ibm.isclite.TreeMerge.appElement.B"              ...
<layout-element         uniqueName="com.ibm.isclite.TreeMerge.layoutElement.A"           ...
<simple-container       uniqueName="com.ibm.isclite.TreeMerge.container.A"               ...
<window                 uniqueName="com.ibm.isclite.TreeMerge.window.A">                 ...
<layout-element         uniqueName="com.ibm.isclite.TreeMerge.layoutElement.B"           ...
<simple-container       uniqueName="com.ibm.isclite.TreeMerge.container.B"               ...
<window                 uniqueName="com.ibm.isclite.TreeMerge.window.B"                  ...
<navigation-element     uniqueName="com.ibm.isclite.treemerge.navigationElement.A"       ...
<navigation-element     uniqueName="com.ibm.isclite.treemerge.navigationElement.B"       ...
<navigation-content     uniqueName="com.ibm.isclite.treemerge.navigationContent.B"       ...
Related information

Creating the descriptors

Reference topic