15 Integrating UIM Using UIM-Formatted URLs

About id

The id that you specify in the UIM-formatted URL is the sequentially-generated id attribute that uniquely identifies a UIM entity. This is not to be confused with the persistent pattern-generated entityId attribute.

About entity

The entity that you specify in the UIM-formatted URL is the Java class name, so it must be spelled correctly and have no spaces.

For example, this is a valid URL:

http://jsmith:7001/Inventory/faces/adf.task-flow?adf.tfId=MasterFlow&adf.tfDoc=/WEB-INF/MasterFlow.xml&id=102&entity=BusinessInteraction

And this is an invalid URL:

http://jsmith:7001/Inventory/faces/adf.task-flow?adf.tfId=MasterFlow&adf.tfDoc=/WEB-INF/MasterFlow.xml&id=102&entity=Business Interaction

About the InventoryGroup Entity

If you specify InventoryGroup as the entity in the UIM-formatted URL, you must replace id with name and provide the inventory group name because for an inventory group, the name is the unique identifier.

For example:

http://jsmith:7001/Inventory/faces/adf.task-flow?adf.tfId=MasterFlow&adf.tfDoc=/WEB-INF/MasterFlow.xml&name=MyInvGrpName&entity=InventoryGroup

Extending MasterFlow.xml

To extend MasterFlow.xml:

1. Ensure the <visibility> element defines the <url-invoke-allowed> element. For example:

   <visibility id="__7">
       <url-invoke-allowed/>
   </visibility>
   

2. Ensure the <data-control-scope> element value is set to isolated. For example:

   <data-control-scope>isolated</data-control-scope>
   

Extending MasterBean

If you need to access UIM pages other than those listed in Table 15-1, you must extend MasterBean to handle any additional taskflow data or entity data that may be needed to access other UIM pages, construct the UIM-formatted URL accordingly using the additional data, and call the redirect() method with the customized UIM-formatted URL.

To extend MasterBean:

1. View the UIM-formatted URL for the page you want to access to determine what data the custom URL requires:

   1. Log in to UIM.

   2. Navigate to the UIM page you want to access from the external application.

   3. Click Help > Link To to display the UIM-formatted URL.

   4. Study the UIM-formatted URL to determine what data it uses.

2. Create a new custom Java class that extends oracle.communications.inventory.ui.common.bean.MasterBean.

3. Define a static Map named taskFlowMap to store taskflow-related data.

   For example:

   private static final Map<String, TaskFlowModel> taskFlowMap = 
       new HashMap<String, TaskFlowModel>();
   

4. In a static block, define the taskflow for the UIM page you need to access.

   For example, the existing MasterBean logic defines the taskflows for all of the UIM pages listed in Table 15-1, of which Business Interaction is shown here:

   static {
   TaskFlowModel taskFlowModelObj = 
       new TaskFlowModel(BusinessInteraction.class, 
           InventoryUIBundleManager.getLabel("BUSINESS_INTERACTION_SUMMARY"));
   
   taskFlowModelObj.setTaskFlowId("/WEB-INF/oracle/communications/inventory/ui/businessinteraction/flow/BusinessInteractionSummaryFlow.xml#BusinessInteractionSummaryFlow");
   
   taskFlowMap.put("BusinessInteraction", taskFlowModelObj);
   }
   

5. Define an init() method that does the following:

   Note:

   These steps assume your custom code knows the entity type you want to access, and has the id of the entity you want to access.

   1. Use the entity type to get the entity taskflowMap from the static Map that is defined and loaded when the class is created. For example:

      taskFlowModelObj = taskFlowMap.get(entity);
      

   2. Use the entity id to get the entity. For example:

      finder = PersistenceHelper.makeFinder();
      Collection result = null;
      result = finder.findById(taskFlowModelObj.getEntityClass(),id); 
      

   3. Depending on what you determined in step 1, create local variables and populate them with the retrieved taskflow data and retrieved entity data.

      The variables you create depend on the data required for the UIM-formatted URL for the page you want to access. These variables will be used as method input parameters in the next step.

   4. Call your custom getURL() method (as described in step 6, below).

      Pass in the appropriate taskflow data and entity data to construct and return the UIM-formatted URL. For example, the following shows a call to the getURL() method using local variables of taskFlowId, taskKeyList, taskParameterList, taskLabel, and taskType:

      String url = getURL(taskFlowId,taskKeyList,taskParametersList,
                          taskLabel,taskType);
      

   5. Call the javax.faces.context.ExternalContext.redirect() method, passing in the UIM-formatted URL to access the page. For example:

      FacesContext facesContext = FacesContext.getCurrentInstance();
      ExternalContext externalContext = facesContext.getExternalContext();
      externalContext.redirect(url);
      

6. Define a custom getURL() method that:

   1. Defines input arguments that reflect the taskflow-related data and entity data needed to construct the custom UIM-formatted URL.

   2. Constructs the custom UIM-formatted URL using the input argument data.

      See "About the URL Format" for detailed information on the URL format.

   3. Returns a String that is the custom UIM-formatted URL.

   Example 15-2 shows the MasterBean.getCurrentURL() method, which you can use in writing a similar custom getURL() method.

   Example 15-2 MasterBean.getCurrentURL()

   public String getCurrentURL(String navTaskFlowId, String navTaskKeyList, 
                               String navTaskParametersList, String navTaskLabel,
                               String navTaskType) throws Exception 
   {
       try {
           String homePageWebApp = null;
           String homePageViewId = null;
           boolean contextualAreaCollapsed = 
               PatternsConstants.DEFAULT_CONTEXTUAL_AREA_COLLAPSED;
           int contextualAreaWidth = 
               PatternsConstants.DEFAULT_CONTEXTUAL_AREA_WIDTH;
           StringBuffer url = null;
           FacesContext facesContext = FacesContext.getCurrentInstance();
           String urlStr = null;
           urlStr = ControllerContext.getInstance().getGlobalViewActivityURL
                    ("/InventoryUIShell");
    
           int qIndex = urlStr.indexOf('?');
           if (qIndex > -1) {
               urlStr = urlStr.substring(0, qIndex);
           }
    
           url = new StringBuffer(urlStr);
           if (urlStr.indexOf('?') > -1) {
               url.append('&');
           } else {
               url.append('?');
           }
           url.append(MainAreaHandler.FND).append('=');
       
           StringBuffer fndBuffer = new StringBuffer();
           if (navTaskFlowId != null) {
               fndBuffer.append
                   (URLEncoder.encode(navTaskFlowId, MainAreaHandler.UTF_8));
           }
           fndBuffer.append(';');
           if (navTaskParametersList != null) {
               fndBuffer.append
                   (URLEncoder.encode(navTaskParametersList, MainAreaHandler.UTF_8));
           }
           fndBuffer.append(';');
           if (navTaskKeyList != null) {
               fndBuffer.append
                   (URLEncoder.encode(navTaskKeyList, MainAreaHandler.UTF_8));
           }
           fndBuffer.append(';');
           if (navTaskLabel != null) {
               fndBuffer.append
                   (URLEncoder.encode(navTaskLabel, MainAreaHandler.UTF_8));
           }
           fndBuffer.append(';');
           if (navTaskType != null) {
             fndBuffer.append
                 (URLEncoder.encode(navTaskType, MainAreaHandler.UTF_8));
           }
           fndBuffer.append(';');
           fndBuffer.append
               (URLEncoder.encode(String.valueOf(contextualAreaCollapsed),
                MainAreaHandler.UTF_8));
           fndBuffer.append(';');
           fndBuffer.append
               (URLEncoder.encode(String.valueOf(contextualAreaWidth),
                MainAreaHandler.UTF_8));
           url.append
               (URLEncoder.encode(fndBuffer.toString(), MainAreaHandler.UTF_8));
       
           // Get from the model when navigating from the Home Page
           Map<String, Object> viewScopeMap =
               AdfFacesContext.getCurrentInstance().getViewScope();
           DistributedMenuModel homepageMenuModel = 
               (DistributedMenuModel)viewScopeMap.get
                   (PatternsConstants.HOMEPAGE_MENU_MODEL);
           if (homepageMenuModel == null) {
               homepageMenuModel = 
                  (DistributedMenuModel)PatternsUtil.getCurrentDistributedMenuModel
                      (PatternsConstants.HOMEPAGE_MENU_MODEL);
           }
           if (homepageMenuModel != null) {
               ItemNode focusItemNode =
                   PatternsUtil.getFocusItemNode(homepageMenuModel);
               if (focusItemNode != null) {
                   homePageViewId = focusItemNode.getFocusViewId();
                   Map<String, String> customPropList =
                       focusItemNode.getCustomPropList();
                   if (customPropList != null) {
                       homePageWebApp = 
                           customPropList.get(PatternsConstants.WEBAPP_NAME);
                   }
               }
           }
           // Model may not be available when avigating in between Apps pages
           if (homePageViewId == null && homePageViewId == null) {
               homePageWebApp = 
                  (String)viewScopeMap.get(PatternsConstants.WEBAPP_NAME);
               homePageViewId = 
                  (String)viewScopeMap.get(PatternsConstants.HOMEPAGE_VIEW_ID);
           }
           if (homePageViewId != null && homePageWebApp != null) {
               url.append("&").append(PatternsConstants.WEBAPP_NAME).append
               ("=").append(homePageWebApp).append
               ("&").append(PatternsConstants.HOMEPAGE_VIEW_ID).append("=").append
               (URLEncoder.encode(homePageViewId, MainAreaHandler.UTF_8));
           }
           ControllerContext.getInstance().markScopeDirty(viewScopeMap);
           HttpServletRequest request =
              (HttpServletRequest)facesContext.getExternalContext().getRequest();
           String hostnamePort = request.getScheme() + "://" + 
               request.getServerName() + ":" + request.getServerPort();
           String fullUrl = hostnamePort + url.toString();
           return fullUrl;
       }
       finally {
       }
   }
   

Extending TaskFlowModel

The TaskFlowModel logic supports the UIM pages listed in Table 15-1. If you need to access UIM pages other than those listed in Table 15-1, you may need to extend the TaskFlowModel logic to hold any additional taskflow-related data needed to access other UIM pages.

To extend TaskFlowModel:

1. Create a new custom Java class that extends oracle.communications.inventory.ui.common.model.TaskFlowModel.

2. Define additional class variables as needed.

3. For each class variable, define the corresponding get() and set() methods.