Skip Headers
Oracle® Application Server Integration InterConnect Adapter for Oracle Applications Installation and User's Guide
10g Release 2 (10.1.2)
B14360-02
  Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
Next
Next
 

4 Sample Use Cases

This chapter describes sample use cases for the OA adapter.

Sample Use Cases for Tables/Views/APIs

This section contains the following use cases:

Case One: Publish and Subscribe

This case illustrates a simple Publish-Subscribe scenario using an OA adapter at each end.

Design-Time Steps

The following section describes the steps to create a Published/Subscribed Event using the Publish Wizard in iStudio:

  1. Navigate to the Design tab in iStudio.

  2. Invoke the Publish/Subscribe Wizard by right-clicking the node for the application.

  3. In the Select an Event dialog box select the required application and Oracle Applications as the message type. Select the event to publish/subscribe to from the list of available events. Click Next.

  4. In the Select Interface Type dialog box, select the Tables/Views/APIs and click Next.

  5. Model the application view in the Define the Application View dialog box following one of the following methods:

    • Create the application view manually by clicking Add for each new attribute you would like to define.

    • Import the application view structure from one of the following sources:

      • Application Data Type

        Import an existing application data type. This option enables the reuse of data types, which have been created or imported for other Published/Subscribed Event or Invoked/Implemented Procedure before.

      • Common Data Type

        Import an existing common data type. This option may be selected if the application view and the common view data structures are the same.

      • Tables/Views/APIs

        This option enables you to import the structure of tables, views, APIs and Abstract Data Types (ADTs) from an Oracle Applications database instance.

        Provide the login credentials to the Oracle Applications database instance in the Database Login dialog box. For example, Username: apps Password: apps URL: myhost.mycompany.com:1521:orcl Driver: oracle.jdbc.driver. Oracle Driver (default). Select the Save settings as Default, if you would like iStudio to remember these credentials. Click Login.

        In the Oracle Applications Browser dialog box, you can browse through the available Oracle Applications modules and select the structure of a table, view, API or Abstract Data Type (ADT) to define the application view. The Oracle Applications Browser also provides a search mechanism, which enables searching for table, view, API or Abstract Data Type (ADT) structures by name and wildcards. Enter the object name in the Object Name field. (use '%' as wildcard character, for example, HZ%V2%PUB) and check one or more of the checkboxes in order to search for table, view, API or Abstract Data Type (ADT) structures. Click Search. The search results will be displayed in the left window of the browser. To return to the module view, click Browse.

        Select an object and click Apply to import the selected object as the application view.

      • In the Define Mapping dialog box, click Define Mappings to create transformation mappings between the Application View and Common View. Click Next if mappings are complete.

      • If modeling a Subscribed Event, review the Generated Data Types and review/extend the generated PL/SQL package stubs in the Define Stored Procedure dialog box.

      • Click Finish to complete the wizard.

Case Two: Invoke and Implement

This case illustrates a simple Invoke-Implement scenario using an OA adapter at each end.

Design-Time Steps

The following section describes the steps to create an Invoke/Implement Procedure using the Publish Wizard in iStudio:

  1. Right-click the required node for the application to invoke the Invoke/Implement Wizard.

  2. In the Select a Procedure dialog box, select the required application and Oracle Applications as the message type.

  3. Select the procedure to invoke/implement from the list of available procedures. Click Next.

  4. In the Select Interface Type dialog box, select Tables/Views/APIs and click Next.

  5. Model the application view in the Define the Application View dialog box by using one of the following methods:

    • Create the application view manually by clicking Add for each new attribute you would like to define.

    • Import the application view structure from one of the following sources:

      • Application Data Type

        Import an existing application data type. This option enables the reuse of data types, which have been created or imported for other Published/Subscribed Event or Invoked/Implemented Procedure before.

      • Common Data Type

        Import an existing common data type. This option can be selected if the application view and the common view data structures are the same.

      • Tables/Views/APIs

        This option enables importing the structure of tables, views, APIs and Abstract Data Types (ADTs) from an Oracle Applications database instance.

        Provide the login credentials to the Oracle Applications database instance in the Database Login dialog box. For example, Username: apps Password: apps URL: myhost.mycompany.com:1521:orcl Driver: oracle.jdbc.driver.OracleDriver (default). Select the Save Settings as Default if you would like iStudio to remember these credentials. Click Login.

        In the Oracle Applications Browser dialog box, you can browse through the available Oracle Applications modules and select the structure of a table, view, API or Abstract Data Type (ADT) to define the application view.

        The Oracle Applications Browser also provides a search mechanism, which enables searching for table, view, API or Abstract Data Type (ADT) structures by name and wildcards. Enter the object name in the Object Name field. (use '%' as wildcard character, for example, HZ%V2%PUB) and check one or more of the checkboxes in order to search for table, view, API or Abstract Data Type (ADT) structures. Click Search. The search results will be displayed in the left dialog box of the browser. To return to the module view, simply click Module View.

        Select whether you would like to import the selected object structure as IN, OUT, or IN/OUT arguments.


        Note:

        If the Synchronous box is checked, then the OA adapter will function in synchronous mode.

    • In the Define Mapping: IN Arguments dialog box, click Define Mappings to create transformation mappings between the Application View and Common View for the IN arguments (Request message). Click Next if mappings are complete.

    • In the Define Mapping: OUT Arguments dialog box, click New to create transformation mappings between the Application View and Common View. for the OUT arguments (Reply message). Click Next if mappings are complete.

    • Review the Generated Data Types and review/extend the generated PL/SQL package stubs in the Define Stored Procedure dialog box.

    • Click Finish to complete the wizard.

Run-Time Steps

The run-time steps for Case One and Case Two are identical. The steps to export PL/SQL stored procedures manually:

  1. Select File from the menu bar, then select Export. The Export Application dialog box is displayed.

  2. Select the messages to export stored procedures. Messages can be filtered as follows:

    • Export all messages: Select Applications at the top of the directory.

    • Export all messages of a certain type for all applications: Check All Applications, then select one or more types of messages to export.

    • Export all messages for a specific application: Select the application name

    • Export all messages of a certain type for a specific application: Select the type under the application name in the directory.

    • To export specific messages: Select the messages by name. To select more than one message or class of messages click the application.

  3. Enter the name of the file to contain the exported stored procedures in the File Prefix field. The name generates multiple files.

    To view the directory page, click Browse.

  4. Click OK. The stored procedure is now exported.

  5. Install the exported stored procedures in your Oracle Applications schema. Now you are ready for run time.

Sample Use Cases for XML Gateway

This section contains the following use cases:

Case One: Publish and Subscribe

This case illustrates a simple Publish-Subscribe scenario using an OA adapter at each end.

Design-Time Steps

The following section describes the steps to create a Published/Subscribed Event using the Publish Wizard in iStudio:

  1. Navigate to the Design tab in iStudio.

  2. Right-click the node for the application to create the Application Data Type, and click New.

  3. Enter a name for the Application Data Type. For example, adt_PROCESS_PO_007.

  4. Click Import.

  5. Select Oracle Applications, then click XML Gateway.

  6. In the login dialog box, give the required login information to connect to the Oracle Applications instance.

    • Provide the login credentials to the Oracle Applications database instance in the Database Login dialog box, for example

      • Username: apps

      • Password: apps

      • URL: myhost.mycompany.com: 1521: orcl

      • Driver: oracle.jdbc.driver.OracleDriver (default)

    • Check the Save settings as default option, if you would like iStudio to remember these credentials.

  7. After connecting successfully, the Oracle Applications Browser dialog box is displayed with all the supported DTDs for XML Gateway in the left pane.

  8. Select the desired DTD. All the elements for that DTD are displayed in the right pane.

  9. Click Done to import the DTD into the Application Data Type.

  10. Define the Business Object, Event and Common View.

  11. Right-click the node for the application to invoke the Publish/Subscribe Wizard.

  12. In the Select an Event dialog box, select the application and Oracle Applications as the message type. Select the event to. publish/subscribe to from the list of available events. Click Next.

  13. In the Select Interface Type dialog box, select the XML Gateway and click Next.

  14. Model the application view in the Define the Application View dialog box by importing the application view structure from one of the following sources:

    • Application Data Type

      Import an application data type as created earlier. This option enables the reuse of data types, which have been created or imported for other Published/Subscribed Event or Invoked/Implemented Procedure before.

    • Common Data Type

      Import an existing common data type. This option may be selected if the application view and the common view data structures are the same.

    • Oracle Applications: XML Gateway

      This option enables to import the structure of pre-existing XML Gateway transactions from an Oracle Applications database instance.

    Login to the Oracle Applications database instance in the Database Login dialog box.

    In the Oracle Applications Browser dialog box, you can browse through the available XML Gateway transactions and select the structure to define the application view.

    Select an object, and click Done to import the selected object as the application view.

  15. In the Define Mapping dialog box, click Define Mappings to create transformation mappings between the Application View and Common View.


    Note:

    The imported payload structure is displayed under the PAYLOAD node in the message structure.

  16. Click Next.

  17. Click Finish to complete the wizard.

Case Two: Invoke and Implement

This case illustrates a simple Invoke-Implement scenario using an OA adapter at each end.

Design-Time Steps

The following section describes the steps to create a Invoke/Implement Event using the Publish Wizard in iStudio:

  1. Invoke the Invoke/Implement Wizard by right-clicking the node for the application.

  2. In the Select a Procedure dialog box, select the required application and Oracle Applications as the message type. Select the procedure to invoke/implement from the list of available procedures. Click Next.

  3. In the Select Interface Type dialog box, select XML Gateway and click Next.

  4. Model the application view in the Define the Application View dialog box following one of the following methods:

    • Import the application view structure from one of the following sources:

      • Application Data Type

        Import an existing application data type. This option enables the reuse of data types, which have been created or imported for other Published/Subscribed Event or Invoked/Implemented Procedure before.

      • Common Data Type

        Import an existing common data type. This option may be selected if the application view and the common view data structures are the same.

      • XML Gateway

        This option enables to import the structure of pre-existing XML Gateway transactions from an Oracle Applications database instance

        Provide the login credentials to the Oracle Applications database instance in the Database Login dialog box, for example, Username: apps, Password: apps, URL: myhost.mycompany.com:1521:orcl Driver: oracle.jdbc.driver.OracleDriver (default). Check the Save Settings as Default if you would like iStudio to remember these credentials. Click Login.

        In the Oracle Applications Browser dialog box, you can browse through the available XML Gateway transactions and select the structure to define the application view.

        Select whether you would like to import the selected object structure as IN, OUT or IN/OUT arguments. One set of XML Gateway headers and payload should be as IN argument and another set should be OUT arguments. Depending on the scenario, the payload can also be INOUT argument type where the IN payload and the OUT payload is the same.

    • In the Define Mapping: IN Arguments dialog box, click Define Mappings to create transformation mappings between the Application View and Common View for the IN arguments (Request message). Click Next if mappings are complete.

    • In the Define Mapping: OUT Arguments dialog box, click Define Mapping to create transformation mappings between the Application View and Common View for the OUT arguments (Reply message). Click Next if mappings are complete.

    • Click Finish to complete the wizard.

Customizing XML Gateway Payload Structures

The structure for the message payload for the XML Gateway can be customized. This is done using the Message Designer tool. This is a design-time tool that is used to model the payload for the XML Gateway.