4 Using Events in iStudio

This chapter describes how to use iStudio to create, publish, and subscribe to events. It contains the following topics:

• Overview of Events

• Creating Events

• Publishing and Subscribing to an Event

4.1 Overview of Events

An event is an integration point used to model the Publish/Subscribe paradigm. An event has associated data that is the common view of all the data to be exchanged through this event.

The data structure that should be used for defining the common view is entirely dependent on the integration scenario, and the choice is left to the implementor. The only condition that data structure should satisfy is that it should be a superset of all the application views for applications that will be publishing or subscribing to this event. The choices for common view data include:

• Corporate internal standards enforced by the organization where OracleAS Integration InterConnect is being implemented.

• Industry standard definitions, such as Open Applications Group (OAG) and Business Object Definitions (BOD).

• One of the application views can be used as the common view, if the scenario has one application that is driving the integration.

For example, App1 and App2 publish customer names, and App3 subscribes to it. If App1 publishes First Name, Last Name, and Middle Initial, and App2 publishes First Name, Last Name, Prefix, and Suffix, the event could be defined as follows:

New Customer Event
Prefix
First Name
Last Name
Middle Initial
Suffix

See Also: "How the Hub-and-Spoke Methodology Works"

4.1.1 Event Maps

If an application publishes exactly the same data structure for two or more events, event maps allow OracleAS Integration InterConnect to distinguish which message corresponds to which event. For example, an application publishes the same Customer Application Data Type whether or not it is a Create_Customer event or an Update_Customer event. Through event maps, OracleAS Integration InterConnect can determine which messages correspond to Create_Customer and Update_Customer.

Note: Event maps need to be used only if two or more events published by a particular application have the exact same application view structure.

4.2 Creating Events

To create an event:

1. From the File menu, click New, then select Event. The Create Event dialog is displayed.

   
   Description of the illustration 4.2.gif
   
   

2. Enter the following information in the fields:

   • Business Object: The name of the category to which the event belongs. Select a category from the list.

   • Event Name: The name of the event. Only alphanumeric characters can be used.

   • OAI/V1: The owner and version number of the Business Object. This field cannot be edited.

3. Add or import attributes to this event.

4. Click Save.

   
   

   See Also: "Adding Attributes" Appendix B, "Using the Data Definition Description Language" "Deleting and Clearing Attributes"

   
   

4.3 Publishing and Subscribing to an Event

The publish/subscribe paradigm is used for asynchronous one-way communication. The sending application is said to publish the event. The receiving application subscribes to the event.

4.3.1 Publishing an Event

Publishing an event in an application in iStudio involves the Publish Wizard. To start the Publish Wizard:

1. In the Design Navigation list, expand the Application node. Select and expand the Application node to display the Published Events leaf. Right-click Published Events and select Publish. The Publish Wizard is displayed.

   
   Description of the illustration 4.3.1.gif
   
   

   1. Enter following information in the fields:

      • Application: The name of the invoking application is selected by default.

      • Message Type: The mode of communication between OracleAS Integration InterConnect and the application. Select from the following message types:

        • Database: OracleAS Integration InterConnect communicates with the application using the database.

        • Generic: OracleAS Integration InterConnect communicates with the application using a user-defined bridge.

        • XML: OracleAS Integration InterConnect communicates with the application using XML data described through a data type definition (DTD) using the FTP, SMTP, HTTP, MQ Series, or user-defined adapters.

        • AQ: OracleAS Integration InterConnect communicates with the application through Oracle Advanced Queues using the Advanced Queue adapter. The payload can be Oracle Objects where fields may be XML or RAW XML.

        • D3L: OracleAS Integration InterConnect communicates with the application using non-XML data formats described through D3L using the FTP, SMTP, HTTP, and MQSeries adapters.

          
          

          Note: Other choices will be visible if you've purchased and installed additional adapters for Oracle E-Business Suite, SAP, Peoplesoft, and Siebel.

          
          

   2. Select the event name.

   3. Click Next.

2. The Define Application View page is displayed.

   
   Description of the illustration 4.3.1-55.gif
   
   

   Once an event is selected to publish, the application view is defined. The application view page is initially an empty table. Define the attributes using Add, or import the definitions from a database or an API Repository using Import.

   1. Click Add or Import to add or import attributes.

      
      

      See Also: "Adding Attributes" "Importing Attributes" "Deleting and Clearing Attributes" Appendix B, "Using the Data Definition Description Language"

      
      

   2. To import an XML DTD, click Import and select XML to display a file dialog:

      
      Description of the illustration 4.3.1-2.gif
      
      

   3. Select a DTD file and click Open. The Choose Root Element dialog is displayed.

      
      Description of the illustration 4.3.1-3.gif
      
      

   4. Select a root DTD element and click OK.

   5. If this is a XML type message, the Event Map button is enabled. To define the event map, click Event Map. The Event Map dialog is displayed.

      
      

      Note: Event maps need to be used only if two or more events published by a particular application have the exact same application view structure.

      
      
      
      Description of the illustration 4.3.1-4.gif
      
      

   6. Click Add to add an event map attribute. The New Event Map dialog is displayed.

      
      Description of the illustration 4.3.1-5.gif
      
      

   7. Expand the list and select an attribute and enter a value in the Value field.

   8. Click OK on the Add Event Map dialog to return to the Event Map dialog.

   9. Click OK to return to the Publish Event wizard.

   10. Click Next.

3. Click Next on the Define Application View page. The Define Mapping page is displayed. Mapping involves copying the individual fields or simple shape-change transformations.

   
   Description of the illustration is03.gif
   
   

   1. Click New to define new mappings. The Mapping Parameters dialog is displayed.

      
      Description of the illustration mappingparameters.gif
      
      

      Use a transformation to map fields in the application view to fields in the common view. For example, to map fields in the FirstName and LastName in the common view to Name in the application view, use the ConcatFields transform.

      
      

      See Also: "Invoking a Procedure"

      
      

   2. Click OK to return to the Publish Event Wizard.

4. Click Finish.

4.3.2 Subscribing to an Event

Subscribing to an application event in iStudio involves using the Subscribe Wizard. To subscribe to an event in an application:

1. In the Design Navigation list, expand the Application node. Select and expand the Application node to display the Subscribed Events leaf. Right-click Subscribed Events and select Subscribe. The Subscribe Wizard is displayed.

   
   Description of the illustration 4.3.2.gif
   
   

   1. Enter following information in the fields:

      Application: The name of the application selected in the navigation list, which invokes the procedure, appears selected by default.

      Message Type: The message type that specifies the mode of communication between OracleAS Integration InterConnect and the application. Select from the following message types:

      • Database: OracleAS Integration InterConnect communicates with the application using the database.

      • Generic: OracleAS Integration InterConnect communicates with the application using a user-defined bridge.

      • XML: OracleAS Integration InterConnect communicates with the application using XML data described through a data type definition (DTD) using the FTP, SMTP, HTTP, MQ Series, or user-defined adapters.

      • AQ: OracleAS Integration InterConnect communicates with the application through Oracle Advanced Queues using the Advanced Queue adapter. The payload can be Oracle Objects where fields may be XML or RAW XML.

      • D3L: OracleAS Integration InterConnect communicates with the application using non-XML data formats described through D3L using the FTP, SMTP, HTTP, and MQSeries adapters.

      • Oracle Applications: OracleAS Integration InterConnect communicates with Oracle Applications using this message type.

        
        

        Note: Other choices will be visible if you've purchased and installed additional adapters for SAP, Peoplesoft, and Siebel.

        
        

   2. Select the event name.

   3. Click Next.

2. The Define Application View page is displayed.

   
   Description of the illustration 4.3.2-2.gif
   
   

   Once an event is selected to subscribe to, the application view is defined. The application view page is initially an empty table. Define the attributes using Add or import the definitions from a database or an API Repository using Import.

   1. Click Add or Import to add or import attributes.

      
      

      See Also: "Adding Attributes" "Importing Attributes" "Deleting and Clearing Attributes" Appendix B, "Using the Data Definition Description Language"

      
      

   2. Populate and look up cross-reference tables by clicking Cross Reference... The Cross Reference dialog is displayed. Click OK to return to the Subscribe Wizard.

3. Click Next on the Define Application View page. The Define Mapping Page is displayed. Mapping can involve either copying the individual fields or simple shape-change transformations.

   
   Description of the illustration 4.3.2-3.gif
   
   

   1. Click New to define mappings. The Mapping Parameters dialog is displayed.
      Description of the illustration 4.3.2-4.gif
      
      

      Use a transformation to map fields in the common view to fields in the application view. For example, to map fields in the FirstName and LastName in the common view to Name in the application view, use the ConcatFields transform.

      
      

      See Also: "Invoking a Procedure"

      
      

   2. Click OK to return to the Subscribe Event Wizard.

4. Click Finish.