1. Developing SOA Applications with Oracle SOA Suite
  2. Using the Human Workflow Service Component
  3. Building a Custom Worklist Client
  4. Writing a Worklist Application Using the HelpDeskUI Sample

Writing a Worklist Application Using the HelpDeskUI Sample

Learn how to modify the help desk interface that is part of the HelpDeskRequest demo.

To write a worklist application

  1. Create the workflow context by authenticating the user. 
    // get workflow service client
  IWorkflowServiceClient wfSvcClient =
    WorkflowServiceClientFactory.getWorkflowServiceClient
    (WorkflowServiceClientFactory.REMOTE_CLIENT);
 
//get the workflow context
IWorkflowContext wfCtx =
wfSvcClient.getTaskQueryService().authenticate(userId, pwd, null);

    This is Step 3 in Introduction to Building Clients for Workflow Services.

    The login.jsp file of HelpDeskRequest uses the preceding API to authenticate the user and create a workflow context. After the user is authenticated, the statusPage.jsp file displays the tasks assigned to the logged-in user. This example shows sample code from the login.jsp file. 

    <%@ page import="javax.servlet.http.HttpSession"
         import="oracle.bpel.services.workflow.client.IWorkflowServiceClient"
         import="oracle.bpel.services.workflow.client.WorkflowServiceClientFactory"
         import="java.util.Set"
         import="java.util.Iterator"
         import="oracle.bpel.services.workflow.verification.IWorkflowContext"
         import="oracle.tip.pc.services.identity.config.ISConfiguration"%>
<%@ page contentType="text/html;charset=windows-1252"%>
 
<html>
<head>
<title>Help desk request login page</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
 
<body bgcolor="#F0F0F0" text="#000000" style="font: 12px verdana; line-height:18px">
<center>
<div style="width:640px;padding:15px;border-width: 10px; border-color: #87b4d9; border-style:
 solid;
background-color:white; text-align:left">
 
    <!-- Page Header, Application banner, logo + user status -->
    <jsp:include page="banner.jsp"/>
   
    <!-- Initiate Meta Information -->
 
    <div style="background-color:#F0F0F0; border-top:10px solid white;border-bottom:
      10px solid white;padding:10px;text-align:center" >
    <b>Welcome to the HelpDesk application</b>
    </div>
 
    <% 
     String redirectPrefix =  "/HelpDeskUI/";
      // Ask the browser not to cache the page
      response.setHeader("Pragma", "no-cache");
      response.setHeader("Cache-Control", "no-cache");
 
      HttpSession httpSession = request.getSession(false);
      if (httpSession != null) {
       
        IWorkflowContext ctx = (IWorkflowContext) httpSession.getAttribute("workflowContext");
        if (ctx != null) {
          response.sendRedirect(redirectPrefix + "statusPage.jsp");
        }
        else
        {
          String authFailedStr = request.getParameter("authFailed"); 
          boolean authFailed = false;
          if ("true".equals(authFailedStr))
          {
            authFailed = true;
          }
          else
          {
            authFailed = false;
          }
 
          if (!authFailed)
          {
            //Get page parameters:
            String userId="";
            if(request.getParameter("userId") != null)
            {
              userId = request.getParameter("userId");
            }
            String pwd="";
            if(request.getParameter("pwd") != null)
            {
              pwd = request.getParameter("pwd");
            }
 
            if(userId != null && (!("".equals(userId.trim())))
               && pwd != null && (!("".equals(pwd.trim()))))   
            {
              try {
                HttpSession userSession = request.getSession(true);
 
                IWorkflowServiceClient wfSvcClient =
                        WorkflowServiceClientFactory.getWorkflowServiceClient
                                (WorkflowServiceClientFactory.REMOTE_CLIENT);
                IWorkflowContext wfCtx =
                            wfSvcClient.getTaskQueryService().authenticate(userId, pwd, null);
                httpSession.setAttribute("workflowContext", wfCtx);
                response.sendRedirect(redirectPrefix + "statusPage.jsp");
              }
              catch (Exception e)
              {
                String worklistServiceError = e.getMessage();
                response.sendRedirect(redirectPrefix + "login.jsp?authFailed=true");
                out.println("error is " + worklistServiceError);
              }          
            }
          } else
          {
            out.println("Authentication failed");
          }
        }
      }
    %>
 
    <form action='<%= request.getRequestURI() %>' method="post">
      <div style="width:100%">
      <table cellspacing="2" cellpadding="3" border="0" width="30%" align="center">
        <tr>
          <td>Username
          </td>
          <td>
            <input type="text" name="userId"/>
          </td>
        </tr>
        <tr>
          <td>Password
          </td>
          <td>
            <input type="password" name="pwd"/>
          </td>
        </tr>
        <tr>
          <td>
            <input type="submit" value="Submit"/>
          </td>
        </tr>
      </table>
    </form>
    </div>
</div>
</center>
  </body>
</html>
  2. Query tasks using the queryTask API from TaskQueryService.
    //add list of attributes to be queried from the task
List displayColumns = new ArrayList();
     displayColumns.add("TASKNUMBER");
     displayColumns.add("TITLE");
     displayColumns.add("PRIORITY");
     displayColumns.add("STATE");
     displayColumns.add("UPDATEDDATE");
     displayColumns.add("UPDATEDBY");
     displayColumns.add("CREATOR");
     displayColumns.add("OUTCOME");
     displayColumns.add("CREATEDDATE");
     displayColumns.add("ASSIGNEEUSERS");
     displayColumns.add("ASSIGNEEGROUPS");
     // get the list of tasks
     List tasks =  wfSvcClient.getTaskQueryService().queryTasks
                        (wfCtx,
                        displayColumns,
                        null,
                        ITaskQueryService.AssignmentFilter.MY_AND_GROUP,
                        null,
                        null,
                        null,
                        0,
                        0);
    // create listing page by using above tasks
    //add href links to title to display details of the task by passing taskId
      as input parameter
   Use getTaskDetailsById(IWorkflowContext wftx, String taskId);

    This is Step 4 in Introduction to Building Clients for Workflow Services.

    The statusPage.jsp file of HelpDeskRequest is used to display the status of help desk requests. The code sample below shows the statusPage.jsp. 

    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<%@ page import="oracle.tip.pc.services.identity.BPMAuthorizationService,
                 oracle.bpel.services.workflow.verification.IWorkflowContext,
                 oracle.tip.pc.services.common.ServiceFactory,
                 oracle.bpel.services.workflow.client.IWorkflowServiceClient,
                 oracle.bpel.services.workflow.client.WorkflowServiceClientFactory,
                 oracle.bpel.services.workflow.query.ITaskQueryService,
                 oracle.bpel.services.workflow.task.model.Task,
                 oracle.bpel.services.workflow.task.model.IdentityType,
                 oracle.tip.pc.services.identity.BPMUser,
                 java.util.List,
                 java.util.Calendar,
                 java.text.SimpleDateFormat,
                 java.util.ArrayList"%>
<%@ page contentType="text/html;charset=UTF-8"%>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RequestPage</title>
    <style TYPE="text/css">
      Body, Form, Table, Textarea, Select, Input, Option
      {  
        font-family : tahoma, verdana, arial, helvetica, sans-serif;
        font-size : 9pt;
      }
      table.banner
      {
        background-color: #eaeff5;
      }
      tr.userInfo
      {
        background-color: #eaeff5;
      }
      tr.problemInfo
      {
        background-color: #87b4d9;
      }
    </style>
  </head>
  <body bgcolor="White">
  <%
     HttpSession httpSession = request.getSession(false);
     httpSession.setAttribute("pageType","STATUSPAGE");
  %>
  <table bordercolor="#eaeff5" border="4" width="100%">
    <tr><td> <jsp:include page="banner.jsp"/> </td></tr>
  </table>
  <%
      BPMUser bpmUser = null;
      String redirectPrefix =  request.getContextPath() + "/";
      IWorkflowContext ctx = null;
      if (httpSession != null) {
        
        ctx = (IWorkflowContext) httpSession.getAttribute("workflowContext");
        if (ctx != null) {
            bpmUser = getAuthorizationService(ctx.getIdentityContext()).
                             lookupUser(ctx.getUser());
        }
        else
        {
           response.sendRedirect(redirectPrefix + "login.jsp");
           return;
        }
      }
      else
      {
         response.sendRedirect(redirectPrefix + "login.jsp");
         return;
      }
      if(bpmUser == null)
      {
        response.sendRedirect(redirectPrefix + "login.jsp");
         return;
      }
      String status = (String)httpSession.getAttribute("requeststatus");
      if(status != null && !status.equals(""))
      {
    %>
       <p></p>
       <div style="text-align:left;color:red" >
         <%= status %>
       </div>
    <%    
      }
      httpSession.setAttribute("requeststatus",null);
      IWorkflowServiceClient  wfSvcClient =
                        WorkflowServiceClientFactory.getWorkflowServiceClient(
                                 WorkflowServiceClientFactory.REMOTE_CLIENT);
      List displayColumns = new ArrayList();
      displayColumns.add("TASKNUMBER");
      displayColumns.add("TITLE");
      displayColumns.add("PRIORITY");
      displayColumns.add("STATE");
      displayColumns.add("UPDATEDDATE");
      displayColumns.add("UPDATEDBY");
      displayColumns.add("CREATOR");
      displayColumns.add("OUTCOME");
      displayColumns.add("CREATEDDATE");
      displayColumns.add("ASSIGNEEUSERS");
      displayColumns.add("ASSIGNEEGROUPS");
      List tasks =  wfSvcClient.getTaskQueryService().queryTasks
                        (ctx,
                        displayColumns,
                        null,
                        ITaskQueryService.ASSIGNMENT_FILTER_CREATOR,
                        null,
                        null,
                        null,
                        0,
                        0);
  %>
  <p></p>
  <div style="text-align:left;color:green" >
   <b>
    Previous help desk request
   </b>
  </div>
  <p></p>
  <div style="text-align:center" >
  <table cellspacing="2" cellpadding="2" border="3" width="100%">
     <TR class="problemInfo">
         <TH>TaskNumber</TH>
         <TH>Title</TH>
         <TH>Priority</TH>
         <TH>CreatedDate</TH>
         <TH>Assignee(s)</TH>
         <TH>UpdatedDate</TH>
         <TH>UpdatedBy</TH>
         <TH>State</TH>
         <TH>Status</TH>
     </TR>
     <%
       SimpleDateFormat dflong = new SimpleDateFormat( "MM/dd/yy hh:mm a" );
       for(int i = 0 ; i < tasks.size() ; i ++)
       {
          Task task = (Task)tasks.get(i);
          int taskNumber = task.getSystemAttributes().getTaskNumber();
          String title = task.getTitle();
          int priority = task.getPriority();
          String assignee = getAssigneeString(task);
          Calendar createdDate = task.getSystemAttributes().getCreatedDate();              
          Calendar updateDate =  task.getSystemAttributes().getUpdatedDate();
          String updatedBy = task.getSystemAttributes().getUpdatedBy().getId();
          String state = task.getSystemAttributes().getState();
          String outcome = task.getSystemAttributes().getOutcome();
          if(outcome == null) outcome = "";
          String titleLink = "http://" + request.getServerName() +
                             ":" + request.getServerPort() +
                              "/integration/worklistapp/TaskDetails?taskId=" +  
                              task.getSystemAttributes().getTaskId();
      %>
        <tr class="userInfo">
           <td><%=taskNumber%></td>
           <td><a href="<%=titleLink%>" target="_blank"><%=title%></a></td>
           <td><%=priority%></td>
           <td><%=dflong.format(createdDate.getTime())%></td>
           <td><%=assignee%></td>
           <td><%=dflong.format(updateDate.getTime())%></td>
           <td><%=updatedBy%></td>
           <td><%=state%></td>
           <td><%=outcome%></td>
        <tr>
     <%
       }
     %>
  </table>
  </div>
  <%!
      private BPMAuthorizationService getAuthorizationService(String identityContext)
      {
       BPMAuthorizationService authorizationService =
 ServiceFactory.getAuthorizationServiceInstance();
       if (identityContext != null)
         authorizationService = ServiceFactory.getAuthorizationServiceInstance(identityContext);
 
       return authorizationService;
      }
      private String getAssigneeString(Task task) throws Exception
      {
         List assignees = task.getSystemAttributes().getAssigneeUsers();
         StringBuffer buffer = null;
         for(int i = 0 ; i < assignees.size() ; i++)
         {
           IdentityType type = (IdentityType)assignees.get(i);
           String name = type.getId();
           if(buffer == null)
           {
              buffer = new StringBuffer();
           }
           else
           {
             buffer.append(",");
           }
           buffer.append(name).append("(U)");
         }
         assignees = task.getSystemAttributes().getAssigneeGroups();
         for(int i = 0 ; i < assignees.size() ; i++)
         {
           IdentityType type = (IdentityType)assignees.get(i);
           String name = type.getId();
           if(buffer == null)
           {
              buffer = new StringBuffer();
           }
           else
           {
             buffer.append(",");
           }
           buffer.append(name).append("(G)");
         }
         if(buffer == null)
         {
            return "";
         }
         else
         {
           return buffer.toString();
         }
      }
  %>
 </body>
</html>