26 Using Declarative Components and Task Flows

This chapter describes how to use different Oracle Business Rules declarative components and task flows to develop high-performance, interactive, and multitiered applications that are also easy to maintain. It describes how to use the Oracle Business Rules Editor declarative component and the Oracle Business Rules Dictionary Editor declarative component and task flow. It also describes how to localize the ADF-based web application.

This chapter includes the following sections:

Section 26.1, "Introduction to Declarative Components and Task Flows"
Section 26.2, "Using the Oracle Business Rules Editor Declarative Component"
Section 26.3, "Using the Oracle Business Rules Dictionary Editor Declarative Component"
Section 26.4, "Using the Oracle Business Rules Dictionary Editor Task Flow"
Section 26.5, "Localizing the ADF-Based Web Application"
Section 26.6, "Working with Translations"

26.1 Introduction to Declarative Components and Task Flows

Declarative components are reusable, composite user interface (UI) components that comprise other existing Application Development Framework (ADF) Faces components. Consider an application that contains multiple JSF pages. On a particular page, a set of specific components is used in multiple parts of that page. In this scenario, if you make any changes to any of the components in the set, you typically must replicate the changes in multiple parts of the page. This approach makes it difficult to maintain the consistency of the structure and layout of the page. However, by defining a declarative component that comprises the given set of components, you can reuse that composite declarative component in multiple places or pages. Declarative components, thereby, save time and ensure integrity across pages because when you make any changes to the components, the JSF pages using them automatically get updated.

ADF task flows are reusable components that provide a modular and transactional method in specifying the control flow in an application. You can use a set of reusable task flows as an alternative to representing an application as a single large JSF page flow, thereby providing modularity. Each task flow contains a part of the entire navigational plan of the application. The nodes in a task flow are called activities. Apart from navigation, task flow activities can also call methods on managed beans or call another task flow without invoking any particular page. This facilitates reuse because business logic can be invoked independently of the page being displayed.

26.2 Using the Oracle Business Rules Editor Declarative Component

This section discusses the Oracle Business Rules Editor declarative component. It also provides information on how to create and run an application using the Rules Editor component, and then deploy the application. In addition, this section lists the supported tags and the localization process for the application.

26.2.1 Introduction to the Oracle Business Rules Editor Component

The Oracle Business Rules Editor is a declarative component that can be embedded in any ADF-based web application. The component renders the user interface for rules editing and handles all events associated with rules editing. The Rules Editor uses the Rules SDK2 API to create and edit rules.

Note:

You should not confuse the Rules Editor with the Rules Dictionary Editor. The Rules Editor is used to edit rules inside a specified ruleset. In fact, the Rules Editor is embedded within the Rules Dictionary Editor. For more information about the Rules Dictionary Editor, see Section 26.3, "Using the Oracle Business Rules Dictionary Editor Declarative Component."

Using the Rules Editor, you can edit rules and decision tables that are part of a single ruleset. You are required to specify a RuleSetModel object, which is a wrapper around the Rules SDK ruleset object, as a parameter to the Rules Editor component. If multiple rulesets are required to be modified, multiple Rules Editor components must be instantiated, one for each ruleset.

The Rules Editor component performs the following functions:

Creates, updates, and deletes:
- Rules in a ruleset, as shown in Figure 26-1:
  
  Figure 26-1 Rules in a Ruleset
  
  Description of "Figure 26-1 Rules in a Ruleset"
- Simple tests or conditions in a rule, as shown in Figure 26-2:
  
  Figure 26-2 Simple Tests or Conditions in a Rule
  
  Description of "Figure 26-2 Simple Tests or Conditions in a Rule"
- Actions in a rule, as shown in Figure 26-3.
  
  Figure 26-3 Actions in a Rule
  
  Description of "Figure 26-3 Actions in a Rule"
- Decision tables, as shown in Figure 26-4.
  
  Figure 26-4 Decision Tables
  
  Description of "Figure 26-4 Decision Tables"
Sets effective dates and priorities for rulesets and rules.
Provides support for user-defined operators.
Provides a Condition Browser pop-up to display the left or right value options, as shown in Figure 26-5.

Figure 26-5 Condition Browser

Description of "Figure 26-5 Condition Browser "
Provides a Date Browser for selecting date types, as shown in Figure 26-6.

Figure 26-6 Date Browser

Description of "Figure 26-6 Date Browser"
Provides a Right Operand browser to handle multiple right-hand side expressions, as shown in Figure 26-7.

Figure 26-7 Right Operand Browser

Description of "Figure 26-7 Right Operand Browser"
Provides support for nested rules, as shown in Figure 26-8.

Figure 26-8 Nested Rules Support

Description of "Figure 26-8 Nested Rules Support"
Provides the Properties browser for editing properties of a rule action, as shown in Figure 26-9.

Figure 26-9 Properties Browser

Description of "Figure 26-9 Properties Browser"
Provides an Expression Builder window to build custom expressions, as shown in Figure 26-10.

Figure 26-10 Expression Builder Window

Description of "Figure 26-10 Expression Builder Window"
Provides Advanced Mode features for working with patterns and advanced actions, as shown in Figure 26-11.

Figure 26-11 Advanced Mode Features

Description of "Figure 26-11 Advanced Mode Features"
Provides a Validation panel to manage error messages, as shown in Figure 26-12.

Figure 26-12 Validation Panel to Manage Error Messages

Description of "Figure 26-12 Validation Panel to Manage Error Messages"

Note:

Once all the edits are done, the component user is responsible for saving the ruleset.

26.2.2 How to Create and Run a Sample Application by Using the Rules Editor Component

This section lists the steps for creating and running a sample application by using the Rules Editor component.

The prerequisite for using the Rules Editor component to create ADF-based web applications is having a running installation of Oracle SOA Suite and Oracle JDeveloper on your computer.

To create a sample application by using the Rules Editor:

The first task is to create a sample application.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New and then Generic Application to create an application.
Enter a name for the application in the Application Name field, for example, useRulesDCApp, and click Next as shown in Figure 26-13.

Figure 26-13 Creating a Generic Application

Description of "Figure 26-13 Creating a Generic Application"
Enter useRulesDC in the Project Name field and ensure that ADF Faces is selected in the Project Technologies tab, as shown in Figure 26-14.

Figure 26-14 Creating a Project

Description of "Figure 26-14 Creating a Project"
Click Finish to create the project.
Right-click the useRulesDC project in the Application Navigator of Oracle JDeveloper, and select Project Properties to display the Project Properties dialog box.

In the Project Properties dialog box:
1. Click JSP Tag Libraries from the left panel.
2. Click Add and select ADF Faces Components from the Extension list in the Choose Tag Libraries dialog box, and click OK as shown in Figure 26-15.
  
  Figure 26-15 Choosing Tab Libraries
  
  Description of "Figure 26-15 Choosing Tab Libraries"
3. Click Libraries and Classpath from the left panel and click the Add Library button to display the Add Library dialog box.
4. Click Oracle Rules and Oracle Rules Editor Component from the Extension list, and then click OK as shown in Figure 26-16.
  
  Figure 26-16 Selecting Oracle Rules and Rules Editor Component
  
  Description of "Figure 26-16 Selecting Oracle Rules and Rules Editor Component"
  
  This adds the Rules SDK and the Rules Editor Component tag libraries to the project.
5. Click OK to close the Project Properties dialog box.
Select Save All from the Oracle JDeveloper File menu to save the project.

You have to ensure that all the required tag libraries are added:

Right-click the useRulesDC project in the Application Navigator of Oracle JDeveloper and select Project Properties to display the Project Properties dialog box.
Click JSP Tag Libraries from the left panel and check if all the tag libraries are added, as shown in Figure 26-17.

Figure 26-17 Checking the Required Tag Libraries

Description of "Figure 26-17 Checking the Required Tag Libraries"

To create the RuleSetModel object:

The Rules Editor component requires a oracle.bpel.rulesdc.model.impl.RuleSetModel object. The component uses this object to read the rules and the decision tables that exist in the ruleset. Therefore, the next task is to create a managed bean called SomeBean.java that creates a RuleSetModel object.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New to display the New Gallery dialog box.
In the New Gallery dialog box, select Java under General from the Categories panel.
Ensure that Java Class under Items is selected and click OK to display the Create Java Class dialog box.
Enter the name of the Java class, for example SomeBean.java, and click OK to create the Java class in your project, as shown in Figure 26-18.

Figure 26-18 Creating a Java Class

Description of "Figure 26-18 Creating a Java Class"

In SomeBean.java, provide a method that returns the RuleSetModel object. You must specify the location of the rules file here. The following is a sample of the SomeBean.java file:

package userulesdc;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Reader;

import java.io.Writer;

import java.util.ArrayList;
import java.util.List;

import oracle.bpel.rulesdc.model.impl.RuleSetModel;
import oracle.rules.sdk2.dictionary.RuleDictionary;
import oracle.rules.sdk2.exception.SDKException;
import oracle.rules.sdk2.exception.SDKWarning;
import oracle.rules.sdk2.ruleset.RuleSet;
import oracle.rules.sdk2.ruleset.RuleSetTable;

public class SomeBean {
    private static final String RULES_FILE = "<your rules file here>";
    private RuleSetModel ruleSetModel = null;

    public RuleSetModel getRuleSetModel() {
        if (ruleSetModel != null)
            return ruleSetModel; 
            //cache ruleSetModel instead of re-creating it each time

         Reader reader = null;
        try {
            reader =
                    new FileReader(new File(RULES_FILE));
        } catch (FileNotFoundException e) {
            //LOG.severe(e);
            System.err.println(e);
        }

        RuleDictionary dict = null;

        try {
            dict = RuleDictionary.readDictionary(reader, null);
        } catch (SDKException e) {
            System.err.println(e);
        } catch (FileNotFoundException e) {
            System.err.println(e);
        } catch (IOException e) {
            System.err.println(e);
        }
        if (reader != null) {
            try {
                reader.close();
            } catch (IOException ioe) {
            }
        }

        //get the ruleSetTable from the RuleDictionary object
        RuleSetTable ruleSetTable = dict.getRuleSetTable();

        //get the first ruleSet from the ruleSetTable
        RuleSet ruleSet = ruleSetTable.get(0);
        //create a RuleSetModel object and pass this to the rulesDC

        ruleSetModel = new RuleSetModel(ruleSet) ;
        return ruleSetModel;
    }

     //refer to Rules SDK documentation for saving a dictionary also
     //because this code does not take care of saving linked dictionaries
     public static boolean saveDictionary(RuleDictionary dict,
                                         String ruleFileName) {
        Writer writer = null;
        try {
            writer = new FileWriter(new File(ruleFileName));
            dict.writeDictionary(writer);

        } catch (SDKException e) {
            System.err.println(e);
            return false;
        } catch (FileNotFoundException e) {
            System.err.println(e);
            return false;
        } catch (IOException e) {
            System.err.println(e);
            return false;
        } finally {
            if (writer != null) {
                try {
                    writer.close();
                } catch (IOException ioe) {
                    return false;
                }
            }
        }
        return true;
    }

    public static void updateDictionary(RuleDictionary dict) {
        if (dict == null)
            return;

        List<SDKWarning> warnings = new ArrayList<SDKWarning>();
        try {
            dict.update(warnings);
            if (!warnings.isEmpty()) {
                for (int i = 0; i < warnings.size(); i++)
                    System.out.println("warnings: " +
                                       warnings.get(i).getLocalizedMessage());
            }
        } catch (SDKException sdkEx) {
            sdkEx.printStackTrace();
        }
    }

    //You can call this method from your "Save" button
    public void saveDictionary() {

     RuleDictionary dict = this.getRuleSetModel().getRuleSet().getDictionary();
        if (dict != null) {
            //update the dictionary before saving it
            updateDictionary(dict);
            saveDictionary(dict, RULES_FILE);
        }
    }

//call the validation method on the ruleSetModel to update the Validation Panel 

    public void validate() {
        if (this.ruleSetModel == null)
            return;
        
        this.ruleSetModel.validate();

Open the faces-config.xml file in Overview mode and click the + button under Managed Beans to display the Create Managed Bean dialog box.
Point to SomeBean.java by entering someBean in the Bean Name field and selecting session from the Scope list, as shown in Figure 26-19.

Figure 26-19 Specifying the Bean Name and Scope

Description of "Figure 26-19 Specifying the Bean Name and Scope"

The ADF/JSF framework makes multiple calls to SomeBean.java to render the user interface. For example, someBean.ruleSetModel is called multiple times. So, it is better to create the RuleSetModel object once, cache it, and return it each time instead of re-creating it.

To create the .jspx file for the Rules Editor Component tag:

The next task is to create the .jspx file to include the Rules Editor component tag.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New to display the New Gallery dialog box.
In the New Gallery dialog box, select JSF under Web Tier from the Categories panel.
Select JSF Page under Items and click OK to display the Create JSF Page dialog box.
In the Create JSF Page dialog box, enter useRulesDC.jspx as the file name, as shown in Figure 26-20.

Figure 26-20 Creating the JSF Page File

Description of "Figure 26-20 Creating the JSF Page File"

RulesCompLib is displayed in the Component Palette of Oracle JDeveloper as shown in Figure 26-21.

Figure 26-21 Rules Editor Component Library in the Component Palette

Description of "Figure 26-21 Rules Editor Component Library in the Component Palette"

This is because you have added the Rules Editor Component tag library when creating the sample application.

Select RulesCompLib to view the Rulesdc tag. You can drag and drop the Rulesdc tag into the .jspx file. You can also add the Rulesdc tag in the .jspx file manually as shown:

<?xml version='1.0' encoding='UTF-8'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" version="2.1"
          xmlns:f="http://java.sun.com/jsf/core"
          xmlns:h="http://java.sun.com/jsf/html"
          xmlns:af="http://xmlns.oracle.com/adf/faces/rich"
          xmlns:rdc="http://xmlns.oracle.com/bpel/rules/editor">
  <jsp:directive.page contentType="text/html;charset=UTF-8"/>
  <f:view>
     <af:document title="Sample Rules Editor App" id="d1">
      <af:form id="f1">
        <af:panelStretchLayout id="psl1" inlineStyle="margin:15px;"
                               partialTriggers="cb1 cb3">
          <f:facet name="center">
            <rdc:rulesdc rulesetModel="#{someBean.ruleSetModel}"
                         viewOnly="false" discloseRules="true"
                         genericAction="true" genericPattern="true"
                         dtColumnPageSize="6" id="r1" dateStyle="yyyy-MM-dd"
                         timeStyle="HH-mm-ss"></rdc:rulesdc>
          </f:facet>
          <f:facet name="top">
            <af:panelGroupLayout id="pgl2" layout="horizontal">
              <af:commandButton text="Save Dictionary"
                                action="#{someBean.saveDictionary}" id="cb1"/>
              <af:spacer width="10" height="10" id="s5"/>
              <af:commandButton text="Validate" id="cb3"
                                action="#{someBean.validate}"
                                partialSubmit="true"/>
            </af:panelGroupLayout>
          </f:facet>
        </af:panelStretchLayout>
      </af:form>
    </af:document>
  </f:view>
</jsp:root>

To refer to the oracle.rules and the oracle.soa.rules_editor_dc.webapp shared libraries:

After creating the .jspx file, you must refer to the oracle.rules and oracle.soa.rules_editor_dc.webapp shared libraries from the weblogic-application.xml file.

The steps are:

In Oracle JDeveloper, open the weblogic-application.xml file by browsing to Application Resources, then Descriptors, and then META-INF.
Add the following lines to refer to the oracle.rules shared library as shown in Figure 26-22.
```
<library-ref>
<library-name>oracle.rules</library-name>
</library-ref>
```
Figure 26-22 Referring to the oracle.rules Shared Library

Description of "Figure 26-22 Referring to the oracle.rules Shared Library"
In Oracle JDeveloper,
1. From the File menu, select New to display the New Gallery dialog box.
2. In the New Gallery dialog box, select Deployment Descriptors under General from the Categories panel.
3. Select Weblogic Deployment Descriptor under Items and click OK to display the Create Weblogic Deployment Descriptor dialog box.
4. Select weblogic.xml from the list and click Finish.
5. In Oracle JDeveloper, in the Overview mode of weblogic.xml, select Libraries from the left panel.
6. Enter oracle.soa.rules_editor_dc.webapp as the library name, as shown in Figure 26-23.
  
  Figure 26-23 Adding the Rules Editor Component Library
  
  Description of "Figure 26-23 Adding the Rules Editor Component Library"
7. Click Save All.
Deploy the oracle.rules shared library to the embedded Oracle WebLogic Server:
1. Launch the Oracle WebLogic Server Administration Console (http://host:port/console/login/LoginForm.jsp).
2. Ensure that the Weblogic embedded server on Oracle JDeveloper is running.
3. Select Deployments and click Install to display the Install Application Assistant page.
4. Select the following and click Finish, as shown in Figure 26-24.
```
JDEV_INSTALL/jdeveloper/soa/modules/oracle.rules_11.1.1/rules.jar
```
  Figure 26-24 Deploying the oracle.rules Shared Library
  
  Description of "Figure 26-24 Deploying the oracle.rules Shared Library"
Deploy the oracle.soa.rules_editor_dc.webapp shared library to Oracle WebLogic Server:
1. In the Weblogic console, select Deployments and click Install to display the Install Application Assistant page.
2. Select the following and click Next.
```
JDEV_INSTALL/jdeveloper/soa/modules/oracle.soa.rules_editor_dc.webapp_
11.1.1/oracle.soa.rules_editor_dc.webapp.war
```
3. Select Install this deployment as a library and click Finish, as shown in Figure 26-25.
  
  Figure 26-25 Deploying oracle.soa.rules_editor_dc.webapp Shared Library
  
  Description of "Figure 26-25 Deploying oracle.soa.rules_editor_dc.webapp Shared Library "
  
  oracle.soa.rules_editor_dc.webapp is added to the list of deployments as shown in Figure 26-26.
  
  Figure 26-26 oracle.soa.rules_editor_dc.webapp Added to the Deployment List
  
  Description of "Figure 26-26 oracle.soa.rules_editor_dc.webapp Added to the Deployment List"

To run the sample Rules Editor application:

The last task is running the sample application.

To run the sample application, from Oracle JDeveloper, right-click the useRulesDC.jspx file.
Select Run.

This starts the sample application on a web browser, as shown in Figure 26-27.

Figure 26-27 Running the Sample Application

Description of "Figure 26-27 Running the Sample Application"

26.2.3 How to Deploy a Rules Editor Application to a Standalone Oracle WebLogic Server

When you are ready to deploy your application EAR file to the standalone Oracle WebLogic Server, perform the following:

Launch the Oracle WebLogic Server Administration Console (http://host:port/console/login/LoginForm.jsp).
Ensure that oracle.rules is displayed in the deployments list.
Ensure that oracle.soa.rules_editor_dc.webapp is displayed in the deployments list.

If this is not displayed, click Install and select the following file:

JDEV_INSTALL/jdeveloper/soa/modules/oracle.soa.rules_editor_dc.webapp_
11.1.1/oracle.soa.rules_editor_dc.webapp.war

Open Oracle JDeveloper.
Right-click the project name in the Application Navigator and select Project Properties.
Select Libraries and Classpath from the left panel and click Add Library.
In the Add Library dialog box, select Oracle Rules Editor Component and click OK, as shown in Figure 26-28.

Figure 26-28 Adding the Oracle Rules Editor Component

Description of "Figure 26-28 Adding the Oracle Rules Editor Component"

This step enables you to refer to these libraries, but does not deploy these libraries by default. Therefore, the JARs are not included in your project WAR file.
In the project that has to be deployed (where you create the EAR file):
1. Add the following lines to the weblogic-application.xml:
```
<library-ref>
   <library-name>oracle.rules</library-name>
</library-ref>
```
2. Add the following lines to weblogic.xml in the project WAR file:
```
<library-ref>
   <library-name>oracle.soa.rules_editor_dc.webapp</library-name>
</library-ref>
```
3. Deploy the EAR file in the Oracle WebLogic Server.

For more information about creating an EAR file, see "How to Create an EAR File for Deployment" in Oracle Fusion Middleware Java EE Developer's Guide for Oracle Application Development Framework.

26.2.4 What You May Need to Know About the Custom Permissions for the Rules Editor Component

For role-based authorization, Rules DC implements custom JAAS permissions (extending the oracle.adf.share.security.authorization.ADFPermission class to ensure that the permission can be used by ADF security).

If a Rules Editor application supports ADF security, which means there is support for role-based authentication and authorization, then security is enforced by implementing custom JAAS permissions (by extending the oracle.adf.share.security.authorization.ADFPermission class to ensure that the permission can be used by ADF security). You have to create ADF security policies by granting the following permissions to the user roles based on your application requirement:

oracle.rules.adf.permission.AddRulePermission: Displays the Add Rule button; if the permission is not granted, the Add Rule button is not visible to the user.
oracle.rules.adf.permission.DeleteRulePermission: Displays the Delete Rule button; if the permission is not granted, the Delete Rule button is not visible to the user.
oracle.rules.adf.permission.EditRulePermission: Displays the Edit Rule button for rules inside a ruleset; if the permission is not granted, then the rules are view-only.
oracle.rules.adf.permission.AddDTPermission: Displays the Add Decision Table button; if the permission is not granted, the Add Decision Table button is not visible to the user.
oracle.rules.adf.permission.DeleteDTPermission: Displays the Delete Decision Table button; if the permission is not granted, the Delete Decision Table button is not visible to the user.
oracle.rules.adf.permission.EditDTPermission: Displays the Edit Decision Table button for decision tables within a ruleset; if the permission is not granted, the decision tables are view-only.
oracle.rules.adf.permission.RulesEditorPermission: A global permission that sets all the preceding permissions to true.

For example, to grant the delete rule permission to a role, specify the following code in the jazn-data.xml file of the application:

<grant>
  <grantee>
     <principals>
      <principal>
       <class>oracle.security.jps.service.policystore.ApplicationRole</class>
       <name>role2</name>
      </principal>
     </principals>
   </grantee>
   <permissions>
    <permission>
      <class>oracle.rules.adf.permission.DeleteRulePermission</class>
      <name>DeleteRulePermission</name>
      <actions>access</actions>
    </permission>
  </permissions>
</grant>

If you do not want to use the individual permissions, such as AddRulePermission or DeleteRulePermission, you can set the RulesEditorPermission in the jazn-data.xml file to set global permissions.

26.2.5 What You May Need to Know About the Supported Tags of the Rules Editor Component

This section lists the tags and attributes that are supported by the Rules Editor component.

Table 26-1 lists the supported facets.

Table 26-1 Supported Facets of the Rules Editor Component

Name	Description	Comments
`patternDisplay`	Used to render specific user interfaces. This facet is used to display the rule condition and pattern (in advanced mode), which is the `IF` portion of the rule.	Deprecated for release 11.1.1.7. Will be removed in 12c.
`actionDisplay`	Used to render specific user interfaces. This facet is used to display the rule action, which is the `THEN` portion of the rule.	Deprecated for release 11.1.1.7. Will be removed in 12c.

Table 26-2 lists the supported attributes.

Table 26-2 Supported Attributes of the Rules Editor Component

Name	Type	Required	Default Value	Supports EL?	Description
`dateStyle`	`java.lang. String`	no	Gets from the locale	yes	If specified, the date style is used in all `inputDate` components (for example, `yyyy.MM.dd`).
`decimalSeparator`	`java.lang. Character`	no	Based on locale	yes	Specifies the decimal separators. This is used in number formatting. If specified, this attribute overrides the decimal separator based on locale.
`disableRuleSetName`	`java.lang. Boolean`	no	`false`	yes	If `true`, the editable ruleset name is disabled. This attribute is used only when `displayRuleSetName` is set to `true`.
`discloseRules`	`java.lang. Boolean`	no	`false`	yes	If `true`, all the rules in the ruleset are expanded. If `false`, all the rules are collapsed. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `ifThenPreferences` attribute and override `isDiscloseRules()`.
`displayRuleSetEffDate`	`java.lang. Boolean`	no	`true`	yes	If `true`, the Rules Editor component renders the user interface for displaying the effective dates for the ruleset.
`displayRuleSetName`	`java.lang. Boolean`	no	`true`	yes	Displays the editable ruleset name by default. You can choose to hide this by setting it to `false`.
`dtAddActionMenuDDC`	`java.lang.String`	no		yes	Used only when `genericDTAddActionMenu` is true. Pass the DDC (dynamic declarative component) including the context path that specifies the add menu items in the decision table toolbar. For example, /userulesdc/decisiontable/dtAddActionMenu.jsff. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `getDtAddActionMenuDDC()`.
`dtActionNameCustomizer`	oracle.bpel.rulesdc .model.interfaces.A ctionNameCustomizer	no		yes	Used to specify the action name and action parameter name in the decision table header. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `getDtActionNameCustomizer()`.
`dtActionParamCellDDC`	`java.lang.String`	no		yes	Used only when `genericDTActionParam` is true. Consumer must pass the DDC (dynamic declarative component) including the context path that specifies the UI to be displayed in the action parameter cell of the decision table. For example, /userulesdc/decisiontable/actionParamCell.jsff. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `getDtActionParamCellDDC()`.
`dtEditActionDDC`	`java.lang.String`	no		yes	Used only when `genericDTEditAction` is true. Consumer must pass the DDC (dynamic declarative component) including the context path that specifies the action UI to be displayed in the action editor browser that shows up when an action row is edited in the decision table. For example, /userulesdc/decisiontable/actionEditor.jsff. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `getDtEditActionDDC()`.
`dtColumnPageSize`	`java.lang. Integer`	no	5	yes	Specifies the number of columns to be displayed at a time in a decision table. This works only when rules are columnar. Deprecated for release 11.1.1.7. Will be removed in 12c.
`dtHeight`	`java.lang. Integer`	no	`16`	yes	Number of rows to be displayed at a time in the decision table. A scroll bar is displayed if the number of rows increases over the specified height. Deprecated for release 11.1.1.7. Will be removed in 12c.
`dtPreferences`	oracle.bpel.rulesdc .model.decisiontabl e.interfaces.Decisi onTablePrefs	no	oracle.bpel .rulesdc.mo del.decisio ntable.impl .DecisionTa blePrefsImp l	yes	Used to specify decision table preferences. Consumers can extend the following default implementation and override only the required preferences: oracle.bpel.rulesdc .model.decisiontabl e.impl.DecisionTabl ePrefsImpl
`genericAction`	j`ava.lang. Boolean`	no	`true`	yes	If `true`, the Rules Editor component renders the user interface for displaying the `THEN` part, which is actions. If `false`, then the `actionDisplay` facet must be passed to the Rules Editor component. The facet must contain the user-defined user interface. The facet has access to the `ActionModel`. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `ifThenPreferences` attribute and override `isGenericAction()`.
`genericDTAddActionMenu`	`java.lang.Boolean`	no	`true`	yes	If `true`, a generic add action menu is displayed in the decision table toolbar. If `false`, specify the add action menu using `dtAddActionMenuDDC` attribute. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `isGenericDTAddActionMenu()`.
`genericDTActionParam`	`java.lang.Boolean`	no	`true`	yes	If `true`, generic UI is displayed in the action parameter cell of the decision table. If `false`, specify the action parameter cell UI using the `dtActionParamCellDDC` attribute. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `isGenericDTActionParam()`.
`genericDTEditAction`	`java.lang.Boolean`	no	`true`	yes	If `true`, generic action UI is displayed in the action editor browser that shows up when an action row is edited in the decision table. If `false` specify the edit action UI using the `dtEditActionDDC` attribute. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `isGenericDTEditAction()`.
`genericPattern`	`java.lang. Boolean`	no	`true`	yes	If `true`, the Rules Editor component renders the user interface for displaying the `IF` part, which is conditions and patterns (in advanced mode). If `false`, then the `patternDisplay` facet must be passed to the Rules Editor component. The facet must contain the user-defined user interface. The facet has access to the `RuleModel` and `SimpleTestModel`.
`groupingSeparator`	`java.lang. Character`	no	Based on Locale	yes	Specifies the grouping separators. This is used in Number Formatting. If specified, this attribute overrides the grouping separator based on locale.
`ifThenPreferences`	oracle.bpel.rulesdc .model.interfaces.I fThenPreferences	no	oracle.bpel .rulesdc.mo del.impl.If ThenPrefere ncesImpl	yes	Used to specify IF/THEN UI preferences. Consumers can extend the following default implementation and override only the required preferences: oracle.bpel.rulesdc .model.impl.IfThenP referencesImpl
`locale`	`java.util. Locale`	no	`Locale.getDefault()`	yes	Used for Localization
`resourceManager`	oracle.bpel.rulessh areddc.model.interf aces.ResourceManage rInterface	no		yes	Used to specify the resource manager for translations UI. For information see, Section 26.6, "Working with Translations".
`ruleModel`	`java.lang. String`	no	oracle. bpel.rulesd c.model. impl. RuleModel	yes	Used to customize the default `RuleModel`. You can extend the `RuleModel` class to override certain methods. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `ifThenPreferences` attribute and override `getRuleModel()`.
`rulesetModel`	oracle.bpel. rulesdc.model. interfaces. RuleSetInterface	yes	-	Only EL	Wrapper around the Rules SDK ruleset object.You can use the `RuleSetModel` object supplied as part of the Rules Editor Component JAR file (`adflibRulesDC.jar`).
`rulesPageSize`	j`ava.lang. Integer`	no	`5`	yes	Specifies the number of rules to be displayed in a page. It is used in `IF`/`THEN` rules pagination. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `ifThenPreferences` attribute and override `getRulesPageSize()`.
`showDTButtons`	`java.lang. Boolean`	no	`true`	yes	Displays the add and delete decision table links by default. You can choose to hide these by setting this to `false`. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dtPreferences` attribute and override `isShowDTButtons()`.
`showValidationPanel`	j`ava.lang. Boolean`	no	`true`	yes	Displays the validation panel by default. You can choose to hide this by setting this to `false`.
`simpleTestModel`	`java.lang. String`	no	oracle. bpel.rulesd c.model. impl. SimpleTestM odel	yes	Used to customize the default `SimpleTestModel`. You can extend the `SimpleTestModel` class to override certain methods. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `ifThenPreferences` attribute and override `getSimpleTestModel()`.
`timeStyle`	`java.lang. String`	no	Gets from the locale	yes	If specified, the time style is used in all `inputDate` components, for example `HH:mm:ss`.
`timezone`	`java.util. TimeZone`	no	TimeZone. getDefault ()	yes	Used for localization.
`viewOnly`	`java.lang. Boolean`	no	`true`	yes	If `true`, in the `viewOnly` mode, you can view the existing rules in the ruleset. If `false`, which is edit mode, you can add new rules and edit existing rules.
`vldnPanelCollapsed`	`java.lang.Boolean`	no	`false`	yes	Used to specify if validation panel should be collapsed by default.
`vldnTabTitle`	`java.lang.String`	no		yes	Used to specify the validation panel title.

26.3 Using the Oracle Business Rules Dictionary Editor Declarative Component

This section discusses the Oracle Business Rules Dictionary Editor declarative component. It also provides information on how to create and run an application using the Rules Dictionary Editor component, and then deploy the application. In addition, this section lists the supported tags and the localization process for the application.

26.3.1 Introduction to the Oracle Business Rules Dictionary Component

The Oracle Business Rules Dictionary Editor is a composite declarative component that can be embedded in any ADF-based web application. It enables you to edit business rules metadata artifacts, such as globals, bucketsets, and rulesets, by using the Rules SDK2 API.

Note:

Do not confuse the Rules Dictionary Editor with the Rules Editor. The Rules Editor edits rules inside a specified ruleset. In fact, the Rules Editor is embedded within the Rules Dictionary Editor. For more information about the Rules Editor, see Section 26.2, "Using the Oracle Business Rules Editor Declarative Component."

The Rules Dictionary Editor task flow uses the Rules Dictionary Editor Component to create applications. Typically, you should either use the Rules Dictionary Editor component or the Rules Dictionary Editor task flow, but not both. For more information on the Rules Dictionary Editor task flow, see Section 26.4, "Using the Oracle Business Rules Dictionary Editor Task Flow."

The Rules Dictionary Editor component performs the following:

Edits globals or variables that have the final attribute set to true by using the Globals Editor, as shown in Figure 26-29.

Figure 26-29 Globals Editor

Description of "Figure 26-29 Globals Editor"

The Globals Editor enables you to create, delete, edit the name, description, value, change bucketset, change type and make global final. It supports validation of globals.
Edits bucketsets by using the Bucketset Editor as shown in Figure 26-30.

Figure 26-30 Bucketset Editor

Description of "Figure 26-30 Bucketset Editor"

Bucketset Editor enables you to perform CRUD (create, read, update, and delete) operations on bucketsets and buckets inside a bucketset. It also supports validation of bucketsets.
Edits rulesets, as shown in Figure 26-31.

Figure 26-31 Edits Rulesets

Description of "Figure 26-31 Edits Rulesets"

The Rules Dictionary Editor enables you to edit only rules inside a selected ruleset. It does not allow creation or deletion of rulesets.

26.3.2 How to Create and Run a Sample Application by Using the Rules Dictionary Editor Component

This section lists the steps for creating and running a sample application by using the Rules Dictionary Editor component.

The prerequisite for using the Rules Dictionary Editor component to create ADF-based web applications is having a running installation of Oracle SOA Suite and Oracle JDeveloper on your computer.

To create a sample application by using the Rules Dictionary Editor:

The first task is to create a sample application.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New and then Generic Application to create an application.
Enter a name for the application in the Application Name field, for example, useRuleDictDCApp, and click Next as shown in Figure 26-32.

Figure 26-32 Creating a Generic Application

Description of "Figure 26-32 Creating a Generic Application"
Enter useRuleDictDC in the Project Name field and ensure that ADF Faces is selected in the Project Technologies tab, as shown in Figure 26-33.

Click Finish to create the project.

Figure 26-33 Creating a Project

Description of "Figure 26-33 Creating a Project"
Right-click the useRuleDictDC project in the Application Navigator of Oracle JDeveloper, and select Project Properties to display the Project Properties dialog box.

In the Project Properties dialog box:
1. Click JSP Tag Libraries in the left panel.
2. Click Add and select ADF Faces Components from the Extension list in the Choose Tag Libraries dialog box, and then click OK as shown in Figure 26-34.
  
  Figure 26-34 Choosing Tab Libraries
  
  Description of "Figure 26-34 Choosing Tab Libraries"
3. Click Libraries and Classpath from the left panel and click the Add Library button to display the Add Library dialog box.
4. Click Oracle Rules and Oracle Rules Dictionary Component from the Extension list and then click OK as shown in Figure 26-35.
  
  Figure 26-35 Selecting Oracle Rules and Rules Dictionary Component
  
  Description of "Figure 26-35 Selecting Oracle Rules and Rules Dictionary Component"
  
  This adds the Rules SDK and the Rules Dictionary Editor tag libraries to the project.
5. Click OK to close the Project Properties dialog box.
Select Save All from the Oracle JDeveloper File menu to save the project.

You have to ensure that all the required tag libraries are added:

Right-click the useRuleDictDC project in the Application Navigator of Oracle JDeveloper and select Project Properties to display the Project Properties dialog box.
Click JSP Tag Libraries in the left panel and check if all the tag libraries are added, as shown in Figure 26-36.

Figure 26-36 Checking the Required Tag Libraries for Rules Dictionary Editor

Description of "Figure 26-36 Checking the Required Tag Libraries for Rules Dictionary Editor"

To create the RuleDictionaryModel object:

The Rules Dictionary Editor component requires a oracle.bpel.ruledictionarydc.model.impl.RuleDictionaryModel object. The component uses this object to read globals, bucketsets, and rulesets information from the dictionary. Therefore, the next task is to create a managed bean named SomeBean.java that creates a RuleDictionaryModel object.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New to display the New Gallery dialog box.
In the New Gallery dialog box, select Java under General from the Categories panel.
Ensure that Java Class under Items is selected and click OK to display the Create Java Class dialog box.
Enter the name of the Java class, for example SomeBean.java, and click OK to create the Java class in your project, as shown in Figure 26-37.

Figure 26-37 Creating a Java Class

Description of "Figure 26-37 Creating a Java Class"

In SomeBean.java, provide a method that returns the RuleDictionaryModel object. You must specify the location of the rules file here. The following is a sample of the SomeBean.java file:

package useruledictdc;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Reader;

import java.io.Writer;

import java.util.ArrayList;
import java.util.List;

import oracle.bpel.ruledictionarydc.model.impl.RuleDictionaryModel;

import oracle.rules.sdk2.dictionary.DictionaryFinder;
import oracle.rules.sdk2.dictionary.RuleDictionary;
import oracle.rules.sdk2.exception.SDKException;
import oracle.rules.sdk2.exception.SDKWarning;

public class SomeBean {
    private RuleDictionaryModel ruleDictModel;
    private static final String RULES_FILE1 =
        "C:\\scratch\\asuraj\\system\\rules\\OrderBookinRules.rules";

    public SomeBean() {
        super();
    }

    public RuleDictionaryModel getRuleDictModel() {
        if (ruleDictModel != null)
            return ruleDictModel; 
              //cache ruleDictModel instead of re-creating it each time

        ruleDictModel = new RuleDictionaryModel(getRuleDictionary());
        return ruleDictModel;
    }

    public RuleDictionary getRuleDictionary() {

        Reader reader = null;
        try {
            reader = new FileReader(new File(RULES_FILE1));
        } catch (FileNotFoundException e) {
            //LOG.severe(e);
            System.err.println(e);
        }
        RuleDictionary dict = openRulesDict(reader, null);
        if (reader != null) {
            try {
                reader.close();
            } catch (IOException ioe) {
            }
        }

        return dict;
    }

    private static RuleDictionary openRulesDict(Reader reader,
                                                DictionaryFinder finder) {
        RuleDictionary dict = null;

        try {
            dict = RuleDictionary.readDictionary(reader, finder);
        } catch (SDKException e) {
            System.err.println(e);
        } catch (FileNotFoundException e) {
            System.err.println(e);
        } catch (IOException e) {
            System.err.println(e);
        } 
        catch (IllegalArgumentException e) {
            System.err.println(e);
        } finally {

        }

        return dict;
    }

    //refer to Rules SDK documentation for saving a dictionary also
    //because this code does not take care of saving linked dictionaries

    public static boolean saveDictionary(RuleDictionary dict,
                                         String ruleFileName) {

        if (dict == null || ruleFileName == null)
            return false;

        if (dict.isTransactionInProgress())
            System.out.println("Transaction in progress, cannot save dictionary");

        Writer writer = null;
        try {
            writer = new FileWriter(new File(ruleFileName));
            dict.writeDictionary(writer);

        } catch (SDKException e) {
            System.err.println(e);
            return false;
        } catch (FileNotFoundException e) {
            System.err.println(e);
            return false;
        } catch (IOException e) {
            System.err.println(e);
            return false;
        } finally {
            if (writer != null) {
                try {
                    writer.close();
                } catch (IOException ioe) {
                    return false;
                }
            }
        }
        return true;
    }

    public static void updateDictionary(RuleDictionary dict) {
        if (dict == null)
            return;

        List<SDKWarning> warnings = new ArrayList<SDKWarning>();
        try {
            dict.update(warnings);
            for (SDKWarning warning : warnings)
                System.out.println("warnings: " +
                                   warning.getLocalizedMessage());
        } catch (SDKException sdkEx) {
            sdkEx.printStackTrace();
        }
    }

    //You can call this method from your "Save" button

    public void saveDictionary() {

        RuleDictionary dict = this.getRuleDictModel().getRuleDictionary();

        if (dict != null) {
            if (dict.isModified())
                updateDictionary(dict);
            if (!dict.isTransactionInProgress())
                saveDictionary(dict, RULES_FILE1);
        }
    }
         //call validation method on the ruleDictModel to update Validation Panel

    public void validate() {
        if (this.ruleDictModel == null)
            return;

        this.ruleDictModel.validate();
    }
}

Open the faces-config.xml file in Overview mode and click the + button under Managed Beans to display the Create Managed Bean dialog box.
Point to SomeBean.java by entering someBean in the Bean Name field and selecting session from the Scope list, as shown in Figure 26-38.

Figure 26-38 Specifying the Bean Name and Scope

Description of "Figure 26-38 Specifying the Bean Name and Scope"

The ADF/JSF framework makes multiple calls to SomeBean.java to render the user interface. For example, someBean.ruleDictModel is called multiple times. Therefore, it is better to create the RuleDictModel object once, cache it, and return it each time instead of re-creating it.

To create the .jspx file for the Rules Dictionary Editor Component tag:

The next task is to create the .jspx file to include the Rules Dictionary Editor Component tag.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New to display the New Gallery dialog box.
In the New Gallery dialog box, select JSF under Web Tier from the Categories panel.
Select JSF Page under Items and click OK to display the Create JSF Page dialog box.
In the Create JSF Page dialog box, enter useRuleDictDC.jspx as the file name, as shown in Figure 26-39.

Figure 26-39 Specifying the Name of the JSF Page

Description of "Figure 26-39 Specifying the Name of the JSF Page"

RuleDictionaryDC is displayed in the Component Palette of Oracle JDeveloper, as shown in Figure 26-40.

Figure 26-40 Rule Dictionary Editor Library in the Component Palette

Description of "Figure 26-40 Rule Dictionary Editor Library in the Component Palette"

This is because you have added Rules Dictionary Component when creating the sample application.

Select RuleDictionaryDC to view the ruleDictionaryDC tag.You can drag and drop the RuleDictionaryDC tag into the .jspx file. You can also add the RuleDictionaryDC tag in the .jspx file manually as shown:

<?xml version='1.0' encoding='UTF-8'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" version="2.1"
          xmlns:f="http://java.sun.com/jsf/core"
          xmlns:h="http://java.sun.com/jsf/html"
          xmlns:af="http://xmlns.oracle.com/adf/faces/rich"
          xmlns:rddc="http://xmlns.oracle.com/bpel/rules/dictionaryEditor">
  <jsp:directive.page contentType="text/html;charset=UTF-8"/>
  <f:view>
       <af:document id="d1" title="Sample Rule Dictionary App">
      <af:form id="f1">
        <af:panelStretchLayout id="psl1" inlineStyle="margin:15px;"
                               partialTriggers="cb2 cb3">
          <f:facet name="center">
            <rddc:ruleDictionaryDC ruleDictModel="#{someBean.ruleDictModel}"
                                   dtColumnPageSize="6" id="rddc1"
                                   viewOnly="false" dateStyle="yyyy-MM-dd"
                                   timeStyle="HH-mm-ss"
                                   discloseRules="true"
                                   showValidationPanel="true"/>
          </f:facet>
          <f:facet name="top">
            <af:panelGroupLayout id="pgl1" layout="horizontal">
              <af:commandButton text="Save Dict" id="cb2"
                                action="#{someBean.saveDictionary}"/>
              <af:spacer width="10" height="10" id="s1"/>
              <af:commandButton text="Validate" id="cb3"
                                action="#{someBean.validate}"/>
            </af:panelGroupLayout>
          </f:facet>
        </af:panelStretchLayout>
      </af:form>
    </af:document>
  </f:view>
</jsp:root>

To refer to the oracle.rules and the oracle.soa.rules_dict_dc.webapp shared libraries:

After creating the .jspx file, you must refer to the oracle.rules and oracle.soa.rules_editor_dc.webapp shared libraries from the weblogic-application.xml file.

The steps are:

In Oracle JDeveloper, open the weblogic-application.xml file by browsing to Application Resources, then Descriptors, and then META-INF.
Add the following lines to refer to the oracle.rules shared library, as shown in Figure 26-41.
```
<library-ref>
<library-name>oracle.rules</library-name>
</library-ref>
```
Figure 26-41 Referring to the oracle.rules Shared Library

Description of "Figure 26-41 Referring to the oracle.rules Shared Library"
In Oracle JDeveloper,
1. From the File menu, select New to display the New Gallery dialog box.
2. In the New Gallery dialog box, select Deployment Descriptors under General from the Categories panel.
3. Select Weblogic Deployment Descriptor under Items and click OK to display the Create Weblogic Deployment Descriptor dialog box.
4. Select weblogic.xml from the list and click Finish.
5. In Oracle JDeveloper, in the Overview mode of weblogic.xml, select Libraries from the left panel and enter oracle.soa.rules_dict_dc.webapp as the library name, as shown in Figure 26-42.
  
  Figure 26-42 Adding the Rules Dictionary Component Library
  
  Description of "Figure 26-42 Adding the Rules Dictionary Component Library"
Click Save All.
Deploy the oracle.rules shared library to the embedded Oracle WebLogic Server:
1. Launch WLS console (http://host:port/console/login/LoginForm.jsp). Ensure that the Weblogic embedded server on Oracle JDeveloper is running.
2. Select Deployments and click Install to display the Install Application Assistant page.
3. Select <JDEV_INSTALL>/jdeveloper/soa/modules/oracle.rules_11.1.1/rules.jar and click Finish.as shown in Figure 26-43.
  
  Figure 26-43 Deploying the oracle.rules Shared Library
  
  Description of "Figure 26-43 Deploying the oracle.rules Shared Library"
Deploy the oracle.soa.rules_dict_dc.webapp shared library to Oracle WebLogic Server:
1. In the Weblogic console, select Deployments and click Install to display the Install Application Assistant page.
2. Select <JDEV_INSTALL>/jdeveloper/soa/modules/oracle.soa.rules_dict_dc.webapp_11.1.1/oracle.soa.rules_dict_dc.webapp.war and click Next.
3. Select Install this deployment as a library and click Finish as shown in Figure 26-44.
  
  Figure 26-44 Deploying oracle.soa.rules_editor_dc.webapp Shared Library
  
  Description of "Figure 26-44 Deploying oracle.soa.rules_editor_dc.webapp Shared Library "
  
  oracle.soa.rules_dict_dc.webapp is added to the list of deployments, as shown in Figure 26-45.
  
  Figure 26-45 oracle.soa.rules_dict_dc.webapp Added to the Deployment List
  
  Description of "Figure 26-45 oracle.soa.rules_dict_dc.webapp Added to the Deployment List"

To run the sample Rules Dictionary Editor application:

The last task is running the sample application.

To run the sample application, from Oracle JDeveloper, right-click the useRuleDictDC.jspx file, and select Run. This starts the sample application on a web browser, as shown in Figure 26-46.

Figure 26-46 Running the Sample Rules Dictionary Editor Application

Description of "Figure 26-46 Running the Sample Rules Dictionary Editor Application"

26.3.3 How to Deploy a Rules Dictionary Application to a Standalone Oracle WebLogic Server

When you are ready to deploy your application EAR file to the standalone Oracle WebLogic Server, perform the following:

Launch the Oracle WebLogic Server Administration Console (http://host:port/console/login/LoginForm.jsp) and ensure that oracle.rules is displayed in the deployments list.
Ensure that oracle.soa.rules_dict_dc.webapp is displayed in the deployments list.
If this is not displayed, click Install and select the JDEV_INSTALL/jdeveloper/soa/modules/oracle.soa.rules_dict_dc.webapp_11.1.1/oracle.soa.rules_dict_dc.webapp.war file.
Open Oracle JDeveloper.
Right-click the project name in the Application Navigator and select Project Properties.
Select Libraries and Classpath from the left panel and click Add Library.
In the Add Library dialog box, select Oracle Rules Dictionary Component and click OK as shown in Figure 26-47.

Figure 26-47 Adding the Oracle Rules Dictionary Component

Description of "Figure 26-47 Adding the Oracle Rules Dictionary Component"

This step enables you to refer to these libraries, but does not deploy these libraries by default. Therefore, the JAR files are not included in your project war file.
In the project that has to be deployed (where you create the EAR file):
1. Add the following lines to the weblogic-application.xml:
```
<library-ref>
   <library-name>oracle.rules</library-name>
</library-ref>
```
2. Add the following lines to weblogic.xml in the project WAR file:
```
<library-ref>
   <library-name>oracle.soa.rules_dict_dc.webapp</library-name>
</library-ref>
```
3. Deploy the EAR file in Oracle WebLogic Server.

26.3.4 What You May Need to Know About the Supported Attributes of the Rules Dictionary Editor Component

This section lists the attributes that are supported by the Rules Dictionary Editor component.

Table 26-3 lists the supported attributes.

Table 26-3 Supported Rules Dictionary Editor Attributes

Name	Type	Required	Default Value	Supports EL?	Description
`dateStyle`	`java.lang.String`	no	Gets it from the locale	yes	If specified, the date style is used in all `inputDate` components (for example, `yyyy.MM.dd`).
`decimalSeparator`	`java.lang. Character`	no	Based on Locale	yes	Specifies the decimal separators. This is used in number formatting. If specified, this attribute overrides the decimal separator based on locale.
`dfActionListener`		no		yes	Introduced but deprecated in release 11.1.1.7. Will be removed in 12C. Use `dfEditorPrefs` and override `getDfActionListener()`.
`dfEditorPrefs`	oracle.bpel.ruledict ionarydc.model.inter faces.DFEditorPrefer ences	no	oracle.bpel .ruledictio narydc.mode l.impl.DFEd itorPrefere ncesImpl	yes	Used to specify the decision function editor preferences. Consumers can extend the following default implementation and override only the required preferences: oracle.bpel.ruledict ionarydc.model.impl. DFEditorPreferencesI mpl
`dfListener`	oracle.bpel.decision funceditordc.listene r.DecisionFuncListen er	no		yes	Introduced but deprecated in release 11.1.1.7. Will be removed in 12C. Use `dfEditorPrefs` and override `getDfListener()`.
`dfServiceNameCustomizer`		no		yes	Introduced but deprecated in 11.1.1.7. Will be removed in 12C. Use `dfEditorPrefs` and override `getDfServiceNameCustomizer()`.
`disableDFName`	`java.lang. Boolean`	no	`false`	yes	If `true`, the decision function name in the decision function editor window is disabled. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dfEditorPrefs` and override `isDisableDFName()`.
`disableInputOps`	`java.lang. Boolean`	no	`false`	yes	Disables the add, edit, and delete operations for the Inputs table in the decision function editor window. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dfEditorPrefs` and override `isDisableInputOps()`.
`disableOutputOps`	`java.lang. Boolean`	no	`false`	yes	Disables the add, edit, and delete operations for the Outputs table in the decision function editor window. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dfEditorPrefs` and override `isDisableOutputOps().`
`disableRuleSetName`	`java.lang. Boolean`	no	`false`	yes	If `true`, the editable ruleset name is disabled. This attribute is used only when `displayRuleSetName` is set to `true`. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `rulesEditorPrefs` and override `isDisableRuleSetName()`.
`discloseRules`	`java.lang. Boolean`	no	`false`	yes	If `true`, all the rules in the ruleset are disclosed or expanded. If `false`, all the rules are collapsed. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `rulesEditorPrefs` and override `getIfThenPreferences().isDiscloseRules()`.
`displayAddDF`	`java.lang. Boolean`	no	`true`	yes	Displays the Add Decision Function button. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dfEditorPrefs` and override `isDisableAddDF().`
`displayDeleteDF`	`java.lang. Boolean`	no	`true`	yes	Displays the Delete Decision Function button. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dfEditorPrefs` and override `isDisableOutputOps().`
`displayRuleSetName`	`java.lang. Boolean`	no	`true`	yes	Displays the editable ruleset name by default. You can choose to hide this name by setting to `false`. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `rulesEditorPrefs` and override `isDisableDeleteDF()`.
`displayWSCheck`	`java.lang. Boolean`	no	`true`	yes	If `true`, the Invoke as rule service check box in the decision function editor window is displayed. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dfEditorPrefs` and override `isDisplayWSCheck()`.
`displayWSName`	`java.lang. Boolean`	no	`true`	yes	If `true`, the decision service name is displayed in the decision function editor window. The service name is relevant only when Invoke as rule service is selected. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `dfEditorPrefs` and override `isDisplayWSName()`.
`dtColumnPageSize`	`java.lang. Integer`	no	`5`	yes	Number of columns to be displayed at a time in the decision table. This works only when rules are columnar. Deprecated for release 11.1.1.7. Will be removed in 12c.
`dtHeight`	`java.lang. Integer`	no	`16`	yes	Number of rows to be displayed at a time in the decision table. A scroll bar is displayed if the number of rows increases over the specified height. Deprecated for release 11.1.1.7. Will be removed in 12c.
`groupingSeparator`	`java.lang. Character`	no	Based on Locale	yes	Specifies the grouping separators. This is used in number formatting. If specified, this attribute overrides the grouping separator based on locale.
`locale`	`java.util.Locale`	no	`Locale. get Default()`	yes	Used for localization.
`resourceManager`	oracle.bpel.rulessha reddc.model.interfac es.ResourceManagerIn terface	no		yes	Used to specify the resource manager for translations UI. For information see, Section 26.6, "Working with Translations".
`ruleDictModel`	oracle.bpel. ruledictionarydc. model.interfaces.Rul eDictionaryInterface	yes	-	Only EL	Wrapper around the Rules SDK dictionary object.You can use the `RuleDictionaryModel` object supplied as part of the Rules Dictionary Editor Component JAR file (`adflibRuleDictionaryDC.jar`).
`rulesEditorPrefs`	oracle.bpel.ruledict ionarydc.model.inter faces.RulesEditorPre ferences	no	oracle.bpel .ruledictio narydc.mode l.impl.Rule sEditorPref erencesImpl	yes	Used to specify the rules editor preferences. Consumers can extend the following default implementation and override only the required preferences: oracle.bpel.ruledict ionarydc.model.impl. RulesEditorPreferenc esImpl
`rulesPageSize`	`java.lang. Integer`	no	`5`	yes	Specifies the number of rules to be displayed in a page. It is used in `IF`/`THEN` rules pagination. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `rulesEditorPrefs` and override `getIfThenPreferences().getRulesPageSize().`
`selectedRulesetIdx`	`java.lang.String`	no		yes	Used to specify the ruleset index to be selected by default. If `selectedRulesetIdx` is specified, it overrides the `selectedTab` attribute.
`selectedTab`	`java.lang.String`	no	-	yes	Switches to the specified tab name (either GLOBALS, BUCKETSETS, DESC_FUNCS, or the ruleset name).
`showDTButtons`	`java.lang. Boolean`	no	`true`	yes	Displays the Add and Delete decision table buttons. Deprecated for release 11.1.1.7. Will be removed in 12c. Use `rulesEditorPrefs` and override `getDecisionTablePreferences().isShowDTButtons()`.
`showRSButtons`	`java.lang.Boolean`	no	`true`	yes	Displays the add and delete ruleset buttons. Introduced but deprecated for release 11.1.1.7. Will be removed in 12C. Use `rulesEditorPrefs` and override `isShowRSButtons()`.
`showValidationPanel`	`java.lang. Boolean`	no	`true`	yes	Displays the validation panel by default. You can choose to hide this panel by setting to `false`.
`timeStyle`	`java.lang.String`	no	Gets it from the locale	yes	If specified, the time style is used in all `inputDate` components (for example, `HH:mm:ss`).
`timezone`	`java.util. TimeZone`	no	`TimeZone. getDefault()`	yes	Used for localization.
`viewOnly`	`java.lang. Boolean`	no	`true`	yes	If `true`, in view-only mode, you can view the existing dictionary data, but you cannot edit the data. If `false`, which is edit mode, you can edit the existing dictionary data.
`vldnPanelCollapsed`	`java.lang.Boolean`	no	`false`	yes	Used to specify if validation panel should be collapsed by default.
`vldnTabTitle`	`java.lang.String`	no	Localized text Business Rule Validation - Log	yes	Used to specify the validation panel title

26.4 Using the Oracle Business Rules Dictionary Editor Task Flow

This section discusses the Oracle Business Rules Dictionary Editor task flow. It also provides information on how to create and run an application using the Rules Dictionary Editor task flow, and then deploy the application.

26.4.1 Introduction to the Oracle Business Rules Dictionary Task Flow

The Oracle Rules Dictionary Editor Task Flow is basically a wrapper around the Rules Dictionary Editor declarative component. The task flow is used in ADF-based web applications that require a task flow instead of a declarative component. For more information on the Rules Dictionary Editor component, see Section 26.3, "Using the Oracle Business Rules Dictionary Editor Declarative Component."

26.4.2 How to Create and Run a Sample Application By Using the Rules Dictionary Editor Task Flow

This section lists the steps for creating and running a sample application by using the Oracle Rules Dictionary Editor task flow.

The prerequisites for using the Oracle Rules Dictionary Editor task flow to create ADF-based web applications is having a running installation of Oracle SOA Suite and Oracle JDeveloper on your computer.

To create a sample application by using the Oracle Rules Dictionary Editor task flow:

The first task is to create a sample application.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New and then Generic Application to create an application.
Enter a name for the application in the Application Name field, for example, useRuleDictTaskFlowApp, and click Next as shown in Figure 26-48.

Figure 26-48 Creating a Generic Task Flow Application

Description of "Figure 26-48 Creating a Generic Task Flow Application"
Enter useRuleDictTaskFlow in the Project Name field and ensure that ADF Faces is selected in the Project Technologies tab, as shown in Figure 26-49.

Figure 26-49 Creating a Task Flow Project

Description of "Figure 26-49 Creating a Task Flow Project"
Click Finish to create the project.
Right-click the useRuleDictTaskFlow project in the Application Navigator of Oracle JDeveloper, and select Project Properties to display the Project Properties dialog box.

In the Project Properties dialog box:
1. Select JSP Tag Libraries from the left panel.
2. Click Add and select ADF Faces Components from the Extension list in the Choose Tag Libraries dialog box, and click OK as shown in Figure 26-50.
  
  Figure 26-50 Choosing Tab Libraries for the Task Flow Application
  
  Description of "Figure 26-50 Choosing Tab Libraries for the Task Flow Application"
3. Select Libraries and Classpath from the left panel and click Add Library to display the Add Library dialog box.
4. Select Oracle Rules and then Oracle Rules Dictionary Task Flow in the Libraries list and click OK as shown in Figure 26-51. This adds the Rules SDK and the Rules Dictionary Task Flow JARs to the project.
  
  Figure 26-51 Adding the Rules SDK and Rules Dictionary Task Flow
  
  Description of "Figure 26-51 Adding the Rules SDK and Rules Dictionary Task Flow"
5. Click OK to close the Project Properties dialog box.
Click Save All from the Oracle JDeveloper File menu to save the project.

Create a Java class that implements the oracle.integration.console.metadata.model.share.MetadataDetails interface, which is defined in soaComposerTemplates.jar. For more information on the MetadataDetails interface, see Section I.1, "The MetadataDetails Interface."

The steps are:

Open Oracle JDeveloper.
From the File menu, select New to display the New Gallery dialog box.
In the New Gallery dialog box, select Java under General from the Categories panel. Ensure that Java Class under Items is selected and click OK to display the Create Java Class dialog box.
Enter the name of the Java class, for example MyMetaDataDetails.

Add the MetadataDetails interface in the Implements box under Optional Attributes, and click OK to create the Java class in your project, as shown in Figure 26-52.

Figure 26-52 Creating a Java Class That Implements the MetadataDetails Interface

Description of "Figure 26-52 Creating a Java Class That Implements the MetadataDetails Interface"

The following is a sample of the content of the MyMetaDataDetails.java file:

package useruledicttaskflow;

import java.io.BufferedReader;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.UnsupportedEncodingException;
import java.io.Writer;

import java.net.MalformedURLException;
import java.net.URL;

import oracle.integration.console.metadata.model.share.MetadataDetails;
import oracle.integration.console.metadata.model.share.RelatedMetadataPath;

public class MyMetaDataDetails implements MetadataDetails {
    public MyMetaDataDetails() {
        super();
    }

    private static final String RULES_FILE1 =
        "file:///<path of Rules file>";

    public String getDocument() {
        URL url = null;
        try {
            url = new URL(RULES_FILE1);
            return readFile(url);
        } catch (IOException e) {
            System.err.println(e);
        }
        return "";
    }

    public void setDocument(String string) {
        URL url = null;

        try {
            url = new URL(RULES_FILE1);
        } catch (MalformedURLException e) {
            System.err.println(e);
            return;
        }
        Writer writer = null;
        try {
            //os = new FileWriter(url.getPath());
            writer =
               new OutputStreamWriter(new FileOutputStream(url.getPath()),
              "UTF-8");
       } catch (FileNotFoundException e) {
            System.err.println(e);
            return;
        } catch (IOException e) {
            System.err.println(e);
            return;
        }
        try {
            writer.write(string);
        } catch (IOException e) {
            System.err.println(e);
        } finally {
            if (writer != null) {
                try {
                    writer.close();
                } catch (IOException ioe) {
                    System.err.println(ioe);
                }
            }
        }
    }

    private String readFile(URL dictURL) {
        InputStream is;
        try {
            is = dictURL.openStream();
        } catch (IOException e) {
            System.err.println(e);
            return "";
        }
        BufferedReader reader;
        try {
           reader = new BufferedReader(new InputStreamReader(is, "UTF-8"));
        } catch (UnsupportedEncodingException e) {
            System.err.println(e);
            return "";
        }
        String line = null;
        StringBuilder stringBuilder = new StringBuilder();
        String ls = System.getProperty("line.separator");
        try {
            while ((line = reader.readLine()) != null) {
                stringBuilder.append(line);
                stringBuilder.append(ls);
            }
        } catch (IOException e) {
            System.err.println(e);
            return "";
        } finally {
            try {
                reader.close();
            } catch (IOException e) {
                System.err.println(e);
            }
        }
        return stringBuilder.toString();
    }

public String getRelatedDocument(RelatedMetadataPath relatedMetadataPath) {
        String currPath =
            RULES_FILE1.substring(0, RULES_FILE1.indexOf("oracle/rules"));
        String relatedDoc =
            currPath + "oracle/rules/" + relatedMetadataPath.getValue();

        URL url = null;
        try {
            url = new URL(relatedDoc);
            return readFile(url);
        } catch (IOException e) {
            System.err.println(e);
        }
        return "";
    }
}

Create a Java class called MyNLSPreferences that implements the oracle.integration.console.metadata.model.share.NLSPreferences interface, which is defined in soaComposerTemplates.jar.

For more information about the NLS Preferences interface, see Section I.2, "The NLSPreferences Interface."

The following sample of MyNLSPreferences.java implements the NLSPreferences interface:

package useruledicttaskflow;

import java.util.Locale;
import java.util.TimeZone;

import oracle.integration.console.metadata.model.share.NLSPreferences;

public class MyNLSPreferences implements NLSPreferences {
    private static final String DATE_STYLE = "yyyy-MM-dd";
    private static final String TIME_STYLE = "HH-mm-ss";
    
    public MyNLSPreferences() {
        super();
    }

    public Locale getLocale() {
        return Locale.getDefault();
    }

    public TimeZone getTimeZone() {
        return TimeZone.getTimeZone("America/Los_Angeles");
    }

    public String getDateFormat() {
        return DATE_STYLE;
    }

    public String getTimeFormat() {
        return TIME_STYLE;
    }
}

Create a managed bean called MyBean.java to return the implementation of MetadataDetails and NLSPreferences. It also returns the oracle.integration.console.metadata.model.share.MetadataDetailsMode object and provides event handlers such as toggleMode(), saveDictionary(), saveNoValidateDictionary(), and validate().

The following is a sample of the MyBean.java file:

package useruledicttaskflow;

import javax.el.ELContext;
import javax.el.ExpressionFactory;
import javax.el.MethodExpression;

import javax.faces.context.FacesContext;
import javax.faces.event.PhaseId;

import oracle.adf.view.rich.component.rich.fragment.RichRegion;

import oracle.integration.console.metadata.model.share.MetadataDetails;
import oracle.integration.console.metadata.model.share.MetadataDetailsMode;
import oracle.integration.console.metadata.model.share.NLSPreferences;

public class MyBean {
    private MyMetaDataDetails details = null;
    private MetadataDetailsMode mode = MetadataDetailsMode.VIEW;
    private RichRegion regionComp;
    private NLSPreferences nlsPrefs;

    public MyBean() {
        super();
    }

    public MetadataDetails getMetaDataDetails() {
        if (details != null)
            return details;

        details = new MyMetaDataDetails();
        return details;
    }

    public MetadataDetailsMode getDetailsMode() {
        return mode;
    }

    public void toggleMode() {
        if (mode.equals(MetadataDetailsMode.EDIT))
            mode = MetadataDetailsMode.VIEW;
        else
            mode = MetadataDetailsMode.EDIT;
    }

    public void saveDictionary() {
        if (regionComp == null)
            return;
        FacesContext fc = FacesContext.getCurrentInstance();
        ExpressionFactory ef = fc.getApplication().getExpressionFactory();
        ELContext elc = fc.getELContext();
        MethodExpression me =
            ef.createMethodExpression(elc, "doMetadataUpdate", String.class,
                                      new Class[] { });
        regionComp.queueActionEventInRegion(me, null, null, false, -1, -1,
                                            PhaseId.ANY_PHASE);
    }

    public void saveNoValidateDictionary() {
        if (regionComp == null)
            return;
        FacesContext fc = FacesContext.getCurrentInstance();
        ExpressionFactory ef = fc.getApplication().getExpressionFactory();
        ELContext elc = fc.getELContext();
        MethodExpression me =
            ef.createMethodExpression(elc, "doNoValidateMetadataUpdate",
                                      String.class, new Class[] { });
        regionComp.queueActionEventInRegion(me, null, null, false, -1, -1,
                                            PhaseId.ANY_PHASE);
    }

    public void validate() {
        if (regionComp == null)
            return;
        FacesContext fc = FacesContext.getCurrentInstance();
        ExpressionFactory ef = fc.getApplication().getExpressionFactory();
        ELContext elc = fc.getELContext();
        MethodExpression me =
            ef.createMethodExpression(elc, "doValidate", String.class,
                                      new Class[] { });
        regionComp.queueActionEventInRegion(me, null, null, false, -1, -1,
                                            PhaseId.ANY_PHASE);
    }

    public void setRegionComp(RichRegion regionComp) {
        this.regionComp = regionComp;
    }
    public RichRegion getRegionComp() {
        return regionComp;
    }

    public NLSPreferences getNlsPrefs() {
        if (nlsPrefs != null)
            return nlsPrefs;

        nlsPrefs = new MyNLSPreferences();
        return nlsPrefs;
    }
}

Open the faces-config.xml file in Overview mode and click the + button under Managed Beans to display the Create Managed Bean dialog box.
Point to MyBean.java by entering MyBean in the Bean Name field and selecting session from the Scope list, as shown in Figure 26-53.

Figure 26-53 Specifying the Bean Name and Scope in the Task Flow Application

Description of "Figure 26-53 Specifying the Bean Name and Scope in the Task Flow Application"

To add a Rules Dictionary Editor task flow in a .jspx file:

The next task is to create the .jspx file to include the Rules Dictionary Editor component tag.

The steps are:

Open Oracle JDeveloper.
From the File menu, select New to display the New Gallery dialog box.
In the New Gallery dialog box, select JSF under Web Tier from the Categories panel.
Select JSF Page under Items and click OK to display the Create JSF Page dialog box, as shown in Figure 26-54.

Figure 26-54 Creating the JSF Page File to Include the Rules Dictionary Editor Task Flow

Description of "Figure 26-54 Creating the JSF Page File to Include the Rules Dictionary Editor Task Flow"
In the Create JSF Page dialog box, enter useRuleDictTaskFlow.jspx as the file name, as shown in Figure 26-55.

Figure 26-55 Specifying the Name of the JSF Page for the Task Flow

Description of "Figure 26-55 Specifying the Name of the JSF Page for the Task Flow"

adflibRuleDictionaryTaskFlow.jar is displayed in the Component Palette of Oracle JDeveloper, as shown in Figure 26-56.

Figure 26-56 Rules Dictionary Task Flow JAR in the Component Palette

Description of "Figure 26-56 Rules Dictionary Task Flow JAR in the Component Palette"

This is because you have added the Oracle Rules Dictionary Task Flow shared library when creating the sample application.

Select adflibRuleDictionaryTaskFlow.jar to make rule-dict-flow-definition available under Regions in the Component Palette. You can drag and drop the rule-dict-flow-definition region into the .jspx file as shown in Figure 26-57, and specify all the required parameters.

Figure 26-57 Dragging and Dropping the Region

Description of "Figure 26-57 Dragging and Dropping the Region"

The following is a sample of the useRuleDictTaskFlow.jspx file with the task flow added:

<f:view>
    <af:document id="d1">
      <af:form id="f1">
        <af:panelStretchLayout id="psl1" inlineStyle="margin:8px;">
          <f:facet name="top">
            <af:menuBar id="mb1">
              <af:commandMenuItem text="Toggle Mode" id="cmi1"
                                  action="#{MyBean.toggleMode}"
                                  partialSubmit="true"/>
              <af:commandMenuItem text="Save Dict" id="cmi2"
                                  action="#{MyBean.saveDictionary}"
                                  partialSubmit="true"/>
              <af:commandMenuItem text="Save Dict No Validate" id="cmi3"
                                  action="#{MyBean.saveNoValidateDictionary}"
                                  partialSubmit="true"/>
              <af:commandMenuItem text="Validate" id="cmi4"
                                  action="#{MyBean.validate}"
                                  partialSubmit="true"/>
            </af:menuBar>
          </f:facet>
          <f:facet name="center">
            <af:region value="#{bindings.rulesdictflowdefinition1.regionModel}"
                         id="r2" binding="#{MyBean.regionComp}"
                         partialTriggers="::cmi1 ::cmi2 ::cmi3 ::cmi4"/>
          </f:facet>
        </af:panelStretchLayout>
      </af:form>
    </af:document>
  </f:view>

In the preceding sample, you can find code snippets for rendering the following buttons to the page:

Toggle Mode: Enables switching between read-only and editable modes of Oracle SOA Composer.
Save Dict: Enables saving the dictionary (with or without validation).

To edit the pagedef.xml file:

After you add the task flow to the .jspx file, you must edit the useRuleDictTaskFlowPageDef.xml file. The pagedef.xml file is created when you drop the Rules Dictionary task flow into the .jspx page.

The following is a sample of the pagedef.xml file along with all the parameters that must be passed to the rules dictionary task flow:

<?xml version="1.0" encoding="UTF-8" ?>
<pageDefinition xmlns="http://xmlns.oracle.com/adfm/uimodel"
                version="11.1.1.55.99" id="useRuleDictTaskFlowPageDef"
                Package="useruledicttaskflow.pageDefs">
 <parameters/>
  <executables>
    <variableIterator id="variables"/>
    <taskFlow id="rulesdictflowdefinition1"
   taskFlowId= "/WEB-INF/rule-dict-flow-definition.xml#rules-dict-flow-definition"
   activation="deferred"
   xmlns="http://xmlns.oracle.com/adf/controller/binding">
 <parameters>
        <parameter id="details" value="#{MyBean.metaDataDetails}"
                   xmlns="http://xmlns.oracle.com/adfm/uimodel"/>
        <parameter id="mode" value="#{MyBean.detailsMode}"
                   xmlns="http://xmlns.oracle.com/adfm/uimodel"/>
        <parameter id="dtHeight" value="10"
                   xmlns="http://xmlns.oracle.com/adfm/uimodel"/>
        <parameter id="selectedTab" value="Ruleset_1"
                   xmlns="http://xmlns.oracle.com/adfm/uimodel"/>
        <parameter id="dtColumnPageSize" value="6"
                   xmlns="http://xmlns.oracle.com/adfm/uimodel"/>
        <parameter id="nlsPrefs" value="#{MyBean.nlsPrefs}"
                   xmlns="http://xmlns.oracle.com/adfm/uimodel"/>
        <parameter id="discloseRules" value="true"
                   xmlns="http://xmlns.oracle.com/adfm/uimodel"/>
      </parameters>
    </taskFlow>
  </executables>
  <bindings/>
</pageDefinition

To refer to the oracle.rules and the oracle.soa.rules_dict_dc.webapp shared libraries:

The next task is to refer to the oracle.rules and oracle.soa.rules_dict_dc.webapp shared libraries from the weblogic-application.xml file.

For more information on referring to the shared libraries, see Section 26.3.2, "How to Create and Run a Sample Application by Using the Rules Dictionary Editor Component."

To run the sample task flow application:

The last task is running the sample application in the embedded Oracle WebLogic Server.

To run the sample application, from Oracle JDeveloper, right-click the useRulesDictTaskFlow.jspx file.
Select Run.

This starts the sample application in a web browser, as shown in Figure 26-58.

Figure 26-58 Running the Sample Rules Dictionary Editor Task Flow Application

Description of "Figure 26-58 Running the Sample Rules Dictionary Editor Task Flow Application"

26.4.3 How to Deploy a Rules Dictionary Editor Task Flow Application to a Standalone Oracle WebLogic Server

When you are ready to deploy your application EAR file to the standalone Oracle WebLogic Server, perform the following:

Launch the Oracle WebLogic Server Administration Console (http://host:port/console/login/LoginForm.jsp).
Ensure that oracle.rules is displayed in the deployments list.
Ensure that oracle.soa.rules_dict_dc.webapp is displayed in the deployments list.
If this is not displayed, click Install and select the JDEV_INSTALL/jdeveloper/soa/modules/oracle.soa.rules_dict_dc.webapp_11.1.1/oracle.soa.rules_dict_dc.webapp.war file.
In the project that has to be deployed (where you create the EAR file):
1. Add the following lines to the weblogic-application.xml:
```
<library-ref>
   <library-name>oracle.rules</library-name>
</library-ref>
```
2. Add the following lines to weblogic.xml in the project WAR file:
```
<library-ref>
   <library-name>oracle.soa.rules_dict_dc.webapp</library-name>
</library-ref>
```
3. Deploy the EAR file in Oracle WebLogic Server.

26.5 Localizing the ADF-Based Web Application

You can localize an application that is created using the Rules Editor component, Rules Dictionary Editor component, or Rules Dictionary Editor task flow.

The steps are:

Modify faces-config.xml in the project that uses the Rules Editor component. The faces-config.xml file must have the following code within the <application> tag to support the available resource bundles:

<locale-config>      <default-locale>en</default-locale>
      <supported-locale>en</supported-locale>
      <supported-locale>ar</supported-locale>
      <supported-locale>cs</supported-locale>
      <supported-locale>da</supported-locale>
      <supported-locale>de</supported-locale>
      <supported-locale>el</supported-locale>
      <supported-locale>es</supported-locale>
      <supported-locale>fi</supported-locale>
      <supported-locale>fr</supported-locale>
      <supported-locale>hu</supported-locale>
      <supported-locale>it</supported-locale>
      <supported-locale>iw</supported-locale>
      <supported-locale>ja</supported-locale>
      <supported-locale>ko</supported-locale>
      <supported-locale>nl</supported-locale>
      <supported-locale>no</supported-locale>
      <supported-locale>pl</supported-locale>
      <supported-locale>pt-BR</supported-locale>
      <supported-locale>pt</supported-locale>
      <supported-locale>ro</supported-locale>
      <supported-locale>ru</supported-locale>
      <supported-locale>sk</supported-locale>
      <supported-locale>sv</supported-locale>
      <supported-locale>th</supported-locale>
      <supported-locale>tr</supported-locale>
      <supported-locale>zh-CN</supported-locale>
      <supported-locale>zh-TW</supported-locale>
</locale-config>

Change the browser language to the locale of your choice.
You can override the locale provided by the browser and display the user interface in a specific locale. This is done by passing that locale as an attribute to the component and modifying the f:view tag in the application using the component as shown:
```
<f:view locale="#{someBean.locale}">
```
The locale specified here should be the same as the one passed to the component using the locale attribute.

26.6 Working with Translations

This feature supports translation of aliases in Business Rules Web UI. You can have the aliases according to the locale. You can also edit the translations of aliases for different locales through translation tab or resource editor pop-up in Business Rules Web UI.

26.6.1 Enabling Translations for Consumer of Reusable Rules UI ADF Task Flow Component

To support translation of aliases, the consumers of reusable Rules UI ADF Task Flow component will have to provide locale specific resource artifacts as additional parameters while calling Rules UI ADF Task Flow. However, these additional parameters are optional and required only if the consumers want to use the enhanced translation support.

The additional parameters are:

property-name: relatedDetails
property-class: oracle.integration.console.metadata.model.share.IRelatedMetadataDetails

Example 26-1 Sample Code to Pass relatedDetails Parameter to Rules Web UI ADF Task Flow.

<taskFlow id="rulesdictflowdefinition1"
              taskFlowId="/WEB-INF/rule-dict-flow-definition.xml#rules-dict-flow-definition"
              activation="deferred" Refresh="default"
              RefreshCondition="${MyBean.refreshReqd}"
              xmlns="http://xmlns.oracle.com/adf/controller/binding">
 <parameter id="relatedDetails"
                   value="#{MyBean.relatedMetadataDetails}"/>
</taskflow>

The consumer has to pass an implementation of oracle.integration.console.metadata.model.share.IRelatedMetadataDetails

The implementation of IRelatedMetadataDetails contains the code for loading the resource bundles from the repository and also for saving the bundles files when user commits any change to rules application.

Example 26-2 Sample Code to Pass an Implementation of oracle.integration.console.metadata.model.share.IRelatedMetadataDetails.

public class MyRelatedMetadataDetails implements IRelatedMetadataDetails {
 
  private static final Locale[] LOCALES = { Locale.US, Locale.FRENCH };
 
  private static final String RESOURCE_PATH =
    "file:///C:/scratch/sumit/system/rules/";
  private static final String RESOURCE_BASE = "SimpleRule";
 
  public MyRelatedMetadataDetails() {
    super();
  }
 
  public String getDocument(IRelatedMetadataPath relatedPath) {
    String resourceSuffix = relatedPath.getValue();
    try {
      return loadResource(resourceSuffix);
    } catch (IOException e) {
      return "";
    }
  }
 
  private static String loadResource(String resourceSuffix) throws IOException {
 
    FileInputStream fis = null;
    FileChannel fc = null;
    try {
      URL url = new URL(RESOURCE_PATH + RESOURCE_BASE + resourceSuffix);
      fis = new FileInputStream(url.getFile());
      fc = fis.getChannel();
      ByteBuffer bb = ByteBuffer.allocate((int)fc.size());
      fc.read(bb);
      bb.rewind();
      return Charset.defaultCharset().decode(bb).toString();
    } finally {
      if (fis != null) {
        fis.close();
      }
      if (fc != null) {
        fc.close();
      }
    }
  }
 
  public void createDocument(IRelatedMetadataPath relatedPath,
                             String document) {
    try {
      storeResource(relatedPath.getValue(), document);
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
 
  public void saveDocument(IRelatedMetadataPath path, String document) {
    try {
      storeResource(path.getValue(), document);
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
 
  private static void storeResource(String resourceSuffix,
                                    String document) throws IOException {
    FileOutputStream fos = null;
    FileChannel fc = null;
    try {
      URL url = new URL(RESOURCE_PATH + RESOURCE_BASE + resourceSuffix);
      fos = new FileOutputStream(url.getFile());
      fc = fos.getChannel();
      ByteBuffer bb = ByteBuffer.allocateDirect(1024);
      bb.clear();
      bb.put(Charset.defaultCharset().encode(document));
      bb.flip();
      while (bb.hasRemaining()) {
        fc.write(bb);
      }
    } finally {
      if (fos != null) {
        fos.close();
      }
      if (fc != null) {
        fc.close();
      }
    }
  }
 
  public IRelatedMetadataPathFinderFactory getFinderFactory() {
    return new RelatedMetadataPathFinderFactory();
  }
 
  public List<IRelatedMetadataPath> getExisting(IRelatedMetadataPathFinder finder) {
 
    List<IRelatedMetadataPath> paths = new ArrayList<IRelatedMetadataPath>();
    for (Locale locale : LOCALES) {
      paths.add(RelatedResourceMetadataPath.buildFromLocale(locale));
    }
    return paths;
  }
 
  public class RelatedMetadataPathFinderFactory implements IRelated`MetadataPathFinderFactory {
 
    public IRelatedMetadataPathFinder getResourceFinder() {
      return new RelatedMetadataPathFinder();
    }
  }
 
  public class RelatedMetadataPathFinder implements IRelatedMetadataPathFinder {
 
    public String getType() {
      return null;
    }
 
    public IRelatedMetadataPath matches(oracle.integration.console.metadata.model.share.MetadataPath srcPath,
                                        oracle.integration.console.metadata.model.share.MetadataPath matchPath) {
      return null;
    }
  }
 
}

The consumer should use dictionaryName + "Translations_" + locale.toString() + ".xml" convention to build the name of the resource bundle file.

26.6.2 Enabling Translations for Consumer of Rules Web UI Application

To support translation of aliases, the consumer of Rules Web UI application needs to pass an attribute to the Rules Dictionary DC or Rules DC. The attribute is resourceManager which accepts an instance of type oracle.bpel.rulesshareddc.model.interface.ResourceManagerInterface.java. However, this additional parameters are optional and required only if the consumers want to use the enhanced translation support.

Example 26-3 Sample Code to Pass resourceManager Attribute to Rule Dictionary DC

<rddc:ruleDictionaryDC ruleDictModel="#{SomeBean.ruleDictModel1}"
  id="rddc1"
   resourceManager="#{SomeBean.resourceManager}">
  </rddc:ruleDictionaryDC>

Implementation of ResourceManagerInterface is provided as oracle.bpel.rulesshareddc.model.impl.ResourceManager. Consumers may create an instance of ResourceManager and pass it to corresponding UI component.

Example 26-4 Sample Code for Creating an Instance of resourceManager and Passing it to UI Component

public ResourceManagerInterface getResourceManager() {
    if (resourceManager == null) {
      resourceManager =
          new ResourceManager(loadResources(), ruleDictionary);
    }
    return resourceManager;
  }
 
  private Map<Locale, String> loadResources() {
 
    Map<Locale, String> resourceMap = new HashMap<Locale, String>();
 
    for (Locale locale : LOCALES) {
      try {
        URL url =
          new URL(RULES_FILE_PATH + "Translations_" + locale.toString() +
                  ".xml");
        String content =
          new Scanner(new File(url.getFile()), "UTF-8").useDelimiter("\\A").next();
        resourceMap.put(locale, content);
      } catch (IOException e) {
        resourceMap.put(locale, "");
        LOG.severe("Failed to load resource:" + e.getMessage());
      }
    }
    if (!resourceMap.keySet().contains(getLocale())) {
      resourceMap.put(getLocale(), "");
    }
    return resourceMap;
  }
 
  private void storeResources(Map<Locale, String> resourceMap) {
    for (Locale locale : resourceMap.keySet()) {
      try {
        URL url =
          new URL(RULES_FILE_PATH + "Translations_" + locale.toString() +
                  ".xml");
        BufferedWriter out = new BufferedWriter(new FileWriter(url.getFile()));
        out.write(resourceMap.get(locale));
        out.close();
      } catch (IOException e) {
        LOG.severe("Failed to store resource:" + e.getMessage());
      }
    }
  }

Note:

The consumer has to load all the saved resource bundles from the repository and should construct a java.util.Map (resourceMap) where java.util.Locale of the resource bundle is kept as key and the content of the resource bundle file as value which is of type java.lang.String.

The consumer should use dictionaryName + "Translations_" + locale.toString() + ".xml" convention to build the name of the resource bundle file.

The consumer has to save these resource bundles to the repository whenever the user commits any change in the application.