DYNAMIC and INTEGRATED_CASE type menus

The data for both DYNAMIC and INTEGRATED_CASE menu's are driven by the same XML format. An example of the menu data sent by the application server is shown below.

Figure 1. Example of Dynamic MENU Data

<DYNAMIC_MENU>
  <LINK PAGE_ID="CaseHome"
            DESC="2:field1:curam.omega3.myMessages:info_menu1:()"
            TYPE="case" >
    <PARAMETER NAME="caseID" VALUE="1234" />
  </LINK>
  <LINK PAGE_ID="ProductHome"
            DESC="2:field1:curam.omega3.myMessages:info_menu2:()"
        TYPE="product" >
    <PARAMETER NAME="productID" VALUE="5678" />
    <PARAMETER NAME="caseID" VALUE="1234" />
  </LINK>
</DYNAMIC_MENU>

All the menu links are contained within the DYNAMIC_MENU root element. Each entry on the menu is specified by a LINK element. The LINK element has the following attributes:

PAGE_ID : Specifies the target page for the link.
DESC : Specifies the server message catalog entry to be looked up and used as the text for the link. The Cúram SDEJ provides an API to create the string representation of a message catalog entry shown in the example above. Consult the Cúram Server Developers Guide for details on using message catalogs.
TYPE : specifies a value that is looked up in appropriate menu configuration file (described below) to identify the icon that should be associated with the link.

Each LINK element can contain a number of PARAMETER elements that specify additional parameters that will be added to the link from the menu. The PARAMETER element has the following attributes:

NAME : The parameter name.
VALUE : The parameter value.

The configuration files for the DYNAMIC and INTEGRATED_CASE menu's are DynamicMenuConfig.xml and ICDynamicMenuConfig.xml respectively. The following are examples each configuration file.

Figure 2. Example of a DYNAMIC Menu Configuration File

<?xml version="1.0" encoding="UTF-8"?>
<DYNAMIC_MENU_CONFIG>
  <SEPARATOR IMAGE="Images/separator.gif"
             TEXT="Dyn.Menu.Separator"/>
  <LINK TYPE="case" IMAGE="Images/case.gif"
        TEXT="Dyn.View.Case"/>
  <LINK TYPE="product" IMAGE="Images/product-delivery.gif"
        TEXT="Dyn.View.Product"/>
</DYNAMIC_MENU_CONFIG>

Figure 3. Example of an INTEGRATED_CASE Menu Configuration File

<?xml version="1.0" encoding="UTF-8"?>
<INTEGRATED_CASE_MENU_CONFIG>
  <LINK TYPE="case" IMAGE="Images/case.gif"
        TEXT="Dyn.View.Case"/>
  <LINK TYPE="product" IMAGE="Images/product-delivery.gif"
        TEXT="Dyn.View.Product"/>
</DYNAMIC_MENU_CONFIG>

The differences to note are the root elements, DYNAMIC_MENU_CONFIG and INTEGRATED_CASE_MENU_CONFIG, and the SEPARATOR element which is not used in an INTEGRATED_CASE because of its very specific look and feel.

The SEPARATOR element describes an image or a piece of text used to separate the menu items and has the following attributes:

IMAGE : Specifies an image to use as the separator.
TEXT : Specifies an entry in the CDEJResources.properties file. This attribute is mandatory. If an image is specified this will be used as the alternate text for the image, if not, then the text will be displayed.

The LINK element has the following attributes.

TYPE : This must match the TYPE attribute of the LINK element returned from the server application.
IMAGE : Specifies an image to use in the link. This attribute is mandatory.
TEXT : Specifies an entry in the CDEJResources.properties file. This attribute is mandatory. It will be used as the alternate text for the image.