IBM Cúram User Interface Metadata (UIM) – Important Code

---

Introduction

---

This tutorial provides and explains some important code snippets which are required in developing GUI in Curam, using User Interface Metadata (UIM).

User Interface Metadata(UIM) is an XML dialect used to specify GUI client page contents for Curam applications. It is developed and maintained by IBM. Developing web application client UI pages using UIM is simple and straightforward. Moreover, as UIM is browser independent, developers don’t need to worry about every type of browser the end users may use.

Extension of UIM files are *.uim or *.vim. VIM files typically contain more generic and common code so it can be included within multiple UIM.

Please follow IBM Knowledge Center or my tutorials to learn more about UIM.

 

---

Resolver UIM Pages

---

Resolver pages are very useful in IBM Curam as they help redirect users to the appropriate pages intended only for specific user types/roles, etc. For example–

• A Food Stamp Worker may need to navigate to Food Stamps Page
• Similarly, a Cash Assistance Worker may need to visit Cash Assistance Page

The source of input will be same for all workers. However, relevant to their input/role, the users can navigate to their respective page views.

Example:

As we know, Curam has different types of Participants, such as, Person, Employer, Information Provider, etc. A worker may wish to search for participants from one place. Then by clicking on the Participant Name (HyperLink, obtained as search result) the worker can navigate to the relevant Home Page specifically designed for that participant. As every Participant has its own unique properties to store and display, their home pages need to be different.

Solution: To meet these requirements, Developers need to develop Resolver Pages and configure the home pages for the various participants based on their type. Please find Sample Example given below –

 

<?xml version="1.0" encoding="UTF-8"?>
<PAGE
  PAGE_ID="KWParticipant_resolveRoleHome"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="file://Curam/UIMSchema.xsd"
>
  <JSP_SCRIPTLET>   

      curam.omega3.request.RequestHandler
        rh = curam.omega3.request.RequestHandlerFactory.getRequestHandler(request);

      String context = request.getContextPath() + "/";
      context += curam.omega3.user.UserPreferencesFactory.getUserPreferences(pageContext.getSession()).getLocale() + "/";
      String participantType = request.getParameter("participantType");
      String concernRoleID = request.getParameter("concernRoleID");
      String url = "";

      if(participantType == null) {
       core.ScriptletMissingParamException e = new
                core.ScriptletMissingParamException(-20002, "participantType");
       System.out.println(e);
       throw e;
      }

      if(concernRoleID == null) {
       core.ScriptletMissingParamException e = new
                core.ScriptletMissingParamException(-20002, "concernRoleID");
       System.out.println(e);
       throw e;
      }
    <!--START This part will change as per your Requirement -->
      if(participantType.equals("KRL1")) {
        url = context + "KWPerson_homeXXXPage.do" + "?concernRoleID="
          + curam.omega3.request.RequestUtils.escapeURL(concernRoleID);
      }
      if (participantType.equals("KRL2")) {
          url = context + "KWEmployer_homeXXXPage.do" + "?concernRoleID="
            + curam.omega3.request.RequestUtils.escapeURL(concernRoleID);
      }      
      <!--END This part will change as per your Requirement -->
      url += "&amp;" + rh.getSystemParameters();
      response.sendRedirect(response.encodeRedirectURL(url));
    
  </JSP_SCRIPTLET>
</PAGE>

 

---

Mandatory Fields

---

We can mark fields as mandatory on UIM pages using either of the following approaches.

1. We can use Server Interface and validate the fields before Action bean is called. Exceptions like ‘fields are empty’ or ‘special character’ etc can be thrown subsequently.
2. Also, we can use Curam modeling to mark fields mandatory. In this approach the infrastructure will generate standard validation messages.

We can use curam Domain Definition to restrict minimum and maximum length of the field.

 

Example:

 if ((details.employerAlternateID.length() == 0)
      && (representativeKey.concernRoleID == 0)) {

      curam.core.sl.infrastructure.impl.ValidationManagerFactory.getManager().throwWithLookup(
        new AppException(
          PERSONEMPLOYMENTASSISTANT.ERR_PFV_EMPALTID_EMPTY),
          curam.core.sl.infrastructure.impl.ValidationManagerConst.kSetOne,
          1);
    }

 

---

Drop down Fields With Blank Entry

---

We can display drop down with first row as empty using USE_BLANK="true" attrbiute under Field element. Please find example below –

 <FIELD
      LABEL="Field.Label.Outcome"
      USE_BLANK="true"
      USE_DEFAULT="false"
    >
      <CONNECT>
        <TARGET
          NAME="ACTION"
          PROPERTY="outcome"
        />
      </CONNECT>
    </FIELD>

 

---

Conditional Elements

---

Curam provides rich GUI development tools and features. Using User Interface Metadata, developers can develop user interface with conditional content. please find the example given below –

We can use  <CONDITION> elements to represent text conditionally on the uim page. <CONDITION> element can be used with ACTION_SET, CLUSTER and LIST.   

 

Example:

<?xml version="1.0" encoding="UTF-8"?>
<PAGE PAGE_ID="KWProviderManagement_view"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="file://Curam/UIMSchema.xsd">
    <PAGE_PARAMETER NAME="kwserviceInvoiceID" />
    <SERVER_INTERFACE CLASS="CASSServiceInvoice" NAME="DISPLAY"
        OPERATION="viewServiceInvoiceLineItemInsertion" PHASE="DISPLAY" />    
    <PAGE_TITLE>
        <CONNECT>
            <SOURCE NAME="TEXT" PROPERTY="Page.Title" />
        </CONNECT>
    </PAGE_TITLE>
    <SERVER_INTERFACE CLASS="KWSample" NAME="DISPLAY1"
        OPERATION="listSILICorrections" PHASE="DISPLAY" />
    <CONNECT>
        <SOURCE NAME="PAGE" PROPERTY="kwserviceInvoiceID" />
        <TARGET NAME="DISPLAY1" PROPERTY="key$kwserviceInvoiceID" />
    </CONNECT>
    <INFORMATIONAL>
        <CONNECT>
            <SOURCE NAME="DISPLAY" PROPERTY="result$msgList$dtls$informationMsgTxt" />
        </CONNECT>
    </INFORMATIONAL>    
    <SERVER_INTERFACE CLASS="KWSample" NAME="DISPLAY2"
        OPERATION="listClientDetailsForServiceInvoiceLineItem" PHASE="DISPLAY" />
    <CONNECT>
        <SOURCE NAME="PAGE" PROPERTY="kwserviceInvoiceID" />
        <TARGET NAME="DISPLAY" PROPERTY="key$kwserviceInvoiceID" />
    </CONNECT>    
    <CONNECT>
        <SOURCE NAME="PAGE" PROPERTY="kwserviceInvoiceID" />
        <TARGET NAME="DISPLAY2" PROPERTY="key$kwserviceInvoiceID" />
    </CONNECT>    
    <CLUSTER NUM_COLS="2">        
        <CONDITION>
            <IS_TRUE NAME="DISPLAY" PROPERTY="flag" />
        </CONDITION>
        <FIELD LABEL="Field.Label.ServiceAuthorizationReferenceNumber">
            <CONNECT>
                <SOURCE NAME="DISPLAY" PROPERTY="saReferenceNo" />
            </CONNECT>            
        </FIELD>        
    </CLUSTER>
    <CLUSTER NUM_COLS="2">
        <CONDITION>
            <IS_FALSE NAME="DISPLAY" PROPERTY="flag" />
        </CONDITION>
        <FIELD LABEL="Field.Label.ServiceAuthorizationReferenceNumber">
            <CONNECT>
                <SOURCE NAME="DISPLAY" PROPERTY="saReferenceNo" />
            </CONNECT>
        </FIELD>
    </CLUSTER>
</PAGE>