16 Implement Additional Functions in the UI Shell

1. Expand the Data Controls and select the navigate item, as shown in Figure 16-1.

   Figure 16-1 Selecting navigate from Data Controls

   
2. Drag navigate and drop it onto the page fragment. When you do, the Applications Context menu shown in Figure 16-2 is displayed so you can choose one of the options.

   Figure 16-2 Selecting a Navigate Option from the Applications Context Menu

   

/**
* Navigate from one work space to another. If the current view id is the
* same as the viewId parameter, and if navTaskFlow is null, the current page
* will be refreshed. If the current view id is the same as the viewId
* parameter and if navTaskFlowId is not null, the current page will not
* be refreshed. The Navigate API will delegate to openMainTask API to open the
* task flow in the main area. This can be overriden by passing in
* forcePageRefresh=true in pageParametersList to force the page refresh so
* that openMainTask would not be used.
*
* @param viewId viewId of the target workspace
* @param webApp Deployed Module Name of the target workspace.
*        It only must be set when the target workspace is in a different 
*        deployed module than the origin workspace. When this is null, it means 
*        the target workspace is in the same deployed module of the origin 
*        workspace. The webApp attribute is used to look up the host and port of
*        the associated Workarea or Dashboard from the ASK deployment
*        tables. These tables are populated at deployment time through
*        Oracle Fusion Functional Setup Manager tasks.
* @param pageParametersList Parameters list for the page. This is a semicolon 
*                   delimited String of name value pairs. For example,
*                   "param1=value1;param2=value2"
*                   If the Expression Language expression evaluates to an Object, 
*                   toString value of that Object will be passed as the value of 
*                   the parameter.
*                   When forcePageRefresh=true is added to the pageParametersList,
*                   the current page will be refreshed even if navTaskFlowId
*                   is not null and current view id is the same as viewId
*                   parameter value.
* @param navTaskFlowId Id of the taskFlow to open in the target workspace
* @param navTaskKeyList Key list to pass in to the task flow to open in the
*                   target workspace. This is a semicolon delimited
*                   keys or key-value pairs. For example,
*                   "key1;key2=value2"
* @param navTaskParametersList Parameters list to pass in to the task flow to open
*                   in the target workspace. This is a semicolon delimited String
*                   of name value pairs. For example,
*                   "param1=value1;param2=value2."
*                   When loadDependentFlow=true is added to the
*                   navTaskParametersList, the task flow specified in
*                   navTaskFlowId will be loaded as dependent flow.
* @param navTaskLabel Label for the task flow to open in the target workspace.
* @param methodParameters Construct FndMethodParameters object for setting the 
*                   width of the contextual area, and/or setting the disclosed 
*                   state of the contextual area.
* @throws IOException
*/
public FndMethodParameters navigate(java.lang.String viewId,
                                    java.lang.String webApp,
                                    java.lang.String pageParametersList,
                                    java.lang.String navTaskFlowId,
                                    java.lang.String navTaskKeyList,
                                    java.lang.String navTaskParametersList,
                                    java.lang.String navTaskLabel,
                                    FndMethodParameters methodParameters)
                             throws java.io.IOException

FndMethodParameters methodParameters = new FndMethodParameters();
  methodParameters.setContextualAreaCollapsed(Boolean.FALSE);
  methodParameters.setContextualAreaWidth(200);

FndMethodParameters methodParameters = new FndMethodParameters();
methodParameters.setContextualAreaCollapsed(Boolean.TRUE);
methodParameters.setContextualAreaWidth(200);

FndMethodParameters methodParameters = new FndMethodParameters();
methodParameters.setContextualAreaCollapsed(Boolean.TRUE);
methodParameters.setContextualAreaWidth(200);

FndMethodParameters methodParameters = new FndMethodParameters();
methodParameters.setContextCode("CRM");

FndMethodParameters methodParameters = new FndMethodParameters();
methodParameters.setContextCode("CRM");
methodParameters.setObjectType("Opportunity");

FndMethodParameters methodParameters = new FndMethodParameters();
methodParameters.setContextCode("CRM");
methodParameters.setObjectType("Opportunity");
methodParameters.setObjectName("Opportunity 123");

Navigating across web applications requires the webApp parameter in the menu meta data. For this parameter to work properly, the ApplicationDB and the AppMasterDB connections must be set. The webApp parameter must be specified for each parent node in the menu meta data. Child nodes inherit the value of this parameter from the parent node if not specified. The Navigate API is also modified to add the webApp parameter. Similarly, when using the openSubTask API, you must specify the webApp parameter correctly. There are no design or compile time checks that can catch an invalid value for the webApp parameter. It will throw null pointer exceptions at runtime only.

Note that you need to pass the DEPLOYED_MODULE_NAME in the ASK_DEPLOYED_MODULES table as the webApp parameter. The DEPLOYED_MODULE_NAME, by standard, should be the same as the context root of the application you are trying to open.

To implement warning of pending changes, developers need to follow these steps.

• All the main taskflows that render in MainArea should have the data-control-scope set to isolated.

  <data-control-scope id="dc">
    <isolated/>
  </data-control-scope>
  

• Make changes to the main area.

  Note that inner taskflows and regions inside the main flow can have the data-control-scope set to shared.

  Other than tasklist, if developers are using Data Control APIs, such as openMainTask, closeMainTask or navigate, to relaunch or close a flow in the MainArea, they should add the clientListener to post the changes. Adding the clientListener on a commandButton that is bound to closeMainTask to post pending changes before the currently focused tab/flow is closed is shown in Example 16-3.

  When a command link/button invokes Data Control APIs programmatically, developers should add a client listener on the command link/button, as shown in Example 16-4.

  In addition to adding the clientListener, when Data Control APIs are executed from within the MainArea, developers must add the methodAction shown in Example 16-5 to their main page fragment's pageDef whose taskflow is attached to the tab in MainArea.

  The Data Control API shown in Example 16-5 lets you check for data dirty from within the child region and identify any pending changes in the child region.

  After adding above API to the main page fragment's pageDef, developers should let the UI Shell know about that by sending the parameter "fndCheckDataDirty=true" in the parametersList or navTaskParametersList.

<af:commandButton actionListener="#{bindings.closeMainTask.execute}"
             text="closeMainTask- with - CL"
             disabled="false"
             id="cb1">
      <af:clientListener method="queueActionEventOnMainArea" type="action"/>
</af:commandButton>

<af:commandButton text="Calling datacontrol api programmatically"
         binding="#{backingBeanScope.backing_Navigateviaprogramatically.cb1}"
         id="cb1" action="go">
  <af:clientListener method="queueActionEventOnMainArea" type="action"/>
</af:commandButton>

<methodAction id="checkDataDirty"
     InstanceName="FndUIShellController.dataProvider"
     DataControl="FndUIShellController" RequiresUpdateModel="true"
     Action="invokeMethod" MethodName="checkDataDirty"
     IsViewObjectMethod="false"
     ReturnName="FndUIShellController.methodResults.checkDataDirty_FndUIShellController_dataProvider_checkDataDirty_result"/>

Developers can suppress warning of pending changes for a particular flow by sending the parameter "fndWarnChanges=false" to the parametersList or navTaskParametersList, as shown in Example 16-6.

<methodAction id="openMainTask" RequiresUpdateModel="true"
              Action="invokeMethod" MethodName="openMainTask"
              IsViewObjectMethod="false" DataControl="FndUIShellController"
              InstanceName="FndUIShellController.dataProvider"
              ReturnName="FndUIShellController.methodResults.openMainTask_FndUIShellController_dataProvider_openMainTask_result">
  <NamedData NDName="taskFlowId" NDValue="/WEB-INF/task-flow-definition.xml#task-flow-definition" NDType="java.lang.String"/>
  <NamedData NDName="keyList" NDType="java.lang.String"/>
  <NamedData NDName="parametersList" NDValue="fndWarnChanges=false" NDType="java.lang.String"/>
  <NamedData NDName="label" NDValue="Suppress Warn About Msg" NDType="java.lang.String"/>
  <NamedData NDName="reuseInstance" NDValue="true" NDType="java.lang.Boolean"/>
  <NamedData NDName="forceRefresh" NDValue="true" NDType="java.lang.Boolean"/>
  <NamedData NDName="loadDependentFlow" NDType="java.lang.Boolean"/>
  <NamedData NDName="methodParameters"
  NDType="oracle.apps.fnd.applcore.patterns.uishell.ui.bean.FndMethodParameters"/>
</methodAction>

The following key requirements are supported by the Oracle Fusion UI Shell:

• To conform to Oracle Fusion Applications modularity requirements, the Oracle Fusion Home provides a common entry point across multiple Java EE web applications. A given home page can be hosted on any one of these distinct Java EE web applications. A tab click on a given home page therefore must issue a request for another home page that may be hosted on a different web application. When the new page is displayed, its tab must be visually selected.

• Each home page should display content that includes navigation means to resources that may be hosted on a different web application. For example, a command navigation link on a home page may target a bounded task flow located on a different web application and designed to run on a Workarea or Dashboard page located on that web application.

• A given home page may include content from a bounded task flow (presumably displayed within an ADF region or portlet) that has command navigation links within its view activities. These links or other navigation means must work correctly on the home page. For example, on click, navigate to the correct Workarea page and launch the intended task flow.

• The Home icon in the Global Area will be disabled on all home pages.

• By default, clicking the Home icon will open the Welcome tab and, if a different tab is selected, clicking the Home icon will go back to the last tab that was selected for that session. If, however, the user navigates to any Oracle Fusion page through a direct URL navigation, such as an email that contains a link to a Workarea, the Home icon will again return to the Welcome tab. By default, the Welcome tab will be the first itemNode defined.

• A home page will display the same layout and content in the Global Area and for the page footer as other pages that extend the UI Shell page template. Unlike a Workarea page, however, the intervening content and its layout between the Global (top) and footer (bottom) sections of the page will be determined and provided by product teams.

1. Create a JSPX page that extends UIShell.jspx.
2. From the JSPX page, select the <af:pageTemplate> tag. On the property inspector, set the isHomePage attribute to true. Note that when isHomePage is set to true, the Regional, Local and Contextual Areas of the UI Shell will not be rendered.
3. Add content to the HomePageContent facet, following the ADF Layout Basics guideline for laying out the components.
4. Drop the JSPX to adfc-config.xml.
5. Repeat Steps1 through 4 for all home page JSPX pages.
6. Create the Home Page menu. See Working with the Global Menu Model.
7. When running a home page JSPX, the page should look similar to Figure 16-3.

Figure 16-3 Home Page Example

See Global Area Standard Icons for a description of the icons.

There are two APIs located in the UIShellContext class that you can use to return a URL without actually performing the navigation to the URL:

• getURL : getURL is the same as a navigate call, but it returns the URL as a string instead of doing the navigation. See Example 16-7.

• getURLForCurrentTask : getURLForCurrentTask, shown in Example 16-8, is good for getting the URL of the main area flow in focus so you could send it in an email to someone else. When clicked, it would open the correct workarea (.jspx page) and the correct flow with the correct parameters. If you did have other dynamic tabs open when you called getURLForCurrentTask, it would not open those when clicked.

public java.lang.String getURL(        java.lang.String    viewId,
   java.lang.String webApp,
   java.lang.String pageParametersList,
   java.lang.String navTaskFlowId,
   java.lang.String navTaskKeyList,
   java.lang.String navTaskParametersList,
   java.lang.String navTaskLabel,
FndMethodParameters methodParameters)
throws  java.io.IOException

public java.lang.String getURLForCurrentTask( )
throws  java.io.IOException

The SingleObjectContextArea facet has been added to the UI Shell template for Context Area task flow.

A managed bean entry, shown in Example 16-9, has been added to adfc-config.xml for viewScope Hashmap.

Support for URL parameters defined in the view activity for the page (JSPX) in adfc-config is to be set in the fndPageParams Hashmap defined in viewScope. This Hashmap is also passed onto the pageFlowScope of the task flows in the context area, regional area and main area.

This is accomplished by enabling the Bookmarkable property on the view activity for the page and specifying the URL parameter names with the value set to be added to the fndPageParams Hashmap defined in viewScope. See the "How to Create a Bookmarkable View Activity" section in the Developing Fusion Web Applications with Oracle Application Development Framework.

Product team task flows running in the Single Object Context Workarea must be designed to take in the appropriate context values as input parameters. The pageFlowScope values must be passed to the appropriate input parameters through the parametersList for the item node in the menu or the openMainTask API.

Product teams can cause URL navigation (using the navigate data control method provided by UI Shell by passing required parameters in the pageParametersList) for changing context or updating context information. This will cause the entire page to be refreshed based on new context parameter values.

Product teams can also check for the input parameter values (the context) within the context area task flow. If invalid, a modal dialog can be launched for the end user to choose a context (rendered as links based on the navigate data control method provided by UI Shell) before proceeding.

<managed-bean>
    <managed-bean-name>fndPageParams</managed-bean-name>
    <managed-bean-class>java.util.HashMap</managed-bean-class>
    <managed-bean-scope>view</managed-bean-scope>
  </managed-bean>

The ThirdPartyComponentArea facet should be added within a flexible layout component that will allow you to control the amount of screen real estate that the content added to the facet can consume.

• A facet reference is under the global area content with its width set to 100 percent.

• Add content to this facet.

• You should create a bounded task flow with page fragment for the content and drop it into this facet as a static region. This supports personalization through web composer since the content is within a page template.

• The height property of the panelStretchLayout in the UI Shell template defaults to 33 px. To view or enable the third party component area (see the dark blue area at the top of Figure 14-1), specify the globalAreaHeight property as auto in the pageTemplate property Inspector.

  When the height of the top facet is specified as a CSS length or as auto, this facet will no longer be stretched and instead will consume the initial offsetHeight given to its children by the browser. It is important to note that in an average page, a switch to a layout using automatic heights exhibited a 5- to 10-percent degradation in initial layout speed. Also, an automatic height will cause the facet child to not be stretched both vertically and horizontally.

• You can set the height of the root layout component within the facet to auto to ensure auto-resizing of contents within the facet. Consider a showDetailHeader that is the root element within the facet (in the default view activity for the bounded task flow dropped in as a region). If the height property for this showDetailHeader component is set to auto, collapsing the header would resize the contents and open more real estate in the screen for showing other components in the page.

1. Open the menu metadata menu XML file created in "How to Develop an Activity Guide Client Application Using Oracle UI Shell".
2. Right-click itemNode_<JSF page name> and select Insert inside itemNode_<JSF page name> > itemNode.
3. In the Common Properties window, browse for the name of the JSF page and enter a unique Id for the itemNode property using the standard format <pageID>_<taskFlowName>. For example: ItemNode_MainArea_TaskFlow.
4. Click the Browse button to the right of the focusViewId field. In the Edit Property window that is displayed, select the focusViewId of the page under which you are registering the task flow. Click OK.
5. In the Property Inspector, select the Applications tab and enter a label for the itemNode such as Main Taskflow.
6. From the Project Navigator, select the menu metadata XML file. In the Structure view, select the task flow itemNode – Main Taskflow. In the Property Inspector, enter the following values under the Advanced section:

   • Task Type: defaultMain

   • Task Flow ID: Click the Browse button to display the Select Task Flow ID window and select the location of the task flow definition: /WEB-INF/oracle/bpel/activityguide/ui/taskflows/ag-humantask-task-flow.xml#ag-humantask-task-flow. This is the Id of the main area task flow.

   • Disclosed: Optionally, set this value to false. This property enables opening a new tab when clicking the relevant task link at run time. For tabs, the first defaultMain with disclosed=true is the one that will be in focus.

7. Repeat Steps 1 through 6 for the regional task flow, naming the label and Id accordingly. Provide the following values for the regional task flow in step 6:

   • Task Type: defaultRegional

   • Task Flow ID: Click the Browse button to display the Select Task Flow ID window and select the location of the task flow definition: '/WEB-INF/oracle/bpel/activityguide/ui/taskflows/ag-tasktree-task-flow.xml#ag-tasktree-task-flow. This is the Id of the regional area task flow.

   • Disclosed: Set this value to true for the regional task flow. This property enables opening a new tab when clicking the relevant task link at run time.

8. Create a file called activityguide.properties. If you choose another name then you must provide its value to the ag-tasktree-task-flow using the parameter AGPropsBeanName.

   If using identity propagation to secure the Activity Guide, the properties WorkflowAdminUser and WorkflowAdminPassword are not required.

   You can customize Activity Guides behavior by configuring their properties. To configure these properties you must edit the Activity Guide properties file.

   Table 16-3 shows the properties you can specify in this file.

   Example 16-13 shows a typical Activity Guide properties file:

   Table 16-3 Activity Guide Properties

   Property	Description	Possible Values
   ServerConnectionMode	Specifies the mode for the transmission of data.	SOAP REMOTE
   WorklistHttpURL	Only required when using digital signatures. Specifies the URL to access the Oracle BPM Worklist application.	http://host:port/integration/worklistapp
   SelectionFilter	Specifies the filter used to filter the processes in an activity guide.	MY PREVIOUS REPORTEES ADMIN
   AGDefinitionFilter	Specifies the definition ID used to filter the process in an activity guide. The activity guide only displays those processes that match this ID.	activity guide definition ID
   AGInstanceOrdering	Specifies the order used to display the processes in the activity guide. For example: CREATION_DATE:ASC	column_name:ASC column_name:DESC Default value: ASC
   AGInstanceID	Specifies the instance ID used to display the activity guide tree. For example: 10001	activity guide instance ID
   CustomPredicate1	Specifies an additional predicate to filter the list of processes in an activity guide. For example: CREATOR, EQ, jstein	column name, operator, value
   CustomPredicate2	Specifies a different additional predicate to filter the list of processes in an activity guide. This predicate is used with CustomPredicate1	column name, operator, value
   ShowAllAGTreeNodesProperties	Specifies if the activity guide shows a section at the top that describes the properties of activity guides, milestones and tasks.	true false Default value: true
   ShowRefreshButton	Specifies if the regional area displays a refresh button.	true false Default value: false
   AGTasksPopupTaskFlowID	Specifies the content to display in the task pop-up.	fully qualified TaskFlow ID
   HideAGTreeRootNode	Hides the Guided Business Process title on the Activity Guide Tree root node.	true false Default value: false
   ShowCustomBlockedIcon	Specifies if the Guided Business Process shows the custom task blocked icon.	true false Default value: false

9. In the page definition of Oracle UI Shell JSF fragment page, navigate to pageTemplateBinding and set the Refresh property to ifNeeded.
10. Open the file adfc-config.xml.
11. Edit the file adfc-config.xml to include the location of the activity.properties file. This should be the absolute path to the activityguide.properties file.

    An example adfc-config.xml is shown in Example 16-14.

12. To enable a task flow popup with summary information, add the property AGTasksPopupTaskFlowID to the activityguide.properties file.

    Use this parameter to display a task flow summary in dynamic regions. Enter the relevant task flow Id. If this parameter is not set, the value of OutputText is shown as the default task summary.

13. Create a Workflow Service client configuration file. An example is shown in Example 16-15.
14. Deploy the Activity Guide client application with Oracle UI Shell as described in Deploying an Activity Guide Client Application with Oracle UI Shell to Integrated or in Deploying an Activity Guide Client Application with Oracle UI Shell to Standalone .

#ActivityGuide Properties
ServerConnectionMode=SOAP
SelectionFilter=MY
ShowRefreshButton=true
#ShowAllAGTreeNodesProperties=true
## Sample value for AGDefinitionFilter: default/BPMAGPrj2!2.0*31fcd931-6263-4b58-97cf-6fb084addabc
#AGDefinitionFilter=
#AGInstanceID=110003
#AGInstanceOrdering=CIKEY:DESC
#CustomPredicate1=STATE,EQ,OPEN
#CustomPredicate2=STATUS,EQ,In Progress
## Example Value for  AGTasksPopupTaskflowID is /WEB-INF/ag-popup-task-flow.xml#ag-popup-task-flow
#AGTasksPopupTaskflowID=
#ShowCustomBlockedIcon=true
#HideAGTreeRootNode=false
##WorklistHttpURL is required only for digital signatures
#WorklistHttpURL=http://host:port/integration/worklistapp

<managed-bean>
<managed-bean-name>agProps</managed-bean-name>
<managed-bean-class>
   oracle.bpel.activityguide.ui.beans.model.AGProperties
</managed-bean-class>
<managed-bean-scope>request</managed-bean-scope>
<managed-property>
<property-name>absAgPropsFileName</property-name>
<property-class>java.lang.String</property-class>
<value> <!---absolute path on your machine should be given here-->/activityguide.properties</value>
   <!-- For example:
   Windows: C:\AG\activityguide.properties
   Linux: /scratch/<user>/AG/activityguide.properties
   -->
</managed-property>
</managed-bean>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workflowServicesClientConfiguration xmlns="http://xmlns.oracle.com/bpel/services/client">
  <server default="true" name="default">
      <localClient>
          <participateInClientTransaction>false</participateInClientTransaction>
      </localClient>
      <remoteClient>
          t3://host:port
          <initialContextFactory>weblogic.jndi.WLInitialContextFactory</initialContextFactory>
          <participateInClientTransaction>false</participateInClientTransaction>
      </remoteClient>
      <soapClient>
          http://host:port
          <identityPropagation mode="dynamic" type="saml">
              <policy-references>
                  <policy-reference enabled="true" category="security" uri="oracle/wss10_saml_token_client_policy"/>
              </policy-references>
          </identityPropagation>
     </soapClient>
  </server>
</workflowServicesClientConfiguration>

Securing the Activity Guide client application ensures that only users with proper credentials can complete the tasks outlined in the Activity Guide. Security features include authentication, authorization, realm verification and policy enforcement.

Follow the instructions for securing a Web application as described in the Enabling ADF Security in an Oracle Fusion Web Application section of the Oracle Fusion Middleware Developing Fusion Web Applications with Oracle Application Development Framework.

You can deploy an Activity Guide client application with Oracle UI Shell directly from JDeveloper or to the standalone Oracle WebLogic Server.

1. Define a view object for the translatable table (TL). For more information, see the Defining SQL Queries Using View Objects section in the Oracle Fusion Middleware Developing Fusion Web Applications with Oracle Application Development Framework.

   If the Multi-language support (MLS) coding standard has been followed (see Understanding Multi-Language Support Features), every TL should have an entity object that is linked to an entity object based on the view link (VL) view, but only the VL-based entity object has a view object. To support the Translation Editor, a view object also must be added for the TL entity object. Define a new view object based on the TL entity object. The view object should be the default and should include all attributes in the TL entity object. No other changes are needed. This view object must be added to the Application Module as a child of the VL view object. The translated attributes in this new view object will inherit custom properties fnd:OA_TRANSLATABLE from the TL entity object that should have been set previously.

2. On the new TL view object, define the custom property at the view object level to fnd:OA_TRANSLATION_TABLE = true, as shown here.

   Figure 16-13 Defining A Custom Property

   

   The translated attributes in this new view object will inherit custom properties fnd:OA_TRANSLATABLE from the TL entity object that should have been set previously.

3. Add a view link for the view object. This new TL view object must be a child of the base VL view object. A view link must be defined between the VL view object and the new TL view object.
4. Copy validators from VL entity object to TL entity object. Using the MLS coding standard, only the VL entity object will have any validation; the TL entity object has no validation, it relies on validation in the VL entity object before values are copied to the TL entity object by the OA base classes. This will not be sufficient though if translated values can be updated directly. Any validators on the VL entity object that reference translated attributes must be copied to the TL entity object.
5. Copy control hints from VL entity object to TL entity object. If you did not set the control hints to your TL entity object, add control hints to the TL entity object, for prompt, display length, widget, and so on. These control hints will be used when rendering the Translation Editor. Generally these will be the same control hints as the attributes on the VL entity object, but under some circumstances might be different (for example, display length may be shorter.)
6. Set the display name for the Language and SourceLang attributes. Note that the TL view object needs to join to LanguagePEO so that you get the correct display name for the Language and SourceLang attributes.

   • To do that, you will need to create two entity object associations. One is from your Language attribute to the LanguagePEO.LanguageCode. The other one is from your SourceLang attribute to the LanguagePEO.LanguageCode. For example, the two entity object associations created for this test case are LookupTypeTranslationVOLanguageToLanguagePEO and lookupTypeTranslationVOSourceLangToLanguagePEO.

     Look for LanguagePEO as shown here and add it to the TL view object as an entity object.

     Figure 16-14 Creating Entity Object Associations

     

   • You will need to add it twice. Once for the Language attribute that would use the association LookupTypeTranslationVOLanguageToLanguagePEO and once for the SourceLang attribute that would use LookupTypeTranslationVOSourceLangToLanguagePEO. The two LanguagePEO instances should be named LanguagePEOForLanguage and LanguagePEOForSourceLang.

     Figure 16-15 Adding and Aliasing LanguagePEO Twice

     

   • Add the LanguageDisplayName and SourceDisplayName attributes into your translation view object.

     Figure 16-16 Adding Attributes to Translation View Object

     

     In the translation popup window, you should show the language description instead of the language code, such as American instead of US.

     Note:

     When adding these attributes to the entity object, you must give them the Aliases LanguageDisplayName and SourceLangDisplayName.

     Figure 16-17 Required Aliases for Attributes Added to Entity Object

     

     The LanguageDisplayName and SourceDisplayName attributes now should be included in the TL view object.

     Figure 16-18 Required Attributes Added to TL View Object

     

     Note:

     Set the Query Column Alias of the LanguageDisplayName attribute to LANGUAGE_DISPLAY_NAME. The Translation Editor uses the Language Display Name to set the order when displaying the translation data in the popup. You do not need to set the Query Column Alias for SourceLangDisplayName.

     Figure 16-19 Setting the Query Column Alias of the LanguageDisplayName Attribute

     

This section describes how to add the Translation Editor to an Application Table on an existing JSFF page. If you are creating a new Application Table, skip to How to Add the Translation Editor to New Application Tables During Design Time.

You will use a design time wizard add the Translation Editor to a UI.

For example, if you drag a translatable table (TL) view object instance from the dataControl to an existing ApplicationTable > additionalToolbarButton > af:toolbar or ApplicationTable > f:facet-popup > panelGroupLayout, you can pick the Translation Editor under applications. You can drop the Translation Editor on either facet; the result will be the same.

Note that you can not drag and drop directly onto an ApplicationTable.

This shows an example drag-and-drop of a TL view object onto an ApplicationTable > additionToolbarButton-> af:toolbar.

Figure 16-20 Example Drag-and-Drop of A TL View Object

You also can drag and drop your TL view object onto ApplicationTable > f:facet-popup > panelGroupLayout.

After the drag-and-drop, the Create Translation Popup wizard will open. The wizard will include input for a list of all the columns in the TL view object and you can remove the ones you do not want. The list will show all the attributes in the TL view object, except for Who columns, LANGUAGE, SOURCE_LANG and the Primary Key. You can remove the translation attributes you do not want to display. You also can pick input text field or text region as the type. All other display properties (such as prompts) will be defaulted from control hints on the TL view object.

Figure 16-21 Create Translation Popup Wizard

When you click Continue, designer will add the popup code into your JSFF file. You should not edit anything in the code that is added to your page.

The Application Table Configure Table Patterns wizard has an option for users to choose whether to have the translation editor ability. The View Instances that will be available to enable for the Translation Editor will be those view objects marked with the fnd:OA_TRANSLATION_TABLE custom property (see Model layer changes below). If there are no such view objects, the Translation Editor option will be disabled.

When you click New Page on the Navigator menu, the Create Page wizard displays.

Figure 16-44 Create Page Wizard

Name: Enter a name for the page.

Menu Category Title: Enter a menu category title. The page name will be displayed under this title.

Icon: Click the Search icon to select an icon to represent this page. This step is mandatory and the icon must be selected from the choices presented; a user-supplied icon cannot be used.

Web Page: [Optional] Enter the URL of the application that you wish to host in this page in an iFrame. For example, if you want to run a calculator in your page, you can enter this URL:

http://www.embedcalculator.com/flash/StandardCalculator.swf

This usually is used to create a page where content is coming from another application. This can be a link to a related application, or to a public web site, as shown in the calculator example.

Secure Token: If you need to add a secure token to the URL, click the key icon.

This option is used when you link a menu item to a secure token URL of an application outside Fusion Applications.

An HTTPS protocol is required to access the application.

The secure token expires if the user session is inactive. Refresh the page to regenerate the tokens.

This additional dialog displays:

[image]

Web Application: This is a dropdown menu that shows third-party applications that have been registered in the topology tables. To register an application, use the Register Enterprise Applications task in Setup and Maintenance. Registered content usually includes the protocol (such as http or https), the host, port and context root. This means that the beginning section of the URL can be built from this information.

Destination for Web Application: The destination is anything else to be appended on the URL.

Secure Token Name: [Optional] This can be any name you choose.

For example:

Web Application = "BlueApp"
Destination for Web Application = "/faces/showItem.asp" - The beginning "/" is optional, the design time will insert it if it is not included.
Secure Token Name = "userToken"

When saved, the design time will create a menu node with just a destination field with the following:

destination="#{EndPointProvider.externalEndpointByModuleShortName['BlueApp']}/faces/showItem.asp?userToken=#{applCoreSecuredToken.trustToken}"

At runtime, this could evaluate to:

https://BlueAppsHost:9001/BlueApp/faces/showItem.asp?userToken=9439439432JHU8I53KL88E3 

Click Save and Close.

Click Save and Continue.