9 Configuring Oracle Enterprise Repository Workflow

9.1.1.1 Automated Asset Registration Using Automated Workflows

The Oracle Enterprise Repository bundles pre-built BPM asset registration flows that attempt to automate the registration and governance processes defined in Understanding the Registration Process. For ease of use, you can use the predefined OBPM endpoint or create your own Web Service endpoints to subscribe to Oracle Enterprise Repository events. You may use the OBPM Designer to create new Governance workflows. There are also event monitoring and logging tools for troubleshooting and tuning purposes.

For more information about using the Automated Workflows feature, see Section 9.5, "Configuring Automated Workflows".

9.1.1.2 Accepting a Submission

This procedure is performed in the Asset Editor. (Requires appropriate permission.)

1. Open the Submitted folder.

2. Open Pending Review.

3. Select the asset to be registered, as shown in Figure 9-2.

   Figure 9-2 Asset Editor

   
   Description of "Figure 9-2 Asset Editor"
   
   

4. Options:

   1. Click Accept. The asset moves to the Under Review folder in the tree, and also appears in each of the workflow folders under the asset. The workflow folders correspond to tabs in the Asset Editor.

   2. Click Accept and Assign. The Assigning Users dialog is displayed, as shown in Figure 9-3.

      Figure 9-3 Assigning Users Dialog

      
      Description of "Figure 9-3 Assigning Users Dialog"
      
      

5. Use the << and >> buttons to move items between the Available Users and Selected Users columns.

6. Click OK.

   The asset moves to the Under Review folder in the tree and is assigned to the selected user/users, who will provide the information required for each of the tabs in the Asset Editor. The assignees also may receive a notification e-mail that lets them know they are assigned to this asset.

9.1.1.3 Registering an Asset

While certain tabs are common to all asset types, the specific Asset Editor tabs for any asset are determined by the configuration of the Type template to which the asset is assigned on submission.

Overview Tab

1. Click the Overview tab. The Overview tab is displayed, as shown in Figure 9-4.

   Figure 9-4 Overview Tab

   
   Description of "Figure 9-4 Overview Tab"
   
   

2. Enter the appropriate information in each of the fields.

3. Click Approve, as shown in Figure 9-5

   Figure 9-5 Overview Tab - Approve Button

   
   Description of "Figure 9-5 Overview Tab - Approve Button"
   
   

   The text in the Overview tab changes color and the Approve button changes to Unapprove.

   Note:

   Approval buttons in the Asset Editor are visible only to users with the appropriate permissions.

Taxonomy Tab

1. Click the Taxonomy tab. The taxonomy tab is displayed, as shown in Figure 9-6.

   Figure 9-6 Taxonomy Tab

   
   Description of "Figure 9-6 Taxonomy Tab"
   
   

   Several Categorizations are displayed.

2. Click the Assign button in the Classification section. The Assign Classifications dialog is displayed.

3. Use the options to select the appropriate classification.

   • Approved

     Approved by the Registrar for use in projects.

   • Educational

     For educational/informational purposes only. Not approved for use in projects.

   • Mandated

     Must be used whenever a project requires the functionality the asset provides. (This is especially relevant for Web services that access customer data, process payments, etc.).

   • Raw

     No assurance of quality or completeness.

   • Recommended

     Approved and successfully deployed in at least one project.

4. Click OK. The selections are listed in the Classifications section.

   Note:

   Default Categories may be customized to reflect your environment.

5. Repeat the process for each section in the Taxonomy tab.

6. Enter an appropriate keyword in the text box in the Keywords section.

7. Click Add. The new keyword appears in the Keywords list, as shown in Figure 9-7.

   Figure 9-7 Keywords List

   
   Description of "Figure 9-7 Keywords List"
   
   

   Add other keywords as necessary.

8. When the Taxonomy tab is completed, click Approve.

   The text in the Overview tab changes color and the Approve button changes to Unapprove.

Documentation Tab

1. Click the Documentation tab. The documentation tab is displayed, as shown in Figure 9-8.

   Figure 9-8 Documentation Tab

   
   Description of "Figure 9-8 Documentation Tab"
   
   

   A number of suggested document titles are listed in the Documentation window. Appropriate documentation may be associated with each of these titles, and new documents may be added to the list.

   To add a new document:

2. Click Add. The Edit dialog is displayed, as shown in Figure 9-9.

   Figure 9-9 Edit Dialog

   
   Description of "Figure 9-9 Edit Dialog"
   
   

3. Enter the appropriate information in the Name text box.

4. Click the Edit button next to the URL text box. The Edit URL dialog is displayed, as shown in Figure 9-10.

   Figure 9-10 Edit URL Dialog

   
   Description of "Figure 9-10 Edit URL Dialog"
   
   

5. Select Artifact Store File or External File, as appropriate.

6. Enter all necessary information in the available text boxes.

7. Click OK. The new document appears in the list, as shown in Figure 9-11.

   Figure 9-11 Documentation Tab - NewDocument

   
   Description of "Figure 9-11 Documentation Tab - NewDocument"
   
   

8. To edit file information for an existing document, select the document, click Edit and repeat Steps 4 to 7.

9. When finished, click Approve, as shown in Figure 9-12.

   Figure 9-12 Documentation Tab - Approve Button

   
   Description of "Figure 9-12 Documentation Tab - Approve Button"
   
   

Relationships Tab

1. Click the Relationships tab.

2. Click the Add button. The Add Relationship dialog is displayed, as shown in Figure 9-13.

   Figure 9-13 Add Relationship Dialog

   
   Description of "Figure 9-13 Add Relationship Dialog"
   
   

3. Use the Search or List All Active buttons to display assets in the Asset section of the dialog.

4. Select an asset from the list.

5. Use the Relationship Type list to select the appropriate relationship between the two assets.

   Note:

   If necessary, click the Reverse Relationship button to reverse the relationship.

6. Click OK when finished.

7. Repeat as necessary to add other asset relationships.

8. When finished, click Approve.

   See the Oracle Enterprise Repository Administration Guide for information on configuring relationships.

Administration Tab

Every asset in Oracle Enterprise Repository has an Administration tab. Use the Administration tab to:

• Track the asset Created, Submitted, Accepted workflow.

• Assign users to review and approve information on the other tabs.

• Change the asset's status:

  • Active

  • Inactive

  • Retired

  • Deleted

• View asset notes and reviews.

• Complete the registration process by clicking the Register button, as shown in Figure 9-14.

  Figure 9-14 Administration Tab

  
  Description of "Figure 9-14 Administration Tab"
  
  

  A registered asset can include unapproved tabs.

  Whenever a tab is approved, a TabApprovedEvent is triggered. This event along with the tab name and certain other metadata is sent to the workflows for processing. This event is used by the Multi-Tier workflows where depending on the tab approved and depending on the configuration, the workflows will decide if the next tier in the approval process needs to be assigned or not.

  Also the users can wire the TabApprovedEvent to any of the pre-defined workflows such as ChangeAssetLifecycle etc. So, this is also tied to the Tab names.

9.1.1.4 Completing the Tab Approval Process

While certain tabs are common to all asset types, the specific Asset Editor tabs for any asset are determined by the configuration of the Type template to which the asset is assigned on submission. Similarly, the metadata elements that appear on any tab are also determined by the Type configuration. While the specific tabs and elements may vary from Type to Type, the approval process for each tab involves the entry and/or review of the information in each element. Each time a you click the Approve on a tab, you are prompted to save the changes.

Process to approve a tab for a specific type configuration

1. In the Oracle Enterprise Repository screen, click the My Stuff link. The My Stuff section is displayed.

2. Select Assigned Assets and then select the asset for which you would want to approve the tab(s).

3. Click the Edit button in the right-bottom pane of the page. The Asset Editor dialog is displayed.

4. Select the tab that you want to approve.

5. Review the information in that tab.

   Figure 9-15 Asset Editor Window

   
   Description of "Figure 9-15 Asset Editor Window"
   
   

6. Click the Approve button. You are prompted to save the changes you made.

7. Click OK in the Select an Option dialog.

8. Go back to the Assigned Assets page and refresh to note the changes. In the Tab Approval Status pane, you will notice that Approved has one item against it, as shown in Figure 9-16.

   Figure 9-16 Approved Status Pane

   
   Description of "Figure 9-16 Approved Status Pane"
   
   

9.1.1.5 Audit Log, Reviews, and Notes

When an Asset is updated, a record of the User, date and action appears in the Audit Log. Logged changes include:

• Asset Creation

• Asset Update

• Changes in an Asset's Registration Status

• Changes in an Asset's Active Status

• Completion of an approval tab

The log entry is added to the list in the Logs section on the asset's Administration tab. (It may be necessary to click the Refresh button in the Logs section.)

Adding a Note to the Asset

1. Click Add Note in the File menu. The Add a Note for... dialog is displayed, as shown in Figure 9-17.

   Figure 9-17 Add a Note for ... Dialog

   
   Description of "Figure 9-17 Add a Note for ... Dialog"
   
   

2. Enter the appropriate information in the text box.

3. Click OK. The note is added to the list in the Logs section on the asset's Administration tab. (It may be necessary to click the Refresh button in the Logs section.)

9.1.2.1 Step 1: Requirements

Before installing the Oracle Enterprise Repository Workflow consider these requirements:

• Apache ANT version 1.6.5 or later

• Oracle BPM 10.3 Enterprise Install

• Oracle Enterprise Repository 11g

• Oracle Enterprise Repository URL and port number

• DBA User account able to create users/tables/indexes within the selected database server

• Appropriate JDBC drivers for your selected database server

• Identify the DB permissions required to do the install

• JDK version 1.6 or later

• Download and apply the latest hotfix build to the OBPM installation

9.1.2.2 Step 2: Install OBPM and Apply Patch

Install OBPM in the <ORACLE_HOME>/obpm/enterprise directory. After you have successfully installed OBPM, update it with the OBPM Hotfix patch, which is found in the Oracle MetaLink at http://metalink.oracle.com. This section contains the following topics:

• "Download the Hotfix Patch"

• "Apply the Hotfix Patch"

• "Update the OBPM JVM Version"

Download the Hotfix Patch

Perform the following steps to download the Hotfix patch from MetaLink:

1. Log into Oracle MetaLink at http://metalink.oracle.com/.

2. Click the Patches & Updates link.

3. In the Patch Search section, click the Product or Family (Advanced Search) link.

4. Enter Business Process Management Suite in the Product is field.

5. Select Oracle BPM 10.3.1 from the Release is list.

6. Click Search.

7. Download the latest hotfix for Studio or EnterpriseSA, for the enterprise standalone environment.

8. Extract the fix zip.

9. Install the latest hotfix into the environment.

Apply the Hotfix Patch

For more information about how to apply the hotfix patch for Studio or Enterprise, see the Oracle BPM Installation Guide at

http://download.oracle.com/docs/cd/E13154_01/bpm/docs65/installguide/index.html?t=modules/installation/c_Updating.html

Update the OBPM JVM Version

For more information about how to update the OBPM JVM to 1.6 + for Studio, see http://download.oracle.com/docs/cd/E13154_01/bpm/docs65/installguide/index.html?t=modules/installation/t_Changing_Studio_JVM.html.

For more information about how to update the OBPM JVM to 1.6 + for Enterprise, see http://download.oracle.com/docs/cd/E13154_01/bpm/docs65/installguide/index.html?t=modules/installation/t_Changing_Enterprise_JVM.html.

9.1.2.3 Step 3: Obtain the Oracle Enterprise Repository Workflow Installer

Obtain the Oracle Enterprise Repository Workflow installer from the following directory within the Oracle Enterprise Repository installation location: ORACLE_HOME/repositoryXXX/core/tools/solutions/11.1.1.x.0-OBPM-Workflow-Management-Scripts.zip.

Extract the zip file into the Oracle_HOME/obpm directory on the server where Oracle BPM is installed. Two directories are created from this zip file: OBPM_SetupScripts and workflow.

9.1.2.4 Step 4: Configure the build.properties File

Enter the correct values for the ORACLE_HOME\obpm\OBPM_SetupScripts\build.properties file. Table 9-1 describes the properties listed in the build.properties files and its descriptions.

9.1.2.5 Step 5: Configure the setenv File

Enter the correct values for the ORACLE_HOME\obpm\OBPM_SetupScripts\setenv.bat (Windows), or /setenv.sh file (Unix). Table 9-2 describes the setenv file properties and its descriptions.

9.1.2.6 Step 6: Edit the workflow.xml File

Edit the workflow.xml file located within the ORACLE_HOME/obpm/OBPM_SetupScripts/workflow.xml and modify the URI to match the URI of the Oracle Enterprise Repository installation. Retain the /services/FlashlineRegistry at the end of the path reference. Also, modify all the user credentials in the workflow.xml file to their correct values.

9.1.2.7 Step 7: Encrypt the workflow.xml File

Encrypt the Oracle Enterprise Repository Workflow configuration file, workflow.xml. For more information about how to encrypt the workflow.xml file, see Section 5.3.3, "Workflow Configuration File".

9.1.2.8 Step 8: Copy the JDBC jar(s)

Copy the JDBC jar(s) for your database to the $Oracle_HOME\OBPM_SetupScripts\ext directory.

9.1.2.9 Step 9: Change Permissions

Change permissions for the OBPM_SetupScripts and workflow folders to make them writeable.

9.1.2.10 Step 10: Run the Setup Script

To run the setenv.bat or setenv.sh file:

1. Open a command, or shell window.

2. Navigate to the $Oracle_HOME\OBPM_SetupScripts directory.

3. Run the following command:

   setenv.bat (Windows)

   setenv.sh (Unix)

4. Run the following command:

   ant create-fdi

5. Run the following command:

   ant install-workflow

9.1.2.11 Step 11: Verify the Setup Script

To validate the success of the setup script:

1. Open the Oracle BPM Admin Center application.

2. Click Start BPM Applications.

3. Click Launch Process Administrator.

4. Access the Web console Web interface and login using the credentials for the Oracle BPM Web console application. These credentials are specified in the build.properties file in the fuego.fdi.admin.id and fuego.fdi.admin.password properties.

5. Select the Engines link in the left side menu.

   The aler_engine engine is displayed with a status of Not running.

6. Click the option to start the engine using the left most icon in the Engine Actions column.

   Once the engine is running, the status of the engine displayed is Ready.

7. Validate that the Oracle BPM service endpoint is listening appropriately. Use a Web browser to connect to the Oracle BPM server at port 9000, for example, http://localhost:9000/albpmServices/aler_engine/ws.

8. Click the link for albpmServices/oer_engine/ws link.

   Two services are then listed, StatusChangeEndpointServiceListener and RefreshConfigServiceListener.

9. Click the Oracle Enterprise Repository installation within the WEB-INF/classes/EndPointEventSubscription.xml file and modify the <sub:host> element to contain the IP address or the fully qualified host name of the server where Oracle BPM is installed.

   Oracle Enterprise Repository workflows are now deployed.

   To run workflows successfully, you must encrypt passwords in the xml file and then restart the Oracle Enterprise Repository server. If the EndPointEventSubscription.xml has clear text password, then the events do not get delivered to Oracle BPM.

   If the password is not encrypted, then the following log message is displayed in the <ORACLE_HOME>\user_projects\domains\<oer_domain>\eventing.log file:

   Insufficient subscription data. End point with name [<ENDPOINT_NAME>] requires an encrypted password...

   Note:

   If any build failure or errors appear during the ANT deployment of the workflows, follow these steps:

   1. Drop the FDI Schema user (as specified for fuego.fdi.db.schema in build.properties file) from Database.

   2. Drop the FDI Engine user (as specified for fuego.server.db.schema in build.properties file) from Database.

   3. Make sure the BPM Applications are not running and obpmadmcenter.exe is closed.

   4. Run setenv.bat or setenv.sh.

   5. Run the ant create-fdi command.

   6. Run the ant install-workflow command.

9.2.1.1 Software Components

Automated Workflows includes the following software components:

9.2.1.2 Automated Workflows

The Automated Workflows can be run out-of-the box or can be tailored to suit your environment. For more information, see Section 9.5, "Configuring Automated Workflows".

• Community Assignment Flow: provides a way to automate the asset acceptance, assignment, and registration process by allowing the configuration of automated assignment rules and also provides the notion of federated registrars among different authorities. For more information, see Section 9.5.4.1, "Configuring Community Flows".

• Automated Acceptance and Automated Registration Flow: in addition to using the Community Flows to automatically accept and register the assets, a number of user roles can be used to accept and register assets. For more information, see Section 9.5.4.2, "Configuring Automated Acceptance and Automated Registration Flows".

• Multi-tier Approval Flow: structures the tab approval process in multiple steps called tiers. Asset approval tabs can be grouped in tiers, and the Mult-tier Approval flow tracks each tier to verify whether all the tabs are approved by the designated approvers. As soon as the last tab in a tier is approved, the flow starts the next tier by assigning the asset to the next level of designated approvers. For more information, see Section 9.5.5, "Multi-tier Automatic Assignment Flows".

• Metadata Change Flow: exposes a flexible framework where state changes or metadata changes can be wired to actions. The Metadata Change flows come with the a set of pre-bundled actions. New actions can be developed in the form of Oracle Enterprise Repository flows and can be plugged in. For more information, see Section 9.5.6, "Metadata Change Flows".

• Time-based Escalation Flow: track assets in various states and notifies all interested parties. There are four different kinds of Time-based Escalation flows and each one can be configured individually. For more information, see Section 9.5.7, "Time-based Escalation Flows".

• Validation Expiration Flow: tracks expired assets prior to the specified expiration date, as well as at the day of expiration, and sends warning notifications to all interested parties. For more information, see Section 9.5.8, "Validation Expiration Flows".

• AutoSyncAlerToUddi Flow: moves a service from Oracle Enterprise Repository to Oracle Service Registry when the Asset Lifecycle Stage is changed from Stage 4 - Build to Stage 5 - Production. For more information, see "Section 10.3.1.1, "Invoking the Oracle Registry Repository Exchange Utility Using Workflows".

9.2.1.3 Event Management Tools

There are event monitoring and logging tools for troubleshooting and tuning purposes.

9.2.2.1 Steps to Configure the Oracle Enterprise Repository Event Manager

The Event Manager is a component embedded within Oracle Enterprise Repository that manages event subscriptions, event persistence, event filtering, and event delivery. Web Service endpoints can subscribe to the Event Manager's Subscription Manager and the events that are generated within Oracle Enterprise Repository are delivered to the Web Service endpoints.

Figure 9-18 shows the different components that are involved.

Figure 9-18 Advanced Registration Flow Components

Description of "Figure 9-18 Advanced Registration Flow Components"

The Event Manager uses an embedded version of Apache ActiveMQ JMS Server that is enabled by default. The embedded JMS server is configured to run out-of-the-box without any additional configuration. However, you can also configure the Event Manager to use an external Java-based message broker, such as Weblogic Server JMS or IBM MQSeries.

For more information about configuring the Event Manager, see Section 9.3, "Configuring the Oracle Enterprise Repository Event Manager".

9.2.2.2 Use Cases

This section describes the use cases for configuring Oracle Enterprise Repository Event Manager:

• Oracle Enterprise Repository features pre-bundled Oracle Business Process Management flows and a Web Service endpoint that is by default registered with the Event Manager's Subscription Manager. All the triggered events are delivered to this Oracle Business Process Management endpoint, which then attempts to automate Oracle Enterprise Repository processes, such as the asset registration process, tracking metadata changes, and taking pre-defined actions.

• You can also write your own Web Service endpoints, subscribe them with the Event Manager, and start getting the events to solve your specific business needs.

9.2.2.3 Configuring the Event Manager

After Oracle Enterprise Repository is installed, configure the Event Manager as follows.

1. The Event Manager needs to be enabled in Oracle Enterprise Repository to allow the Event Manager to send events to external Web Service endpoints. You can either:

   • Enable the cmee.eventframework.enabled=true property in the eventing.properties file in the <OER Domain>\WEB-INF\classes directory.

     or

   • This property can also be enabled using the Oracle Enterprise Repository Web-based console's System Settings, as explained in "Configuring the Event Manager's System Settings" on page 3-2.

2. The default Eventing cmee.eventframework.delivery.sleep and cmee.eventframework.store.sleep property values can also be tuned to control the overall performance of Oracle Enterprise Repository and the Web Service endpoints. These properties directly impact the number of events that get triggered per second by the Event Manager. For example, If a faster response is required for testing purposes, the default cmee.eventframework.store.sleep value of 7200 seconds should be changed to a reasonable testing amount.

3. The Event Manager uses the same logging framework as Oracle Enterprise Repository. By default, logging is enabled to go to a file, but you direct the debug statements to go to the console by appending the following categories to the log4fl.properties file in the <OER Domain>\WEB-INF\classes directory.

   # eventing subsystem
   log4j.category.com.bea.infra.event.core= debug,eventingLog,stdout
   log4j.category.com.bea.infra.event.dm= debug,eventingLog,stdout
   log4j.category.com.bea.infra.event.facade= debug,eventingLog,stdout
   log4j.category.com.bea.infra.event.notifier= debug,eventingLog,stdout
   log4j.category.com.bea.infra.event.store= debug,eventingLog,stdout
   log4j.category.com.bea.infra.event.sub= debug,eventingLog,stdout
   

4. Configure the Web Service subscriptions with the Event Manager's Subscription Manager.

   Note:

   By default the Subscription Manager is configured to work out-of-the-box with the Oracle Business Process Management Process Engine if the Oracle Business Process Management Process Engine is running on the same machine as Oracle Enterprise Repository. You can skip this step if this is the case because the default settings are ready to run.

   As shown below, the following information may need to be changed within the EndPointEventSubscription.xml file under <OER Domain>\WEB-INF\classes directory, depending on the requirement:

   • Host: If the Web Service Endpoint is running in a host other than Oracle Enterprise Repository. If it is the same host, then leave the default unchanged.

   • Port: Specify the port of the Web Service Endpoint. If Oracle Business Process Management is used as the Process Engine, then leave the default unchanged.

   • URI: Specify the URI of the Web Service. If Oracle Business Process Management is used as the Process Engine, then leave the default unchanged\

   • Operation Name: If Oracle Business Process Management is used as the Process Engine, leave the default unchanged. Please refer to the WSDL within the eventNotifier.jar file located in <OER Webapp path>/WEB-INF/lib for the available operations.

   • User Name/Password: Used only if Oracle Business Process Management is used as the Process Engine. The default user name/password for OBPM is aler_workflow_user/<encrypted_password>. The default password text used is aler_workflow_pass.

   • Expression: Default is empty, which means all the events are delivered.

5. Restart Oracle Enterprise Repository for the configuration changes to take effect.

9.2.2.4 Triggering an Asset Event

Follow these steps to make sure that events are triggered after the configuring the Event Manager.

1. Launch the Oracle Enterprise Repository Asset Editor from the Web-based console. For information on using the Oracle Enterprise Repository Asset Editor, see Oracle Fusion Middleware User Guide for Oracle Enterprise Repository.

2. Create a new asset, as shown in Figure 9-19.

   Figure 9-19 Oracle Enterprise Repository Asset Editor - Create New Asset

   
   Description of "Figure 9-19 Oracle Enterprise Repository Asset Editor - Create New Asset"
   
   

   Note:

   The Asset Type should be Service.

3. Click OK to submit the asset.

4. After the asset is submitted, switch to the Oracle Enterprise Repository console to verify the following logging statements printed to the console, as shown in Figure 9-20.

   Figure 9-20 Event Monitoring Console

   
   Description of "Figure 9-20 Event Monitoring Console"
   
   

5. The Event Monitoring tool can be used to view the payload of the event that is delivered. For more information about how to monitor and manage events, see Section 9.7, "Monitoring and Managing Events".

The HarvesterSettings.xml file can be optionally configured to set the <triggerEvent> tag turned to true or false so as to turn the BPM workflow eventing enabled or disabled respectively for the harvester tasks.

9.2.2.5 Steps to Configure and Run the Oracle Business Process Management Process Engine

When Oracle Enterprise Repository is installed, you are directed to install and configure Oracle Business Process Management. This section assumes that Oracle Business Process Management was successfully installed.

After the Event Manager is ready to send events, the Oracle Business Process Management Process Engine needs to be configured and be ready to process the events. When Oracle Enterprise Repository is installed, it provides an option to install and configure the Process Engine. This section assumes that the Process Engine was successfully installed before following these steps.

To launch the Oracle Business Process Management Admin Center, double-click the obpmadmcenter.exe file in the <OBPM Enterprise Home>\bin directory.

9.2.2.6 Triggering an Asset Submission Event

Once the Oracle Business Process Management Process Engine is configured and running, follow these steps to process an asset submission event.

1. Launch the Oracle Enterprise Repository Asset Editor from the Web console.

   For information about using the Oracle Enterprise Repository Asset Editor, see Oracle Fusion Middleware User Guide for Oracle Enterprise Repository.

2. Create a new asset from File ->New, as shown in Figure 9-1.

   Note:

   The Asset Type should be Service.

3. Click OK to submit the asset.

4. After the asset is submitted, switch to the Oracle Business Process Management Log Viewer to ensure that the event is processed. To launch the Log Viewer, double-click the obpmlogviewer.exe file in the <OBPM Enterprise Home>\bin directory.

5. Turn on the "Debug" level on the Log page of the Process Engine using the Process Administrator preference settings, as shown in Figure 9-21. By default, the level is set to "Warning."

   Figure 9-21 Oracle Business Process Management Process Administrator - Logging Preferences

   
   Description of "Figure 9-21 Oracle Business Process Management Process Administrator - Logging Preferences"
   
   

6. When you turn on the Debug level though you will notice that the Process Engine prints a lot of information, not just for the Oracle Enterprise Repository Automated Workflows, but other Process Engine information as well. To filter the Oracle Enterprise Repository logging, follow these steps, as shown in Figure 9-22:

   1. Within the Log viewer, select Message in the left-most list box.

   2. Select Begins With in the next list box.

   3. Type OER: in the text box.

   4. Click the Apply Filter button.

   Figure 9-22 Oracle Business Process Management Log Viewer

   
   Description of "Figure 9-22 Oracle Business Process Management Log Viewer"
   
   

7. After the "OER: Done accepting the asset" message is displayed in the Log Viewer, switch back to the Asset Editor, and then refresh the Administration tab using the View -> Refresh Tree command.

8. Verify that the "Accepted" section is updated with the latest data, as shown in Figure 9-23.

   Figure 9-23 Oracle Enterprise Repository Asset Editor - Administration Tab

   
   Description of "Figure 9-23 Oracle Enterprise Repository Asset Editor - Administration Tab"
   
   

9. Also verify that the Audit Log on the Administration tab is updated, as shown in Figure 9-24.

   Figure 9-24 Oracle Enterprise Repository Asset Editor - Audit Log

   
   Description of "Figure 9-24 Oracle Enterprise Repository Asset Editor - Audit Log"
   
   

9.3.2.1 Enabling the Event Manager

The Event Manager needs to be enabled in Oracle Enterprise Repository to allow the Event Manager to send events to external Web Service endpoints.

1. Click System Settings in the sidebar on the Oracle Enterprise Repository Admin screen.

2. Enter Event in the System Settings Search box to view all the Event Manager related settings.

3. Click True next to the Enable Event Manager property, cmee.eventframework.enabled.

4. Click Save.

5. Restart Oracle Enterprise Repository for the configuration changes to take effect.

9.3.2.2 Configuring Optional Event Manager Settings

There are some optional "Eventing" properties that you can use to tune the Event Manager performance.

This section contains the following topics:

• Section 9.3.2.2.1, "Eventing Manager Notifier Thread Sleep (seconds)"

• Section 9.3.2.2.2, "Eventing Manager Store Thread Sleep (seconds)"

• Section 9.3.2.2.3, "Eventing Manager Store Delivery Sleep (seconds)"

• Section 9.3.2.2.4, "Batch Size for Event Manager Deliveries"

9.3.3.1 Configuring Web Service Endpoints

The Event Manager uses the EndPointEventSubscription.xml file to load information about the Web Service endpoints where events need to be delivered. The host, port, URI, user, and password of the predefined ALPBM endpoint, or user-defined Web Service endpoint, need to be configured, as shown in this example snippet:

<sub:EventSubscriptionData
 xmlns:sub="http://www.bea.com/infra/events/subscription" xmlns:xsi=???
  <sub:eventSubscription>
    <sub:endPoint name="ALBPMEndpoint">
      <sub:host>maplanis01.amer.bea.com</sub:host>
      <sub:port>9000</sub:port>
      <sub:uri>fuegoServices/ws/StatusChangeEnpointServiceListener</sub:uri>
      <sub:targetNamespace>StatusChangeEndpoint</sub:targetNamespace>
      <sub:operationName>newEvent</sub:operationName>
      <sub:authenticationData>
        <sub:basicAuthentication>
          <sub:username>aler_workflow_user</sub:username>
          <sub:password>*******</sub:password>
        </sub:basicAuthentication>
      </sub:authenticationData>
    </sub:endPoint>
    <sub:notifierClass>com.bea.infra.event.notifier.help.AlbpmHTTPEventNotifier   
 </sub:notifierClass>
    <sub:expression>id &gt; 500</sub:expression>
  </sub:eventSubscription>
</sub:EventSubscriptionData>

As many endpoints can be added as desired and the endpoints can be located in different hosts or ports and the events can be load balanced. The pre-defined Advanced Registration Flow has just one endpoint called "StatusChangeEndpoint".

9.3.3.2 Setting the Expression to Filter Events

Events can be filtered based on the value entered in the expression element. This section contains the following topics:

• Section 9.3.3.2.1, "Delivering all Events to an Endpoint"

• Section 9.3.3.2.2, "Delivering Events to an Endpoint Filtered by Event Type"

• Section 9.3.3.2.3, "Delivering Events to an Endpoint Filtered Using a JMS Message Selector"

• Section 9.3.3.2.4, "JMS Message Selector Examples"

<sub:expression></sub:expression>

<sub:expression> eventdata_name ='urn:com:bea.aler:events:type:AssetSubmission'</sub:expression>

eventdata_name ='urn:com:bea.aler:events:type:AssetSubmission' 
OR
eventdata_name ='urn:com:bea.aler:events:type:AssetAccepted'

submittedby_emailaddress = [email protected]
asset_description = Test Asset
submittedby_name = aler_workflow_user
submittedby_id = 99
asset_community = Java
eventdata_description = new aler event
eventsource_componentname = OER
asset_name = TestAsset
eventsource_componenttype = OER 10.3
asset_typeid = 154
eventdata_eventid = d0cdac55-c78f-4a29-8aec-6ea9ba8d31f1
eventdata_name = urn:com:bea:aler:events:type:MetaDataChange:name
asset_activestatus = ACTIVE
eventsource_location = ALERCore
asset_id = 50100
eventdata_version = ver1.0
asset_version = 1

9.4.2.1 Starting the Oracle Business Process Management Admin Center

Follow these steps to launch the Oracle Business Process Management Admin Center:

1. Navigate to the <ORACLE_HOME>\obpm\enterprise\bin directory and double-click one of the following files:

   • obpmadmcenter.exe (Windows or UNIX GUI-based)

   • ./startwebconsole.sh (UNIX console-based). Then point your browser to http://<host>:8585/webconsole (for example, http://localhost:8585/webconsole).

2. On the Admin Center page, click the Start BPM Web Applications option, as shown in Figure 9-26.

   Figure 9-26 Oracle Business Process Management Admin Center

   
   Description of "Figure 9-26 Oracle Business Process Management Admin Center"
   
   

3. When it becomes available, click the Launch Process Administrator option to launch the Process Administrator.

4. When prompted to enter the required credentials, enter the BPM admin user name and password that was used on the FDI User Credentials panel during the installation process. The recommended example for these credentials is bpm_admin for the user name and password.

9.4.2.2 Starting the Oracle Business Process Management Process Engine

Follow these steps to start the Oracle Business Process Management Process Engine.

1. On the Oracle Business Process Management Process Administrator page, open the aler_engine Process Engine by clicking the Engine link on the left side of the page, as shown in Figure 9-27.

   Figure 9-27 Oracle Business Process Management Process Administrator - Start / Stop

   
   Description of "Figure 9-27 Oracle Business Process Management Process Administrator - Start / Stop"
   
   

2. Start the aler_engine by clicking the Start icon under Engine Actions on the right side of the page. Starting the engine may take several minutes to complete. Make sure that the status of the engine is Ready.

Once you the Oracle Business Process Management Process Engine is running, you can stop it and then restart it to load your latest workflow.xml changes.

9.4.2.3 Defining the Oracle Business Process Management Participants

This section explains how to define the Oracle Business Process Management Process Engine participants.

9.4.2.3.2 Advanced Registration Flow Participant

When the Oracle Business Process Management Process Engine is installed by Oracle's Products installer, it creates aler_workflow_user as the Advanced Registration Flow user. By default, the password is set as aler_workflow_pass, but the password can be changed in the Process Administrator by selecting Participants in the navigator and clicking Change the password in the Advanced Properties section, as shown in Figure 9-28.

Figure 9-28 Oracle Business Process Management Process Administrator - Change Password

Description of "Figure 9-28 Oracle Business Process Management Process Administrator - Change Password"

A new participant can also be created for the role of "administrator" and this new participant can be configured in the Event Manager's Subscription Manager file. For more information, see Section 9.3.3, "Configuring the Subscription Manager".

9.4.3.1 Advanced Properties

Go to the Engines, <Engine Name>, Engine Nodes, Advanced Properties page. Figure 9-29 illustrates the Oracle Business Process Management Process Administrator - Advanced Properties page.

Figure 9-29 Oracle Business Process Management Process Administrator - Advanced Properties

Description of "Figure 9-29 Oracle Business Process Management Process Administrator - Advanced Properties"

9.4.3.2 Database Runtime Properties

Go to the Engines, <Engine Name>, Edit Engine Database Configuration page. Figure 9-30 illustrates the Oracle Business Process Management Process Administrator - Database Runtime page.

Figure 9-30 Oracle Business Process Management Process Administrator - Database Runtime

Description of "Figure 9-30 Oracle Business Process Management Process Administrator - Database Runtime"

9.4.3.3 Memory and Execution Thread Properties

Go to the Engines, <Engine Name>, Execution page. Figure 9-31 illustrates the Oracle Business Process Management Process Administrator - Memory and Threads page.

Figure 9-31 Oracle Business Process Management Process Administrator - Memory and Threads

Description of "Figure 9-31 Oracle Business Process Management Process Administrator - Memory and Threads"

9.4.5.1 Filtering Event Log Messages for Oracle Enterprise Repository Flows

You can filter log messages so that the Automated Workflows log Info, Debug, and Fatal messages.

Turn on the "Debug" level on the Log page of the Process Engine using the Process Administrator preference settings. By default, the level is set to "Warning".

Go to the Engines, <Engine Name>, Log page. Figure 9-32 illustrates the Oracle Business Process Management Process Administrator - Logging Preferences page.

Figure 9-32 Oracle Business Process Management Process Administrator - Logging Preferences

Description of "Figure 9-32 Oracle Business Process Management Process Administrator - Logging Preferences"

When you turn on the Debug level though you will notice that the Process Engine prints a lot of information, not just for the Oracle Enterprise Repository Automated Workflows, but other Process Engine information as well. To filter the debug logging to show only the Oracle Enterprise Repository flow-related information, follow these steps, as shown in Figure 9-33:

1. Within the Log viewer, select Message in the left-most list box.

2. Select Begins With in the next list box.

3. Type OER: in the text box.

4. Click the Apply Filter button.

The Oracle Enterprise Repository Event Logging prints a prefix of ALER: for all logged event messages, as shown here.

Figure 9-33 Log Viewer With OER Filter

Description of "Figure 9-33 Log Viewer With OER Filter"

9.5.2.1 Generating a Workflow Configuration File

Generate the workflow.xml file using the Generate Workflow Config tool (config_gen.bat). This tool connects to Oracle Enterprise Repository and creates a bootstrapping file that can be customized. For more information about generating the workflow.xml file, see Section 9.7.4, "Configuring Workflow".

1. From a command prompt, run the Generate Workflow Config tool as follows:

    > config_gen.bat URI User Password ConfigDir
   

   where

   • URI = OER URI, using the following format:

     http://<host>:<port>/<oer web app name>/services/FlashlineRegistry

     For example: http://localhost:7001/alerbuild/services/FlashlineRegistry

   • User = Oracle Enterprise Repository user name

   • Password = Oracle Enterprise Repository password

   • ConfigDir = the directory where the workflow.xml file is created

2. Copy the newly generated workflow.xml file to the <Oracle Business Process Management Enterprise Edition>/enterprise/server/aler_engine directory.

3. Open the workflow.xml file using the XML editor of choice.

9.5.2.2 Defining the Oracle Enterprise Repository Connection and Registrar

The Workflow Configuration file loads the Oracle Enterprise Repository connection and registrar information from the following XML data.

<alerconnection>
  <uri>http://localhost.7001/aler/services/FlashlineRegistry</uri>
  <registrar>
    <user>admin</user>
    <password>******</password>
  </registrar>
</alerconnection>

9.5.2.3 Encrypting the Registrar User Password

The Security Encrypt Password tool (runWfSecurity.bat) allows you to encrypt the registrar passwords that are stored in the Workflow Config file. The tool recursively scans the file and encrypts all the password elements it encounters.

For more information, see Section 9.7.5, "Encrypting Your Passwords".

9.5.4.1 Configuring Community Flows

The Community flow provides a way to automate the asset acceptance, assignment, and registration process by allowing the configuration of automated assignment rules and also introduces the notion of federated registrars among different authorities. Rather than spamming many registrars across all communities (through the system registrar notification), you could limit the system registrar to one or a few individuals, and let the Automatic Acceptance flow accept assets on behalf of a registrar-of-record for the community. The Community flow feature can distribute asset submissions to those with the authority to approve them for the community.

The Community flow can be used to address the following scenarios:

• Automatic federated registrars support for acceptance as opposed to a single registrar getting many notifications about newly submitted assets.

• Even if asset acceptance is manual, the Community flow can be used to automate the assignment of the asset approvals to pre-defined approvers. Creating pre-defined approvers can be achieved in two ways:

  • Creating a list of pre-defined approvers for all the tabs in that asset.

  • Using multi-tier assignment (this is the same as the Multi-Tier flow but it operates within the Community).

• Automation of the registration process. The flows will automatically register the assets if the following conditions happen:

  1. When all the tabs approved

  2. When the last tier in a Multi-tier process is completed

  3. Or whichever happens first.

  The Communities are configured within the flow configuration and Asset Types, Producing Projects, etc., can point to a Community.

  Figure 9-35 demonstrates how a Community for an asset is located by the flow, as well as how the rules for automatic acceptance are located by the flow.

  Figure 9-35 Automatic Asset Acceptance Flowchart

  
  Description of "Figure 9-35 Automatic Asset Acceptance Flowchart"
  
  

  Note:

  The same flowchart applies for automatic Registration. Simply substitute autoRegister for autoAccept.

<producingProjectSettings>
   <producingProject name="Registry" community="SOA Center of Excellence
   id="40000"/>
</producingProjectSettings>

  <assetType name="Application" community="SOA Center of Excellence
  id="158">
    <allTabs>

  <communities name="SOA Center of Excellence autoAccept="true">

  <communities name="Java" autoAccept="true">
    <approvers>
      <alerid>5003</alerid>
      <alerid>5004</alerid>
    </approvers>

  <communities name="SOA Center of Excellence autoAccept="true"
   autoRegister="true">

9.5.4.2 Configuring Automated Acceptance and Automated Registration Flows

Besides using the Community flows to automatically accept and register assets, the following rules can be used to accept and register assets, as illustrated in Figure 9-34.

  <assetType name="Application" autoAccept="true" autoRegister="true"
  id="158">
    <allTabs>
      <tab name="Overview"/>
      <tab name="Application Lifecycle"/>
    </allTabs>

  <catgorizationTypeSettings action="true">
    <catgorizationType name="AssetFunction" type "100">
      <catgorizations name="Application Adapters" autoAccept="false"/>
      <catgorizations name="Customer Information Acquisition" autoAccept="false"/>
      <catgorizations name="eCommerce Frameworks" autoAccept="false"/>
    </catgorizationType>

  <automation>
    <autoRoles>
      <role>admin</role>
      <role>accesAdminstrator</role>
    </autoRoles>
    <autoApprovalTabs>
      <tab name="Documentation"/>
    </autoApprovalTabs>
  </automation>

9.5.5.1 Use Cases

• In some cases, it may be desired to assign tabs for Tab Approval in multiple steps called Tiers. For example, it may be desirable to approve the Architecture tab first before approving the Documentation tab. This is because any architectural issue needs to be corrected first before it comes to the attention of the Documentation expert.

• In previous releases, Tab Approval was done manually by the registrar by manually tracking the status of each tab approval and then assigning the tabs for the next tier level approvals. With the Multi-tier flows, this process is automated by the flows.

Figure 9-38 demonstrates the flow of the Mult-tier process.

Figure 9-38 Multi-tier Automatic Assignment Flowchart

Description of "Figure 9-38 Multi-tier Automatic Assignment Flowchart"

9.5.5.2 Using an <alerid> for Tab Approvals

When the workflow.xml file is generated, the following XML section is created under the <allAssetSettings> section. These are all the users that are created in Oracle Enterprise Repository.

  <alerUsers>
    <user name="admin" alerid="99"/>
    <user name="allpriv" alerid="50000"/>
    <user name="nopriv" alerid="50001"/>
    <user name="tier1" alerid="50002"/>
    <user name="tier2" alerid="50003"/>
    <user name="mrsmith" alerid="50004"/>
  </alerUsers>

As the Workflow Administrator, you need to identify the user(s) by name that you want to use for approving the asset tabs and use the corresponding <alerid>. Then you can use that <alerid> in the Workflow XML, such as in the following Multi-tier approval flow:

  <tiers>
    <tier name="Tier1">
      <approvers>
        <alerid>50001</alerid>
      </approvers>
      <tabs>
        <tab name="Overview"/>
        <tab name="Technical"/>
        <tab name="Documentation"/>
      </tabs>
  </tier>

9.5.5.3 Setting Up a Community for Multi-tier Tab Approval

The following example demonstrates how the Multi-tier flow is configured for tab approvers in the "SOA Center of Excellence" community to automatically accept tabs.

<communities name="SOA Center of Excellence autoAccept="true">
    <tiers>
      <tier name="Tier1">
        <approvers>
          <alerid>5002</alerid>
        </approvers>
        <tabs>
          <tab name="Overview">
          <tab name="Taxonomy">
        </tabs>
      </tier>
      <tier name="Tier2">
        <approvers>
          <alerid>5003</alerid>
        </approvers>
        <tabs>
          <tab name="Architecture">
        </tabs>
      </tier>
    </tiers>
  </communities>

9.5.5.4 Setting Up an Asset Type for Multi-tier Tab Approval

The following example demonstrates how the tabs of an asset type of "Application" are configured for multi-tier approval.

<assetType name="Application" id="158">
    <allTabs>
      <tab name="Oveview"/>
      <tab name="Application Lifecycle"/>
      <tab name="License Information"/>
      <tab name="Certification Tracking"/>
      <tab name="Taxonomy"/>
      <tab name="Documentation"/>
      <tab name="Relationships"/>
      <tab name="Support"/>
      <tab name="Cost Categories"/>
      <tab name="Ownership"/>
      <tab name="Technology Stack"/>
      <tab name="Operational Information"/>
      <tab name="Miscellaneous"/>
    </allTabs>
    <tiers>
      <!--Please change "_CHANGE_TIER1_NAME_" to the name of the Tier-->
      <!--Example:- "Tier1"-->
      <tier name="Tier1">
        <approvers>
          <alerid>99</alerid>
        </approvers>
        <tabs>
        <!--Please change "_CHANGE_TABNAME_" to the name of the Tab-->
        <!--Example:- "Documentation"-->
          <tab name="Overview">
          <tab name="Taxonomy">
        </tabs>
      </tier>
    </tiers>

9.5.6.1 Use Cases

These are some of the use cases where Metadata Change Flows may apply:

• When the "Asset Lifecycle Stage" metadata element of an asset changes from "Build" to "Release,", you may want to change Custom Access Settings to have more restricted access control to the asset.

• When the "Name" of an asset changes, you may want to notify the subscribers.

• When any metadata element of an element changes, you may want the asset to go through a "Change Management" approval process. The "Change Management" will involve the following:

  • Unapprove a tab named "Change Management." The Change Management tab in Asset Editor is shown in Figure 9-39.

    Figure 9-39 The Asset Editor Change Management Tab

    
    Description of "Figure 9-39 The Asset Editor Change Management Tab"
    
    

  • Assign the asset to the registrar

  • Append the kind of change to a field called "Reason for reassignment" to assist the registrar

9.5.6.2 Configuring Metadata Change Flows

This section describes the configuring metadata change flows. This section contains the following topics:

• Section 9.5.6.2.1, "Available Metadata Change Events/States"

• Section 9.5.6.2.2, "Available Flows That Can Be Wired to Actions"

• Section 9.5.6.2.3, "Example Metadata Change Configuration"

• Section 9.5.6.2.4, "Example Metadata Change Configuration That Checks for Metadata Value"

• Section 9.5.6.2.5, "ChangeClassification"

• Section 9.5.6.2.6, "ChangeCAS"

• Section 9.5.6.2.7, "ChangeAssetLifecycle"

• Section 9.5.6.2.8, "ApproveTabAction"

• Section 9.5.6.2.9, "UnapproveTabAction"

• Section 9.5.6.2.10, "AutoApproveTabAction"

• Section 9.5.6.2.11, "UnapproveChangeManagementTab"

• Section 9.5.6.2.12, "ResetChangeManagementTab"

• Section 9.5.6.2.13, "NotifyCustomUser"

• Section 9.5.6.2.14, "Invoking Flows Based on Approval of Named Tabs"

 <state name="urn:com:bea:aler:events:type:MetaDataChange:name">
  <state name="urn:com:bea:aler:events:type:MetaDataChange:version">
  <state name="urn:com:bea:aler:events:type:MetaDataChange:description">
  <state name="urn:com:bea:aler:events:type:CategorizationChanged:
  assetLifecycleStage"/>
  <state name="urn:com:bea:aler:events:type:CategorizationChanged:classification">
  <state name="urn:com:bea:aler:events:type:MetaDataChange:supported">
  <state
 name="urn:com:bea:aler:events:type:MetaDataChange:organizationalOwnership">
  <state name="urn:com:bea:aler:events:type:MetaDataChange:usageFee">

<state name="urn:com:bea:aler:events:type:AssetRegister">
    <action>NotifySubscriber</action>
    <action>ChangeCAS</action>
    <customAccessSettings>
      <customAccessSetting>MyCAS</customAccessSetting>
      <customAccessSetting>MyCAS2</customAccessSetting>
    </customAccessSettings>
  </state>
  <state name="urn:com:bea:aler:events:type:AssetUnAccept">
    <action>NotifySubscriber</action>
    <action>ChangeClassification</action>
    <classification>Approved</classification>
  </state>

<state
name="urn:com:bea:aler:events:type:CategorizationChanged:AssetLifecycleStage"
 value="Stage 4 - Release">
    <action>ChangeCAS</action>
    <customAccessSettings>
      <customAccessSetting>MyCAS</customAccessSetting>
    </customAccessSettings>
  </state>
  <state
 name="urn:com:bea:aler:events:type:CategorizationChanged:AssetLifecycleStage"
 value="Stage 3 - Build">
    <action>ChangeCAS</action>
    <customAccessSettings>
      <customAccessSetting>MyCAS2</customAccessSetting>
    </customAccessSettings>
  </state>

<state name="urn:com:bea:aler:events:type:AssetRegister">
    <action>ChangeClassification</action>
    <classification>Approved</classification>
  </state>

<state name="urn:com:bea:aler:events:type:AssetRegister">
    <action>ChangeCAS</action>
    <customAccessSettings>
      <customAccessSetting>MyCAS</customAccessSetting>
      <customAccessSetting>MyCAS2</customAccessSetting>
    </customAccessSettings>
  </state>

<state name="urn:com:bea:aler:events:type:AssetRegister">
    <action>ChangeAssetLifeCycle</action>
    <assetLifeCycle>Stage 3 - Build</assetLifeCycle>
  </state>

<state name=?urn:com:bea:aler:events:type:MetaDataChange:name?>
    <action>ApproveTabAction</action>
    <approveTabs>
      <tab name=?Overview?>
      <tab name=?Taxonomy?>
   </approveTabs>
  </state>

<state name="urn:com:bea:aler:events:type:MetaDataChange:name">
    <action>UnApproveTabAction</action>
    <unapproveTabs>
      <Tab name="Overview">
      <Tab name="Taxonomy">
    </unapproveTabs>
  </state>

<automation>
    <autoRoles>
      <role>admin</role>
      <role>accesAdminstrator</role>
    </autoRoles>
    <autoApprovalTabs>
      <tab name="Documentation"/>
    </autoApprovalTabs>
  </automation>

<state name="urn:com:bea:aler:events:type:AssetRegister">
    <action>AutoApproveTabAction</action>
  </state>

<state name="urn:com:bea:aler:events:type:AssetTabApproved">
    <action>MultiTier_NextTier_Assign</action>
    <action>ResetChangeManagementTab</action>
</state>

<allAssetSettings>
    <notification timerInterval="id">
      <customNotification>
        <emailAddress>[email protected]</emailAddress>
      </customNotification>
    </notification>

<state name="urn:com:bea:aler:events:type:AssetTabApproved" value ="Overview">
    <action>MultiTier_NextTier_Assign</action>    <action>ChangeAssetLifecycle</action>
    <assetLifecycle>Stage 3 - Build</assetLifecycle>
  </state>

9.5.7.1 Tracking Unsubmitted Assets

This flow tracks assets that are in an "unsubmitted" status and sends notification to the owners to take action.

<owner_resubmit action="false" days="0" regressOnInaction="true" queryOperator="eq"/>

• action="true" enables the flow and action="false" disables the flow.

• days="10" tracks the assets that reached unsubmitted status 10 days ago. The Time-based Escalation flows use the current date and subtracts the value from this attribute.

• regressOnInaction="true" regresses the asset on inaction. For example, unsubmitted assets may be deleted.

• queryOperator="eq" uses the equals operator when the date is used for querying. Other possible values are "lte", "gte", etc.

9.5.7.2 Tracking Unaccepted Assets

This flow tracks assets that are in an "unaccepted" status and sends notification to the registrar to take action.

<registrar_accept action="false" days="0" regressOnInaction="true" queryOperator="eq"/>

• action="true" enables the flow and action="false" disables the flow.

• days="10" tracks the assets that reached unsubmitted status 10 days ago. The Time-based Escalation flows use the current date and subtracts the value from this attribute.

• regressOnInaction="true" regresses the asset on inaction. For example, submitted assets may be unsubmitted.

• queryOperator="eq" uses the equals operator when the date is used for querying. Other possible values are "lte", "gte", etc.

9.5.7.3 Tracking Unapproved Assets

This flow tracks assets that are in an "unapproved" status and sends notification to the approvers to take action.

<assignees_approve action="false" days="0" regressOnInaction="true" queryOperator="eq"/>

• action="true" enables the flow and action="false" disables the flow.

• days="10" tracks the assets that reached unsubmitted status 10 days ago. The Time-based Escalation flows use the current date and subtracts the value from this attribute.

• regressOnInaction="true" regresses the asset on inaction. For example, accepted assets may be unaccepted.

• queryOperator="eq" uses the equals operator when the date is used for querying. Other possible values are "lte", "gte", etc.

9.5.7.4 Tracking Unregistered Assets

This flow tracks the assets that are in an "unregistered" status and sends notification to the approvers to take action.

registrar_register action="false" days="0" regressOnInaction="true"
queryOperator="eq"/>

• action="true" enables the flow and action="false" disables the flow.

• days="10" tracks the assets that reached unsubmitted status 10 days ago. The Time-based Escalation flows use the current date and subtracts the value from this attribute.

• regressOnInaction="true" regresses the asset on inaction. For example, registered assets may be unregistered.

• queryOperator="eq" uses the equals operator when the date is used for querying. Other possible values are "lte", "gte", etc.

9.5.8.1 Asset Expiration Warning Notification

The following line enables the warning notification and determines who should receive the notifications.

<expiration_warning action="false" days="10" owner="false" subscriber="false" contact="99"/

9.5.8.2 Unregister Assets After Expiration

The following line enables the Metadata Change flow to unregister the asset after 10 days of expiration.

<unregister_after_expire action="true" days="10" queryOperator="eq"/>

9.5.8.3 Inactivate After Expiration

The following line enables the Metadata Change flow to inactivate the asset after 10 days of expiration.

<inactive_after_expire action="true" days="10" queryOperator="eq"/>

9.5.8.4 Delete Assets After Expiration

The following line enables the Metadata Change flow to delete the asset after 10 days of expiration:

<delete_after_expire action="true" days="10" queryOperator="eq"/>

9.6.2.1 Enabling and Configuring an External JMS Server

The internal Apache ActiveMQ JMS Server needs to be disabled in order to configure an external JMS product. You must also configure JNDI and JMS properties for the external JMS.

1. Click System Settings in the sidebar on the Oracle Enterprise Repository Admin screen.

2. Enter Event in the System Settings Search box to view all the Event Manager related settings.

3. Disable the internal JMS server property, cmee.eventframework.embedded.jms.enabled, by clicking False next to the Event Manager Embedded JMS Enable property. This forces the Event Manager to use an external JMS server.

   Note:

   The cmee.eventframework.embedded.jms.enabled property is not visible, by default. To enable this property, enter this property name in the Enable System Setting box, and then click Enable.

4. In the eventing.properties file, configure the required JNDI properties that are :

   • JNDI URL: cmee.eventframework.jndi.provider.url

     Specifies the JNDI URL. For example, t3://localhost:7001.

   • JNDI User Name: cmee.eventframework.jndi.user

     Specifies the JNDI user name.

   • JNDI Password: cmee.eventframework.jndi.password

     Specifies the password for the JNDI User Name.

   • JNDI Context Factory: cmee.eventframework.jndi.context.factory

     Specifies the JNDI initial context factory. For example, weblogic.jndi.WLInitialContextFactory.

   Note:

   The JNDI properties are not visible, by default. To enable these properties, enter each property name in the Enable System Setting box, and then click Enable.

5. In the eventing.properties file, configure the following JMS properties:

   • JMS Connection Factory: cmee.eventframework.jms.connection.factory

     Specifies the JMS connection factory to enable JMS clients to create JMS connections. For example, weblogic.examples.jms.TopicConnectionFactory.

   • JMS Topic: cmee.eventframework.jms.topic

     Specifies the JMS topic, which is a publish/subscribe destination type for a JMS server. For example, weblogic.examples.jms.TopicConnectionFactory.

   Note:

   The JMS properties are all hidden, by default. To enable these properties, enter each property name in the Enable System Setting box, and then click Enable.

6. Click Save.

7. Restart Oracle Enterprise Repository for the configuration changes to take effect.

9.6.2.2 Configuring JMS Message Header Properties

Every JMS message contains a standard set of header fields that is included by default and available to message consumers. The Message Expiration and Delivery Mode headers can be configured using the Oracle Enterprise Repository System Settings.

1. Access the "Eventing" System Settings, as described in Section 9.6.2.1, "Enabling and Configuring an External JMS Server".

2. In the eventing.properties file, configure the JMS message header properties:

   • JMS Message Expiration: Sets the JMS message expiration time in seconds. If set, unprocessed events will expire in the specified number of seconds. The default is 0 seconds, which means that messages will never expire. However, some environments have policies that require that JMS messages cannot be stored forever if they are not selected for some reason. Enable this property and set the property value to cmee.eventframework.jms.expiration.

   • JMS Delivery Mode: Sets the JMS message delivery mode to either PERSISTENT or NON-PERSISTENT values. If set to PERSISTENT, the JMS server will write the events to the underlying store. Although more reliable, persisting events to a store can affect performance. The default is PERSISTENT. Enable this property and set the property value to cmee.eventframework.jms.deliverymode.

3. Click Save.

4. Restart Oracle Enterprise Repository for the configuration changes to take effect.

9.6.2.3 Miscellaneous JMS Properties

The following miscellaneous System Settings can also be configured:

• Event Manager JMS Subscribers Enabled: If set to False, then the internal JMS subscribers will not be enabled. This is to make sure that the embedded JMS server is started, but an external tool can be used to connect to the embedded server using the given durable subscriber name and the stored events can be cleaned up.

• JMS Subscribers Client ID: Specifies the JMS durable subscriber ID. For example, ALER_JmsSubscriber. The property name is cmee.eventframework.jms.subscribers.client.id.

• JMS Producers Client ID: Specifies the JMS producer's client ID. For example, ALER_DeliveryManager. The property name is cmee.eventframework.jms.producers.client.id.

• Lazy Initialize Event Engine: When enabled, the Event Manager is initialized when an event is produced for the first time. This property should be enabled for either of the following reasons:

  • If there is a large number of events stored by the JMS server and if it is required that these events should not be processed as soon as Oracle Enterprise Repository is started.

  • There are startup issues that occur because of the timing of initializing the embedded JMS server.

  The property name is cmee.eventframework.lazy.load.

9.6.2.4 Configuring External JMS Jar Files

If an external JMS server is being used, then the external JMS server-related JAR files should be copied to the WEB-INF\lib directory.

9.6.3.1 Configuring JMS Durable Subscribers for Web Service Endpoints

The Event Manager creates one durable subscriber for each Web Service endpoint it encounters in the Subscription Manager XML file. This ensures that events are stored if the endpoints are not online and that they can be reliably delivered once the endpoints are online again. As per the JMS Specification, the durable subscriber name should be unique across the JMS server. The Event Manager gets the durable subscriber name from the name field found in the EndPointEventSubscription.xml file, as shown in this example:

<sub:EventSubscriptionData
 xmlns:sub="http://www.bea.com/infra/events/subscription"
  <sub:eventSubscription>
    <sub:endPoint name="ALBPMEndpoint">

9.6.4.1 Enabling JMS Clustering Mode

If Oracle Enterprise Repository is deployed on cluster mode, you must enable clustering on each Oracle Enterprise Repository instance regardless of which type of JMS server being used (embedded or external).

1. Click System Settings in the sidebar on the Oracle Enterprise Repository Admin screen.

2. Enter cmee.eventframework.clustering.enabled in the Enable New System Setting box and click Enable to reveal this hidden property.

3. Set the Clustering Enabled property to True.

4. Set other required properties based on the type of JMS server, as described in the following sections.

9.6.4.2 Configuring Embedded JMS Servers for Clustering

In a clustered environment, each member Oracle Enterprise Repository instance in the cluster will have one embedded JMS server. For example, in case of two-node cluster, there are two Oracle Enterprise Repository instances, such as server01 and server02, with each having one embedded JMS server. Once clustering is enabled for the embedded JMS servers, you then need to specify the connection URL information for the embedded JMS servers on server01 and server02.

1. Click System Settings in the sidebar on the Oracle Enterprise Repository Admin screen.

2. Enter cmee.eventframework.embedded.jms.url in the Enable New System Setting box and click Enable to reveal this hidden property.

3. In the Embedded JMS Server URL property, supply the connection URL for the embedded JMS servers on the clustered Oracle Enterprise Repository servers, using the following format.

   failover:(tcp:// $SERVER_DNS_NAME_OR_IP$:61700,tcp://$SERVER_DNS_NAME_OR_IP$:61700, …) 
   

   where

   $SERVER_DNS_NAME_OR_IP$ are replaced by actual server DNS name or IP address. The entries should be repeated for each Oracle Enterprise Repository server in a given cluster.

   Using the example above, this could be set to: failover:(tcp://server01:61700,tcp://server02:61700)

   Caution:

   Port 61700 is the default port for the embedded JMS server, and therefore should not be used by any other application on the Oracle Enterprise Repository server unless another port is configured for the embedded JSM server.

4. Click Save.

5. Repeat steps 1-4 for each Oracle Enterprise Repository instance in a given cluster. Using the example above, the Embedded Broker URLs could be set to: failover:(tcp://server01:61700,tcp://server02:61700)

   Tip:

   Ensure that each embedded JMS server is enabled by setting the cmee.eventframework.embedded.jms.enabled property to True.

9.6.4.3 Configuring External JMS Servers for Clustering

For external JMS servers, no additional configuration is required. However, you must make sure that the embedded JMS server is disabled, as follows:

1. Click System Settings in the sidebar on the Oracle Enterprise Repository Admin screen.

2. Set the Event Manager Embedded JMS Enable property to False (i.e., cmee.eventframework.embedded.jms.enabled is False.

9.7.2.1 Prerequisites

The following prerequisites apply before starting the monitoring tool:

• If the default embedded JMS server is used, then Oracle Enterprise Repository needs to be running with the cmee.eventframework.enabled system setting set to true. This is to make sure that the JMS broker that is embedded within Oracle Enterprise Repository is running so that the monitoring tool can connect to it and monitor the events.

• If an external JMS server is used, then the external JMS Server needs to be running and the JNDI-related eventing.properties that are required to connect to the external JMS server must be configured.

For more information, see Section 9.6.2, "Configuring Connectivity Properties for External JMS Servers".

9.7.2.2 Usage

From a command prompt, run the Event Monitoring tool as follows:

> event_monitor.bat <Path of WEB-INF\classes> 

For example, if Oracle Enterprise Repository is deployed to a domain named oerdomain under: D:\bea816\user_projects\domains\oerdomain

Then the <Path of WEB-INF\classes> is: D:\bea816\user_projects\domains\oerdomain\applications\oer\oer-app\WEB-INF\classes.

This path is needed to get the JMS configuration from the eventing.properties file so that the tool can connect to the JMS server.

Figure 9-44 Event Monitor Console

Description of "Figure 9-44 Event Monitor Console"

9.7.3.1 Prerequisites

The following prerequisites apply before starting this tool:

• Set the Oracle Enterprise Repository cmee.eventframework.jms.subscribers.enabled system setting to false so that the Oracle Enterprise Repository Event Manager does not start the durable subscriber because this is unsubscribed by the Clean Event tool.

• Restart Oracle Enterprise Repository with the cmee.eventframework.jms.subscribers.enabled property set to false.

9.7.3.2 Usage

From a command prompt, run the Event Cleanup tool as follows:

 > event_clean.bat <Path of WEB-INF\classes> <Name of Durable Subscriber> <Message Selector>

For example, if Oracle Enterprise Repository is deployed to a domain named oerdomain under: D:\bea816\user_projects\domains\oerdomain

Then the <Path of WEB-INF\classes> is: D:\bea816\user_projects\domains\oerdomain\applications\oer\oer-app\WEB-INF\classes.

This path is needed to get the JMS configuration from eventing.properties so that the tool can connect to the JMS Server.

The <Name of Durable Subscriber> can be found in the name attribute inside the endpoint that requires event cleanup within the EndPointEventSubscription.xml as follows:

<sub:eventSubscription>
  <!--The name should be unique within this file since
<sub:endPoint name="ALBPMEndpoint">

The <Message Selector> can be found in the expression attribute inside the endpoint that requires cleanup within the EndPointEventSubscription.xml file.

9.7.3.3 Sample Event Cleanup

Using the example above, navigate to the workflow-tools directory:

> cd D:\bea816\repositoryXXX\core\workflow-tools>

From the command prompt, type:

> event_clean.bat D:\aler\alerbuild2\aler-app\WEB-INF\classes ALBPMEndpoint

The following is the output printed by the Event Cleanup tool to the console.

Figure 9-45 Event Cleanup Console

Description of "Figure 9-45 Event Cleanup Console"

9.7.4.1 Refreshing the Workflow Config File

The Refresh Workflow Config XML tool lets you to refresh a Workflow Config file without restarting the Oracle Business Process Management Engine. For example, if the Workflow Config XML file is updated during development, running this tool allows the Oracle Business Process Management Engine to use the updated version without restarting the engine.

From a command prompt, run the Refresh Workflow Configuration tool as follows:

 > refresh_workflows.bat URI User Password

where

URI = Oracle Business Process Managment URI (for example, http://localhost:9000/fuegoServices/ws/RefreshConfigServiceListener)

User = Oracle Business Process Managment user name (for example, aler_workflow_user)

Password = Oracle Business Process Managment password (for example, aler_workflow_pass)

Figure 9-47 Refresh Workflow Configuration Tool

Description of "Figure 9-47 Refresh Workflow Configuration Tool"

9.8.3.1 Available Web Service Operations

The Oracle Enterprise Repository Event Manager supports the following operations:

newEventRequestResponse

This operation takes the event object that is defined in the XML schema section as an input and returns the status as the output. The status is defined as string type. Additionally, if the status string starts with Failure, then the Event Manager will throw an exception and will try to re-deliver the event until it succeeds. If not, it will log the response and will deliver the next event unless there is a transport exception.

newEventRequestResponseString

This operation takes the event data in string form as an input and returns the status as the output. The status is defined as string type. Additionally, if the status string starts with Failure, then the Event Manager will throw an exception and will try to re-deliver the event until it succeeds. If not, it will log the response and will deliver the next event unless there is a transport exception.

newEventRequest

This operation takes the event object that is defined in the XML schema section as an input and is defined as a one-way operation.

newEventRequestString

This operation takes the event data in string form as an input and is defined as a one-way operation.

newEvent

This operation should be used only if the Process Engine is Oracle Business Process Management. This operation internally invokes the startSession operation to start session to authenticate with Oracle Business Process Management. It will also call discardSession after the invocation.

9.8.3.2 Selecting a Web Service Operation

The preferred Web Service operation can be selected by configuring the Event Manager's Subscription Manager the following way, as specified in the operationName element.

<sub:EventSubscriptionData
 xmlns:sub="http://www.bea.com/infra/events/subscription"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <sub:eventSubscription>
    <sub:endPoint name="ALBPMEndpoint3">
      <sub:host>localhostt>
      <sub:port>9000</sub:port>
      <sub:uri>fuegoServices/ws/StatusChangeEnpointServiceListener</sub:uri>
      <sub:targetNamespace>http://www.bea.com/infra/events</sub:targetNamespace>
      <sub:operationName>newEvent</sub:operationName>
      <sub:authenticationData>
        <sub:basicAuthentication>
          <sub:username>admin</sub:username>
          <sub:password>*****</sub:password>
        </sub:basicAuthentication>
      </sub:authenticationData>
    </sub:endPoint>
   
<sub:notifierClass>com.bea.infra.event.notifier.plugin.http.DefaultHTTPEventNotif
ier    </sub:notifierClass>
    <sub:expression></sub:expression>
  </sub:eventSubscription>
</sub:EventSubscriptionData>

9.8.3.3 Developing a Notifier Plug-in

The Oracle Enterprise Repository Event Manager includes a default SOAP/HTTP notifier. A new plug-in can be developed and plugged in if there are additional requirements, as shown in Figure 9-51.

Figure 9-51 Notifier Plug-in

Description of "Figure 9-51 Notifier Plug-in"

Follow these steps to make the new plug-in work with the Event Manager.

1. Develop a new Notifier Plug-in by extending the Java Class AbstractEventNotifier that is bundled with the Oracle Enterprise Repository Event Manager. This class is bundled with the eventNotifier.jar located in the <oer Webapp path>/WEB-INF/lib directory. The init() and sendNotification() methods need to be overridden. Refer to the Javadoc for more information about these methods. The handle() method passes the event data in an XML Beans format, which can be used to send it to an external Web Service.

2. Configure the Subscription Manager file to point to the developed class. Modify the notifierClass element as follows:

   <sub:EventSubscriptionData
    xmlns:sub="http://www.bea.com/infra/events/subscription"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <sub:eventSubscription>
       <sub:endPoint name="ALBPMEndpoint3">
         <sub:host>localhost</sub:host>
         <sub:port>9000</sub:port>
         <sub:uri>albpmServices/aler_engine/ws/StatusChangeEndpointServiceListener</sub:uri>
         <sub:targetNamespace>StuatusChangeEndpoint</sub:targetNamespace>
         <sub:operationName>newEvent</sub:operationName>
         <sub:authenticationData>
           <sub:basicAuthentication>
             <sub:username>admin</sub:username>
             <sub:password>*****</sub:password>
           </sub:basicAuthentication>
         </sub:authenticationData>
       </sub:endPoint>
      
   <sub:notifierClass>com.bea.infra.event.notifier.plugin.http.DefaultHTTPEventNo
   tifier</sub:notifierClass>
       <sub:expression>id &gt; 500</sub:expression>
     </sub:eventSubscription>
   </sub:EventSubscriptionData>
   

3. Bundle the classes in a JAR file and copy it to <oer Webapp path>/WEB-INF/lib directory so that it is picked up by the classpath.

4. Restart the Event Manager and trigger an event using the Asset Editor.

5. The Event Manager will call the init() and handle() methods of the new notifier plug-in.