Oracle® Application Server Adapter for Oracle Applications User's Guide
10g Release 2 (10.1.2)
OracleAS Adapter for Oracle Applications use Application programming interfaces (APIs) to insert and update data into Oracle Applications.
This chapter contains the following sections:
OracleAS Adapter for Oracle Applications use APIs to insert and update data in Oracle Applications. APIs are stored procedures that enable you to insert and update data in Oracle Applications. For example, by using APIs, you can insert a customer record in Oracle Applications.
This section describes how to configure the OracleAS Adapter for Oracle Applications to use APIs. It includes the following topics:
OracleAS adapter for Oracle Applications is deployed using the BPEL Process Manager (PM) in Oracle JDeveloper. The BPEL PM creates the WSDL interfaces for the API.
You need to populate certain variables in the BPEL PM in order to provide context information for Oracle Applications. The context information required for an API transaction includes the username and responsibility of an Oracle Applications user that has sufficient privileges to run the program. The default value passed for the username is
SYSADMIN. The default value passed for responsibility is
You can change the default values specified in the generated WSDL for the username and responsibility. This is a static way of changing the context information. These values would apply to all invocations of the deployed business process. However, if you need to provide different context information for different invocations of the business process, then you can dynamically populate the header variable with values for username and responsibility. The context information can be specified by configuring an Assign activity before the Invoke activity in the BPEL PM.
This section describes the tasks required to configure OracleAS Adapter for Oracle Applications using the Adapter Configuration Wizard in Oracle JDeveloper. It contains the following topics:
The first configuration task is to create a new BPEL project. This section describes how to create a new BPEL project.
To create a new BPEL project:
Open BPEL Designer.
From the File menu, select New. The New Gallery dialog box is displayed.
Select All Items from the Filter By list. This displays a list of available categories.
Expand the General node, and then select Projects.
Select BPEL Process Project from the Items list, as shown in Figure 3-1.
Figure 3-1 Creating a New BPEL Process Project
Click OK. The BPEL Process Project dialog box is displayed.
In the BPEL Process Name field, enter a descriptive name. For example,
From the Template list, select Empty BPEL Process. Keep the default selection for Use Default in the Project Content section, as shown in Figure 3-2.
Figure 3-2 Specifying a Name for the New BPEL Process Project
Click OK. An empty BPEL process, with the necessary source files including
InsertShipNotice.wsdl is created. Figure 3-3 shows the new BPEL process.
Figure 3-3 New BPEL Process
The next task is to add a partner link to the BPEL process. This section describes how to create an OracleAS adapter for the application service by adding a partner link to your BPEL process. A BPEL partner link defines the link name, type, and the role of the BPEL process that interacts with the partner service.
To add a partner link:
Drag and drop PartnerLink into the border area of the process diagram. The Create Partner Link dialog box is displayed.
Click Define Adapter Service in the WSDL Settings section. The Adapter Configuration Wizard is displayed.
Click Next. The Adapter Type dialog box is displayed.
Select Oracle Applications to specify the adapter you want to configure, as shown in Figure 3-4.
Figure 3-4 Selecting OracleAS Adapter for Oracle Applications
Click Next. The Service Name dialog box is displayed.
Enter the following information:
In the Service Name field, enter a service name.
In the Description field, enter a description for the service. This is an optional field. The Service Name dialog box is displayed, as shown in Figure 3-5.
Figure 3-5 Specifying the Service Name and Description
Click Next. The Service Connection dialog box is displayed.
Enter the JNDI (Java Naming and Directory Interface) name in the Database Server JNDI Name field. The JNDI name acts as a placeholder for the connection used when your service is deployed to the BPEL server. This enables you to use different databases for development and later for production.
See Also:Oracle Application Server Adapter Concepts for understanding JNDI concepts.
Figure 3-6 shows how to create a new database connection.
Figure 3-6 Creating a New Database Connection
Click New to define a database connection. The Create Database Connection Wizard is displayed.
Note:You need to connect to the database where Oracle Applications is running.
Click Next. The Type dialog box is displayed, as shown in Figure 3-7.
Enter the following information in the Type dialog box:
In the Connection Name field, specify a unique name for the database connection.
From the Connection Type list, select the type of connection for your database.
Figure 3-7 Specifying a Name and Type for the Database Connection
Click Next. The Authentication dialog box is displayed.
Enter the following information:
In the UserName field, specify a unique name for the database connection.
In the Password field, specify a password for the database connection.
Click Next. The Connection dialog box is displayed.
Enter the following information:
From the Driver list, select Thin.
In the Host Name field, specify the host name for the database connection.
In the JDBC Port field, specify the port number for the database connection.
In the SID field, specify the unique SID value for the database connection.
The Connection dialog box is displayed, as shown in Figure 3-8.
Figure 3-8 Specifying Connection Details for the New Database
Click Next. The Test dialog box is displayed.
Click Test Connection to determine whether the specified information establishes a connection with the database.
Click Next. The Service Connection dialog box is displayed, providing a summary of your database connection.
Click Finish to complete the process of creating a new database connection.
Once you have completed creating a new connection for the service, you can add an API by browsing through the list of APIs available in Oracle Applications.
Click Next. The Application Interface dialog box is displayed, as shown in Figure 3-9.
Note:If you are connecting to a pre-11.5.10 Oracle Applications instance, then you would be required to select the interface to Oracle Applications data. Select Tables/Views/APIs/Concurrent Programs to proceed.
Figure 3-9 Adding the Database Objects
Click Get Object to open the Oracle Applications Module Browser. Figure 3-10 shows the Oracle Applications Module Browser.
Figure 3-10 Specifying the API
Oracle Applications Module Browser includes the various product families that are available in Oracle Applications. For example, the Marketing Suite or the Order Management Suite are product families in Oracle Applications. The product families contain the individual products. For example, the Order Management Suite contains the Shipping Execution Common product. The product contains the business entities associated with the product. For example, the Shipping Execution Common product contains the Delivery entity. Business entities contain the various application modules that are exposed for integration. These modules are grouped according to the interface they provide. APIs can be found under the PLSQL category.
Note:In the 11.5.10 instance the Module Browser displays only the public APIs that are exposed to the integration repository. Whereas, in the pre-11.5.10 instance the Module Browser displays all the APIs that are available in the package.
Select the required API. The signature of that given API is displayed.
click OK. You can select only one API for each adapter service. Figure 3-11 shows that the API has been added.
Note:Use the Search option to quickly find the required objects. Enter the required database object name in the Object Name field and select APIs. And then, click Search to retrieve the required database objects. When searching for an API, enter the package name, and not the procedure name. In contrast, when using the DB Adapter Wizard, the user must enter the name of the API while searching.
Figure 3-11 Adding the API
Click Next, and then click Finish to complete the process of configuring OracleAS Adapter for Oracle Applications. The wizard generates the WSDL file corresponding to the XML schema. This WSDL file is now available for the partner link.
Click OK. The partner link is created with the required WSDL settings.
After adding and configuring the partner link, the next task is to configure the BPEL process.
The Adapter Configuration wizard generates a wrapper API when an API has arguments the data types of which are: PL/SQL Boolean, PL/SQL Table, or PL/SQL Record. For generating the wrapper API, Oracle JPublisher is automatically invoked in the background. When a wrapper API is created, besides the WSDL and XSD files, two SQL files are created: one for creating the wrapper API, and necessary datatypes and another for deleting it. The two SQL files are saved in the same directory where the WSDL and XSD files are stored, and are available in the Project view.
The following is a sample code of an API that would require a wrapper to be generated:
package pkg is type rec is record (...); type tbl is table of .. index by ..; procedure proc(r rec, t tbl, b boolean);end;
If the preceding API is selected in the wizard, then a wrapper API will be created, and loaded into the database. This wrapper API will be used instead of the originally selected API. For this reason, the content of the WSDL and XSD files represent the wrapper procedure, not the procedure originally selected.
The following are the types that will be created for the wrapper API:
Object type for PL/SQL RECORD
Nested table of the given type for PL/SQL TABLE. For example, the nested table of NUMBER.
INTEGER substituted for PL/SQL BOOLEAN
The generated SQL file that creates the wrapper API also creates the required schema objects. The types of the wrapper APIs parameters will be that of the new schema object types. The wrapper package will contain conversion APIs to convert between the base PL/SQL type and the new schema object types.
The wrapper API is created in a package. This package is named XX_BPEL_
SERVICE_NAME, as shown in Figure 3-12.
SERVICE_NAME is the name of the service that you entered in step 6 of Adding a New Partner Link. If this package already exists, then the wizard prompts for a different package name, or to select a checkbox, to overwrite the existing package. Overwriting an existing package causes all APIs in the specified package to be lost. When the wizard creates a package for the wrapper, only one API, that is, the wrapper API, is contained in it.
Note:Despite specifying to overwrite an existing package, if the wrapper API already exists in the specified package, the wizard will not re-create the wrapper API, as it would take some time. This means no SQL files will be created, Oracle JPublisher will not be run, and the WSDL and XSD files will be for the existing wrapper API. The Finish page of the wizard will indicate that these actions will take place, but it is possible that they will not, depending on whether the wrapper already exists.
The name of the wrapper API depends on whether the API that was originally selected is in a package or not. If the original API is a root-level API, that is, it does not belong in a package, then the name of the wrapper API will be, TOPLEVEL$
ORIGINAL_API_NAME. If the originally selected API is in a package, then the name of the wrapper API will be,
Wrapper APIs follow the naming convention of Oracle JPublisher. For example, if the original API was called
CREATE_EMPLOYEE and was a root-level API, then the wrapper API would be named,
TOPLEVEL$CREATE_EMPLOYEE. If the original API is in a package called
EMPLOYEE, then the wrapper API would be named,
Figure 3-12 Entering a Package Name for the Wrapper API
Note:The package name for the wrapper has a limit of 30 characters, and the wrapper API name has a limit of 29 characters. Thus, if the package name and the wrapper API names are longer than the maximum limit, then they will be truncated accordingly.
The Finish page is different when a wrapper API needs to be created, as shown in Figure 3-13. The Finish page informs you that a wrapper API is needed, and in addition, lists the name of the wrapper package, wrapper API, and the SQL files that will be created.
Note:When a wrapper API needs to be created, it may take a while before the wizard completes. However, the processing time for subsequent APIs in the same package would be much shorter.
Figure 3-13 The Finish Page
Overloaded APIs are not supported in the 11.5.10 instance.
You can declare parameters of a stored procedure with a default clause, that when, in the absence of the parameter from the invocation of the procedure, will supply a default value for that parameter. For example:
PROCEDURE addEmployee (name VARCHAR2, country VARCHAR2 DEFAULT 'US')
This procedure can be invoked in the following two different ways:
1. addEmployee ('John Smith') // country => 'US' 2. addEmployee ('John Smith', 'France') // country => 'France'
You can omit elements for parameters with default values in the instance XML. The procedure will be invoked without these parameters, allowing their default values to be used, as shown in the following example:
Input: <db:InputParameters xmlns:db="…"> <name>John Smith</name> </db:InputParameters>Runtime Invocation: BEGIN addEmployee (name=>?); END; // country => 'US' orInput: <db:InputParameters xmlns:db="…"> <name>John Smith</name> <country>France</country> </db:InputParameters>Runtime Invocation: BEGIN addEmployee (name=>?, country=>?); END; // country => 'France'
The element in the XSD for parameters with a default clause is annotated with a special tag to indicate that the parameter has a default clause, as shown in the following example.
<element name=ÓcountryÓ … db:default=ÓtrueÓ …/>
This new functionality allows elements for parameters without a default clause also to be omitted in the instance XML. In these cases, the parameter is still included in the invocation of the stored procedure. A value of NULL is bound by default. The following is an example, where the country parameter did not have a default clause:
PROCEDURE addEmployee (name VARCHAR2, country VARCHAR2)
In prior release, BPEL PM 10.1.2, elements for both parameters were required in the instance XML. If an element was omitted, then it was presumed to have a default clause so the parameter would not be included in the invocation of the procedure. In this case, the missing parameter would result in a PL/SQL error stating that an incorrect number of arguments were passed to the procedure.
In the current BPEL PM release, the missing parameter will be included in the invocation of the procedure. A
NULL value will be bound, as shown in the following example:
Input: <db:InputParameters xmlns:db="…"> <name>John Smith</name> </db:InputParameters>Runtime Invocation: BEGIN addEmployee (name =>?, country=>?); END; // country => NULL
Even though the element for country was not provided in the instance XML, it still appears in the call to the procedure. In this case, country will be
If a procedure contains a special type requiring a wrapper to be generated, then the
default clauses on any of the original parameters will not be carried over to the wrapper, as shown in the following example:
PROCEDURE needsWrapper(isTrue BOOLEAN, value NUMBER DEFAULT 0)
Assuming that the procedure in the preceding example was defined at the top level, outside of a package, then the generated wrapper will appear, as shown in the following example:
TOPLEVEL$NEEDSWRAPPER (isTrue INTEGER, value NUMBER)
In the preceding example, the BOOLEAN type has been replaced by INTEGER. The default clause on the value parameter is missing. In the current release, parameters of generated wrapper procedures will never have a default clause, even if these parameters did in the original procedure. If the element is missing in the instance XML, instead of defaulting to
0, then the value of the parameter will be
NULL, as shown in the following example:
Input: <db:InputParameters xmlns:db="…"> <isTrue>1</isTrue> </db:InputParameters>Runtime Invocation: BEGIN TOPLEVEL$NEEDSWRAPPER (isTrue =>?, value =>?); END; // value => NULL
To fix this, you can edit the generated SQL file, restoring the default clauses. You should then, run the SQL file to reload the wrapper definitions into the database schema. In addition, you should modify the generated XSD.Following are the steps to fix the default clause with the wrapper generated for
Change the signature in the following manner in the generated wrapper SQL file, from
TOPLEVEL$NEEDSWRAPPER (isTrue INTEGER, value NUMBER)to
TOPLEVEL$NEEDSWRAPPER (isTrue INTEGER, value NUMBER DEFAULT 0)
Reload the modified wrapper SQL file mentioned in the preceding example into the appropriate database schema. For BOOLEAN parameters with DEFAULT clause, you need to map as follows:
DEFAULT TRUE(base) to DEFAULT 1 (wrapper) DEFAULT FALSE (base) to DEFAULT 0 (wrapper)
For example, if the base stored procedure is
PROCEDURE needsWrapper(isTrue BOOLEAN TRUE, value NUMBER DEFAULT 0), then the generated wrapper would be,
TOPLEVEL$NEEDSWRAPPER (isTrue INTEGER, value NUMBER). You should manually fix the store procedure to be,
TOPLEVEL$NEEDSWRAPPER (isTrue INTEGER DEFAULT 1, value NUMBER DEFAULT 0)
If a parameter has a default clause, then its corresponding element in the XSD must have an extra attribute,
db:default="true". For example, if a parameter has a default clause,
TOPLEVEL$NEEDSWRAPPER(isTrue INTEGER DEFAULT 1, value NUMBER DEFAULT 0), then the elements in the XSD for
value need to have the following new attributes:
<element name="ISTRUE" ... db:default="true" .../> <element name="VALUE" ... db:default="true" .../>
To configure the Invoke activity:
Drag Invoke from the Component palette and drop it at the location where you want to insert the invoke activity in your BPEL process, as shown in Figure 3-14.
Figure 3-14 Dragging the Invoke Activity
Double-click Invoke in the process map to open the Invoke dialog box. The General tab is selected by default. Figure 3-15 shows the Invoke dialog box.
Figure 3-15 Configuring the Invoke Activity
In the Partner Link box, select the partner link to invoke. This is the partner link that you configured in the previous section. The Operation is automatically selected.
Click the Create icon next to the Input Variable field. Enter a descriptive name for the variable in the Create Variable dialog box that appears. You can also accept the default name. Click OK. Figure 3-16 shows the Create Variable dialog box.
Figure 3-16 Creating a Variable
Click the Create icon next to the Output Variable field. Enter a descriptive name for the variable in the Create Variable dialog box that appears. You can also accept the default name. Click OK.
In the Invoke dialog box, click Apply, and then click OK. The invoke activity is configured.
The Transform activity can be used to configure the parameters for the input and output variables. The Transform activity can also be used if variable values need to be transformed before updating them in Oracle Applications.
The following steps discuss configuring the Transform activity:
Drag and drop Transform into the process map window. The Transform activity should be placed in between Receive and Invoke. Figure 3-17 shows the process map window after the Transform activity has been added.
Figure 3-17 Adding the Transform Activity
Double-click Transform in the process map to open the Transform dialog box. The Transformation tab is selected by default. Figure 3-18 shows the Transform dialog box.
Figure 3-18 Configuring the Transform Activity
Select the Source Variable and Target Variable from the respective boxes. Elements are mapped from the Source Variable to the Target Variable.
Select the Source Part of the variable from which to map elements. For example, the source part may be a payload schema consisting of a purchase order request.
Select the Target Part of the variable to which to map elements. For example, the target part may be a payload schema consisting of a purchase order acknowledgment.
Click the Create icon next to the Mapper File field to create a new transformation mapping file. Mapper File specifies the file in which you create the mappings using the XSLT Mapper Transformation tool.
The transformation mapping file is displayed. The Design view is displayed by default.
You can define the parameter values in the Design view. Drag a string function to the Design area. Connect the function to the appropriate parameter for which you want to define a value.
Note:You can use an input parameter value from the source variable, transform it using a string function, and use it as the input parameter value for the target variable.
Double-click the icon for the function. The Edit Function dialog box is displayed. Figure 3-19 shows the Edit Function dialog box.
Figure 3-19 Supplying the Function Parameters
After designing the BPEL process, the next step is to deploy, run and monitor it. This section discusses the following:
You must deploy the BPEL process before you can run it. The BPEL process is first compiled, and then deployed to the BPEL server. The following steps discuss deploying the BPEL process to a BPEL server:
Select the BPEL project in the Applications window.
Right-click the project name, and then select Deploy from the menu that appears.
Select Local BPEL Server followed by Deploy to Default Domain, if you are deploying the process on the local BPEL server. Figure 3-20 illustrates deploying a BPEL process to a local BPEL server.
Figure 3-20 Deploying the BPEL Process
The Password Prompt dialog box appears. Enter the password for the default domain in the Domain Password field, and then click OK. Figure 3-21 shows the Password Prompt dialog box.
Figure 3-21 Specifying the Domain Password
The BPEL process is compiled and deployed. You can check the progress in the Messages window. Figure 3-22 shows the Messages window.
Figure 3-22 Messages Window
Once the BPEL process is deployed, it can be seen in the BPEL console. You can manage and monitor the process from the BPEL console. You can also test the process and the integration interface by manually initiating the process. The following steps discuss manually initiating and monitoring the BPEL process:
To open the BPEL console, click Start, and then choose Programs. In the Programs menu, select Oracle - ORACLE_HOME, Oracle BPEL Process Manager 10.1.2, and then select BPEL Console.
The BPEL console login screen is displayed, as shown in Figure 3-23.
Figure 3-23 BPEL Console Login Screen
Select Default in the Domain box. Enter the password for the default domain in the Password field, and then click Login.
Oracle BPEL console is displayed.
A list of deployed processes is shown under Deployed BPEL Processes. Figure 3-24 shows the BPEL console screen.
Figure 3-24 Deployed BPEL Processes
Click the BPEL process that you want to initiate. The Initiate page is displayed. Enter the input string required by the process.
Click Post XML Message to initiate the process.
The BPEL process is now initiated. You can check the process flow by clicking the Visual Flow icon. shows the BPEL Console Initiate page.
Figure 3-25 BPEL Console Initiate Page
Note:To confirm that the records have been written into the Oracle Applications, you can write SQL