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:

1. Open Oracle JDeveloper.

2. From the File menu, select New.

3. Select ADF Fusion Web Application to create a new application as shown in Figure 26-7.

   Figure 26-7 Creating Fusion Web Application

   
   Description of "Figure 26-7 Creating Fusion Web Application"

4. Enter a name for the application in the Application Name field, for example, useRulesDCApp, and click Next as shown in Figure 26-8.

   Figure 26-8 Creating a Generic Application

   
   Description of "Figure 26-8 Creating a Generic Application"

5. Use the default for everything else.

6. Click Finish.

7. Right click ViewController project and select Project Properties.

8. Select Libraries and Classpath from the menu on the left.

9. 1. Click the Add Library button.

   2. Select Oracle Rules and Oracle Rules Dictionary Component from the Extension List and click OK. This adds the Rules SDK and the Rules ADF component tag libraries to the project as shown in Figure 26-9.

   3. Click OK once more to come out of Project Properties.

   Figure 26-9 Adding Library

   
   Description of "Figure 26-9 Adding Library"

   Note:

   If the 'Oracle Rules' and 'Oracle Rules Dictionary Component' do not show up in the 'Extension' List, open a SOA/BPM project within jDeveloper to load the required libraries.

10. Click Save All to save the project.

11. Check to make sure all the required tag libraries are added.

12. 1. Right click ViewController project and select Project Properties.

    2. Select JSP Tag Libraries from the menu on the left and check if all the tag libraries are added Figure 26-10.

    Figure 26-10 Checking the Required Tag Libraries

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

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

1. Check if the shared libraries are deployed using the WebLogic console of your standalone WLS.

   1. Launch WLS console. (http://host:port/console/login/LoginForm.jsp) and log in.

   2. Click Deployments. Check if oracle.rules and oracle.soa.rules_dict_dc.webapp shared libraries are deployed as showed in Figure 26-11.

2. If the shared libraries are not deployed, then refer to the previous steps to deploy the shared libraries manually.

3. In a project that uses the Rules Editor Component:

   1. Include Oracle Rules Dictionary Component in your Libraries and Classpath.

   This does not deploy these libraries by default, so the jars are not included in your project war file.

4. In a project that is deploying (i.e where you create the ear file):

   1. Add this to your weblogic-application.xml:

      <library-ref>
          <library-name>oracle.rules</library-name>
      </library-ref>
      

   2. Add this to weblogic.xml in your project's war file:

      <library-ref>
          <library-name>oracle.soa.rules_dict_dc.webapp</library-name>
      </library-ref>
      

5. Deploy your ear file in WLS.

For more information about creating an EAR file, see "How to Create an EAR File for Deployment" in Developing Fusion Web Applications with Oracle Application Development Framework.

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 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 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 permission is not granted, then the rules are view-only.

• oracle.rules.adf.permission.AddDTPermission: Displays the Add Decision Table button; if 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 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 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:

<policy-store>
    <applications>
      <application>
        <name>UseRuleDictDCWtPerm</name>
        <app-roles>
          <app-role>
            <name>Admin</name>
            <class>oracle.security.jps.service.policystore.ApplicationRole</class>
            <display-name>Admin</display-name>
            <members>
              <member>
                <name>admin</name>
                <class>oracle.security.jps.internal.core.principals.JpsXmlUserImpl</class>
              </member>
            </members>
          </app-role>
          <app-role>
            <name>BusinessUser</name>
            <class>oracle.security.jps.service.policystore.ApplicationRole</class>
            <display-name>BusinessUser</display-name>
            <members>
              <member>
                <name>buser</name>
                <class>oracle.security.jps.internal.core.principals.JpsXmlUserImpl</class>
              </member>
            </members>
          </app-role>
        </app-roles>
        <jazn-policy>
          <grant>
            <grantee>
              <principals>
                <principal>
                  <class>oracle.security.jps.service.policystore.ApplicationRole</class>
                  <name>Admin</name>
                </principal>
              </principals>
            </grantee>
            <permissions>
              <permission>
                <class>oracle.rules.adf.permission.RulesEditorPermission</class>
                <name>RulesEditorPermission</name>
                <actions>access</actions>
              </permission>
            </permissions>
          </grant>
        </jazn-policy>
      </application>
    </applications>
  </policy-store>

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.

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

Table 26-1 lists the supported attributes.

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 JDeveloper with SOA installation.The first task is to create a sample application.

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

1. Open JDeveloper, from the File Menu, select New and then select ADF Fusion Web Application to create a new application as shown in Figure 26-26.

   Figure 26-26 Create Fusion Web Application.

   
   Description of "Figure 26-26 Create Fusion Web Application."

2. Enter a name for the application in the Application Name field, for example, UseRuleDictDCApp and click Next as shown in Figure 26-27.

   Figure 26-27 Creating a Generic Application

   
   Description of "Figure 26-27 Creating a Generic Application"

3. Use the default for everything else.

4. Click Finish.

5. Right click ViewController project and select Project Properties. Select Libraries and Classpath from the menu on the left.

   1. Click Add Library.

   2. Select Oracle Rules and Oracle Rules Dictionary Component from the Extension List and click OK. This adds the Rules SDK and the Rules ADF component tag libraries to the project as shown in Figure 26-28.

      Figure 26-28 Adding a Library

      
      Description of "Figure 26-28 Adding a Library"

      Note:

      If the 'Oracle Rules' and 'Oracle Rules Dictionary Component' do not show up in the 'Extension' List, open a SOA/BPM project within jDeveloper to load the required libraries.

   3. Click OK once more to come out of Project Properties.

6. Click Save All to save the project.

7. Check to make sure all the required tag libraries are added.

   1. Right click ViewController project and select Project Properties.

   2. Select JSP Tag Libraries from the menu on the left and check if all the tag libraries are added as shown in Figure 26-29.

      Figure 26-29 JSP Tag Libraries

      
      Description of "Figure 26-29 JSP Tag Libraries"

When you're ready to deploy your application ear file to the stand-alone WLS, follow these steps to make sure everything runs smoothly.

1. Check to make sure the shared libraries are deployed using the weblogic console of your stand-alone WLS.

   1. Launch WLS console http://host:port/console/login/LoginForm.jsp and log in.

   2. Click 'Deployments' and see if 'oracle.rules' and 'oracle.soa.rules_dict_dc.webapp' shared libraries are deployed as shown in Figure 26-11.

2. If the shared libraries are not deployed, then follow the previous process to deploy the shared libraries manually.

3. In your project that uses the Rule Dictionary Editor Component, include the "Oracle Rules Dictionary Component" in your 'Libraries and Classpath'. This does not deploy these libraries by default, so the jars are not included in your project war file.

4. In the project that is finally deploying (i.e where you create the ear file):

   1. Add this to your weblogic-application.xml:

      <library-ref>
          <library-name>oracle.rules</library-name>
      </library-ref>
      

   2. Add this to weblogic.xml in your project's war file:

      <library-ref>
          <library-name>oracle.soa.rules_dict_dc.webapp</library-name>
      </library-ref>
      

5. Now you can deploy your ear file in WLS and things should work.

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

Table 26-2 lists the supported attributes.

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.

The first task is to create a sample application.

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

1. Open Oracle JDeveloper.

2. From the File menu, select New and then Custom Application to create an application.

3. Enter a name for the application in the Application Name field, for example, useRuleDictTaskFlowApp, and click Next as shown in Figure 26-35.

   Figure 26-35 Creating a Generic Task Flow Application

   
   Description of "Figure 26-35 Creating a Generic Task Flow Application"

4. Enter useRuleDictTaskFlow in the Project Name field and ensure that ADF Faces is selected in the Project Technologies tab, as shown in Figure 26-36.

   Figure 26-36 Creating a Task Flow Project

   
   Description of "Figure 26-36 Creating a Task Flow Project"

5. Click Finish to create the project.

6. Right-click the useRuleDictTaskFlow project in the Applications window 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-37.

      Figure 26-37 Choosing Tab Libraries for the Task Flow Application

      
      Description of "Figure 26-37 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-38. This adds the Rules SDK and the Rules Dictionary Task Flow JARs to the project.

      Figure 26-38 Adding the Rules SDK and Rules Dictionary Task Flow

      
      Description of "Figure 26-38 Adding the Rules SDK and Rules Dictionary Task Flow"

   5. Click OK to close the Project Properties dialog box.

7. Click Save All from the Oracle JDeveloper File menu to save the project.

8. 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 The MetadataDetails Interface.

   The steps are:

   1. Open Oracle JDeveloper.

   2. From the File menu, select New to display the New Gallery dialog box.

   3. 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.

   4. Enter the name of the Java class, for example MyMetaDataDetails.

   5. 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-39.

      Figure 26-39 Creating a Java Class that Implements the MetadataDetails Interface

      
      Description of "Figure 26-39 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 "";
          }
      }
      

9. 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 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;
       }
   }
   

10. 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;
        }
    }
    

11. Open the faces-config.xml file in Overview mode and click the + button under Managed Beans to display the Create Managed Bean dialog box.

12. Point to MyBean.java by entering MyBean in the Bean Name field and selecting session from the Scope list, as shown in Figure 26-40.

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

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

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

1. Launch the Oracle WebLogic Server Administration Console (http://host:port/console/login/LoginForm.jsp).

2. Ensure that oracle.rules is displayed in the deployments list.

3. Ensure that oracle.soa.rules_dict_dc.webapp is displayed in the deployments list.

4. 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.

5. 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.