|
Oracle® Application Server Adapter for SAP R/3 User's Guide
10g Release 2 (10.1.2) Part No. B14061-01 |
|
 Previous |
 Next |
|
Oracle® Application Server Adapter for SAP R/3 User's Guide
10g Release 2 (10.1.2) Part No. B14061-01 |
|
|
Previous |
Next |
This chapter describes how to use Application Explorer to define a target to connect to an SAP system, view system objects, and create XML schemas and Web services. This chapter also explains how to configure an event adapter.
This chapter discusses the following topics:
The server must be started where Application Explorer is deployed.
To start Application Explorer:
Ensure the server is started where Application Explorer is deployed.
On Windows, invoke iaexplorer.exe, found under OracleAS_home\adapters\application\tools or on UNIX, invoke the iwae script, iwae.sh, found under OracleAS_home/adapters/application/tools.
Application Explorer opens. You are ready to define new targets to your SAP system.
You need not configure the OracleAS Adapter Business Services Engine (BSE) for a file-based repository because it is configured during the Oracle installation. You also need not configure the OracleAS Adapter JCA because the ra.xml file is configured automatically during installation.
After BSE is deployed to Oracle Application Server, you can configure it through the BSE configuration page. This configuration is required only when using a database repository with BSE.
To configure BSE:
Open the following page in your browser:
http://hostname:port/ibse
Is the hostname of the Oracle Application Server.
For example,
http://localhost:7777/ibse
|
Note: The first time you access this page, it may take time to load. |
The BSE configuration page opens.
Ensure the Adapter Lib Directory parameter specifies the path to the lib directory, for example:
OracleAS_home\adapters\application\lib
After you specify the path, adapters in the lib directory are available to BSE.
|
Note: The Repository URL field specifies where the file system repository is located. To use a database repository, you must enter the repository connection information. For the initial verification, use a file system repository. See "Configuring an Oracle Repository" for information on switching to a database repository. |
To configure Business Services (BSE) system settings:
|
Note: The server to which BSE is deployed must be running. |
Configure the system settings.
The following table lists the parameters with descriptions of the information to provide.
The following image shows the Security pane.
Configure the security settings.
The following table lists the parameters with descriptions of the information to provide.
| Parameter | Description |
|---|---|
| Admin User | Provide a BSE administrator ID. |
| Admin Password | Type the password associated with the BSE administrator ID. |
| Policy | Select the check box to enable policy security. |
The following image shows all of the fields and the check box for the Repository pane.
Configure the repository settings.
BSE requires a repository to store transactions and metadata required for the delivery of Web services.
See "Configuring a File System Repository" and "Configuring an Oracle Repository" for more information.
The following table lists the parameters with descriptions of the information to provide.
Configuring a File System Repository
If you do not have access to a database for the repository, you can store repository information in an XML file on your local machine. However, a file system repository is less secure and efficient than a database repository. When BSE is first installed, it is automatically configured to use a file system repository.
The default location for the repository on Windows is:
OracleAS_home\j2ee\OC4J_CONTAINER\applications\ws-app-adapter \ibse\ibserepo.xml
On other platforms, use the corresponding location.
If you are using a file system repository, you are not required to configure any additional BSE components.
Configuring an Oracle Repository
To configure an Oracle repository:
Contact your database administrator to obtain an Oracle user ID and password to create the BSE repository.
This user ID should have rights to create and modify tables as well as the ability to create and execute stored procedures.
Open a command prompt and navigate to the setup directory. The default directory location on Windows is:
OracleAS_home\adapters\application/etc
For other platforms, see the corresponding location.
This directory contains SQL to create the repository tables in the following file:
iwse.ora
|
Note: If Oracle is not on the same machine as the Oracle Application Server, copy the iwse.ora file to the Oracle machine. Then, from a command prompt on the Oracle machine, navigate to the directory containing the iwse.ora file. |
sqlplus userid/password @database @ iwse.ora
Before you use Application Explorer with the OracleAS Adapter for SAP, you must create a repository project. You can create two kinds of repository projects, Web services and JCA, depending on the container to which the adapter is deployed.
At design time, the repository is used to store metadata created when using Application Explorer to configure adapter connections, browse EIS objects, configure services, and configure listeners to listen for EIS events. The information in the repository is also referenced at runtime.
A default JCA repository is created for the default ManagedConnectionFactory. The name of this project is jca_sample.
Web services and the OracleAS Adapter Business Services Engine (BSE) refer to the same type of deployment. See "Adapter Features" for more information.
To create a Web service project for the Web service adapter using Application Explorer, you must first define a new configuration.
Defining a New Configuration for BSE
To define a new configuration for BSE:
Enter a name for the new configuration, for example, SampleConfig, and click OK.
In the BSE URL field, accept the default URL or replace it with a different URL with the following format:
http://hostname:port/ibse/IBSEServlet
Is the machine where your application server resides.
Is the port number where the application server is listening.
Click OK.
A node representing the new configuration appears beneath the root Configurations node.
The Web service repository project file is stored in OracleAS_home\j2ee\home\applications\ws-app-adapter\ibse.
To create a repository project for the OracleAS Adapter JCA using Application Explorer, you must first define a new configuration.
Defining a New Configuration for JCA
To define a new configuration for JCA:
In the dialog box, type a name for the new configuration, for example, SampleConfig, and click OK.
The following dialog box opens.
In the Home field, enter a path to your JCA configuration directory where the repository, schemas, and other information is stored, for example:
OracleAS_home\adapters\application
Click OK.
A node representing the new configuration appears beneath the root Configurations node.
The OracleAS Adapter JCA repository project file is stored in OracleAS_home\adapters\application\config\configuration_name
configuration_name
Is the name of the configuration you created; for example, SampleConfig.
To connect to a new configuration:
Right-click the configuration to which you want to connect, for example, SampleConfig.
Select Connect.
Nodes appear for Adapters, Events, and Business Services (also known as Web services).
Use the Adapters folder to create inbound interaction with SAP. For example, you use the SAP node in the Adapters folder to configure a service that updates SAP.
Use the Events folder to configure listeners that listen for events in SAP.
Use the Business Services folder to test Web services created in the Adapters folder. You can also control security settings for the Web services by using the security features of the Business Services folder.
You are now ready to define new targets to SAP.
Defining the application includes adding a target for the OracleAS Adapter for SAP. Setting up the target in Application Explorer requires information that is specific to the adapter.
To browse the available business functions, you must first define a target to SAP. After you define the target, it is automatically saved. You must connect to the SAP system every time you start Application Explorer or after you disconnect.
When you launch Application Explorer, the left pane displays (as nodes) the application systems supported by Application Explorer, based on the adapters that are installed.
To connect to SAP for the first time, you must define a new target.
Defining a Target for SAP
In the left pane, expand the Adapters node.
The applications systems supported by Application Explorer appear as nodes based on the adapters that are installed.
Right-click the SAP node and select Add Target.
Click OK.
The Application Server dialog box appears.
The following tabs are available:
System (Required)
User (Required)
Advanced
Security
For the System tab, type the appropriate information for your SAP target based on the information in the following table.
Table 2-1 System Tab Parameters
For the User tab, type the appropriate information for your SAP target based on the information in the following table.
Table 2-2 User Tab Parameters
| Target Parameter | Description |
|---|---|
| Client | The client number defined for the SAP application for client communications. |
| User | A valid user ID for the SAP application. |
| Password | A valid password for the SAP application. |
| Language | A language key. EN (English) is the default. |
| Code page | A character code page value. |
| SAP Trace | Select this option to enable traces. |
For the Advanced tab (optional), type the appropriate information for your SAP target based on the information in the following table.
Table 2-3 Advanced Tab Parameters
| Target Parameter | Description |
|---|---|
| Connection pool size | Enter the number of connections you want to make available to SAP. |
| Connection pool name | Enter the name of your SAP connection pool. |
| BAPI Exception Handling | Select Throws Exception or Creates Error Document from the list in the event of a BAPI exception. |
| Commit with wait | This option is disabled by default. |
For the Security tab (optional), type the appropriate information for your SAP target based on the information in the following table.
Table 2-4 Security Tab Parameters
|
Note: SNC provides protection for the communication links between the distributed components of an R/3 System. Using SNC, SAP R/3 can support products which adhere to the GSS-API Version 2 standard. SNC supports application level (end-to-end security), Smartcard authentication, and single sign-on. |
When you have supplied all the required information for your target, click Finish.
After the extraction finishes, the new target, SAPTarget, appears under the sap node.
See "Creating an XML Schema" for information on how to create schemas for the adapter.
Connecting to a Defined SAP Target
Expand the Adapters node.
Expand the SAP node.
Under the SAP node, click the target name, for example, SAPTarget.
The Connection dialog box opens, populated with values you entered for the connection parameters.
Verify your connection parameters. If required, provide the password.
Right-click the target name and select Connect.
The x icon disappears, indicating that the node is connected.
To manage SAP connections, you can:
Disconnect from a connection that is not currently in use.
Although you can maintain multiple open connections to different transaction processing systems, it is recommended to disconnect from connections not in use.
Edit a target.
Delete a connection that is no longer required.
Disconnecting from a Connection to SAP
Expand the Service Adapters node.
Expand the SAP node.
Right-click the target to which you are connected, for example, SAPTarget, and select Disconnect.
Disconnecting from the SAP target drops the connection with SAP, but the node remains. The x icon appears, indicating that the node is disconnected.
Editing a Target
In the left pane, ensure the target you wish to edit is disconnected.
Right-click the target and select Edit.
The Edit pane opens on the right.
Modify the target information.
Click OK.
Deleting a Connection to SAP
Expand the Service Adapters node.
Expand the SAP node.
Right-click the target to which you are connected, for example, SAPTarget, and select Delete.
The node disappears from the list of available connections.
|
Note: Depending on the release or service pack installed, certain RFCs, for example, RFC_CUSTOMER_GET, may not exist in your particular SAP system. Therefore, the examples included in this documentation may not be relevant to your system. If this is the case, you should use the examples as a general reference for adapter functionality and choose an RFC that exists within your SAP application environment.As described in SAP Release Note 109533, SAP Function Modules (RFCs) can be delivered with different release statuses. SAP supports only RFCs that are awarded with the Released for Customer status. There is no claim to the release independencies of the interfaces and the continued existence/functionality of the modules. For more information on the status of a specific function module, consult your SAP Service Marketplace. |
See the SAP User's Guide for more information.
After you explore the SAP business function library and select an object, you can use Application Explorer to create the XML request schema and the XML response schema for that function.
The following procedure explains how to create request and response schemas for an SAP business function. Application Explorer enables you to create XML schemas for this function.
Connect to an SAP target as described in "Connecting to a Defined SAP Target".
Expand the Business Object Repository node.
Click the icon to the left of the Financial Accounting group.
Scroll down and click the icon to the left of the Company business object.
Scroll down and select the BAPI named BAPI_COMPANY_GETLIST.
The following screen appears on the right.
To view the XML for each schema type, click the appropriate tab.
You can generate a Web service (also known as a business service). You can explore the business function repository and generate Web services for the SAP functions you want to use with the adapter. The following procedure uses the SAP BAPI method called BAPI_MATERIAL_GETLIST as an example and returns a list of materials from SAP.
|
Note: In a J2EE Connector Architecture (JCA) implementation of the adapter, Web services are not available. When the adapter is deployed to use the OracleAS Adapter JCA, the Common Client Interface provides integration services using the adapter. |
Creating a Web Service or Business Service
To create a Web service for an SAP business function:
Expand the sap node and then expand the Business Object Repository node.
Select the BAPI_MATERIAL_GETLIST method from the Business Object Repository.
Right-click the node from which you want to create a business service and select Create Business Service.
The Create Web Service dialog box opens.
You can add the business function as a method for a new Web service or as a method for an existing one.
From the Existing Service Names list, select either <new service> or an existing service.
Specify a service name if you are creating a new service. This name identifies the Web service in the list of services under the Business Services node.
Type a description for the service (optional).
Select one of the available licenses.
Click Next.
The License and Method dialog box opens.
In the License field, select one or more license codes to assign to the Web service. To select more than one, hold down the Ctrl key and click the licenses.
In the Method Name field, type a descriptive name for the method.
In the Description field, type a brief description of the method.
Click OK.
Application Explorer switches the view to the Business Services node, and the new Web service appears in the left pane.
Testing a Web Service or Business Service
After a Web service is created, you can test it to ensure it functions properly. A test tool is provided for testing the Web service.
To test a Web service:
If you are not on the Business Services node of Application Explorer, click the node to access Web services.
If it is not expanded, expand the list of Web services under Business Services.
Expand the Services node.
Select the name of the business service you want to test.
The business service name appears as a link in the right pane.
In the right pane, click the named business services link.
The test option appears in the right pane.
If you are testing a Web service that requires XML input, an input field appears.
Enter the appropriate input.
Click Invoke.
Application Explorer displays the results.
Events are generated as a result of activity in a database or in an application system. You can use events to trigger an action in your application. For example, an update to a database can reflect an update to customer information. If your application must perform when this happens, your application is a consumer of this event.After you create a connection to your application system, you can add events using Application Explorer. To create an event, you must create a port and a channel.
Port
A port associates a particular business object exposed by the adapter with a particular disposition. A disposition is a URL that defines the protocol and location of the event data. The port defines the end point of the event consumption. See "Creating an Event Port" for more information.
Channel
A channel represents configured connections to particular instances of back-end systems. A channel binds one or more event ports to a particular listener managed by the adapter. See "Creating a Channel" for more information.
|
Note: OC4J currently conforms to JCA 1.0, which does not call for event capabilities. When conforming to JCA 1.0, only service interactions are supported. |
Application Explorer enables you to create event ports from the Adapters node or from the Events node.
You can bypass the Events node and create an event port directly from the Adapters node.
To create an event port from the Adapters node:
Select the SAP object for which you want to create an event port.
Right-click the node and select Add Port.
The Add Port dialog box opens.
Type a name for the event port and provide a brief description.
From the list, select the required disposition, for example, File.
Type the disposition url.
Click OK.
See "Creating an Event Port From the Events Node" for information on configuring port dispositions.
The following procedures describe how to create an event port from the Events node for various dispositions using Application Explorer. You can switch between a BSE and a JCA deployment by choosing one or the other from the menu in the upper right of Application Explorer.
See "Creating an Event Port From the Adapters Node" for information on creating an event port directly from the Adapters node.
Creating an Event Port for RMI
To create a specific event port for RMI:
Click the Events node.
Expand the SAP node.
Right-click the Ports node and select Add Port.
The Add Port dialog box opens.
Type a name for the event port and provide a brief description.
From the Protocol list, select RMI.
In the URL field, specify a destination file to which the event data is written using the following format:
rmi://host:port;RemoteObject=[APPNAME];errorTo=[pre-defined port name or another disposition url]
From the Disposition protocol list, select RMI.
The following table defines the parameters for the disposition.
| Parameter | Description |
|---|---|
| host | The host name or IP address from which the RMI server accepts RMI requests. If you omit this attribute, the RMI server will accept RMI requests from any host. |
| port | The port number on which the RMI server listens for RMI requests. |
| RemoteObject | A home or Enterprise Java Bean (EJB) object. |
| errorTo | Predefined port name or another disposition URL to which error logs are sent. |
Click OK.
The port appears under the ports node in the left pane. In the right pane, a table appears that summarizes the information associated with the event port you created.
You are ready to associate the event port with a channel. See "Creating a Channel Using Application Explorer" for more information.
Modifying an Event Port
The following procedures describe how to edit and delete an RMI event port using Application Explorer.
Editing an Event Port
To edit an event port using Application Explorer:
Expand the Events node.
Expand the SAP node.
Right-click the event port you want to edit and select Edit.
The Edit Port pane opens.
Make the required changes and click OK.
Deleting an Event Port
To delete an event port using Application Explorer:
Expand the Events node.
Expand the SAP node.
Right-click the event port you want to delete and select Delete.
A confirmation dialog box opens.
To delete the event port you selected, click OK.
The event port disappears from the list in the left pane.
The following procedure describes how to create a channel for your event. All defined event ports must be associated with a channel.
Creating a Channel
To create a channel:
Click the Events node.
Expand the SAP node.
Right-click Channels and select Add Channel.
The Add Channel dialog box opens.
Type a name for the channel, for example, TEST_CHANNEL.
Type a brief description.
From the Protocol list, select SAP Channel.
Select an event port from the list of available ports.To select more than one, hold down the Ctrl key and click the ports.
To transfer the ports to the list of selected ports, click the >> (double right) arrow button.
Click Next.
The Message Server dialog box opens.
The following tabs are available:
System (Required)
User (Required)
Advanced
For the System tab, type the appropriate information for your SAP channel based on the information in the following table.
Table 2-5 System Tab Parameters
| Target Parameter | Description |
|---|---|
| Gateway host | A host name for the SAP Gateway. |
| Gateway service | A service for the SAP Gateway. |
| Program ID of the server | An SAP program ID you want to use for this channel. |
| Message Server | A host name for the message server. |
| R/3 name | An SAP R/3 name. |
| Server group | An SAP server group. |
For the User tab, type the appropriate information for your SAP channel based on the information in the following table.
Table 2-6 User Tab Parameters
| Target Parameter | Description |
|---|---|
| Client | The client number defined for the SAP application for client communications. |
| User | A valid user ID for the SAP application. |
| Password | A valid password for the SAP application. |
| Language | A language key. EN (English) is the default. |
| Code page | A character code page value. |
For the Advanced tab (optional), type the appropriate information for your SAP channel based on the information in the following table.
Table 2-7 Advanced Tab Parameters
| Target Parameter | Description |
|---|---|
| IDOC Format | Select an IDoc type from the list. |
| User Defined Function Modules | Enter the path to the user-defined function module you created. |
| SAP trace | Select this check box if you want to enable SAP traces for troubleshooting purposes. |
| Unicode | Select this check box if you are expecting your response in Unicode format. |
| Synchronous Processing | Select the type of synchronous processing from the list. |
Click OK.
The channel appears under the channels node in the left pane.
An X over the icon indicates that the channel is currently disconnected. You must start the channel to activate your event configuration.
Right-click the channels node and select Start.
The channel you created becomes active.
The X that was over the icon in the left pane disappears.
To stop the channel, right-click the connected channels node and select Stop.
Editing a Channel
In the left pane, locate the channel you want to edit.
Right-click the channel and select Edit.
The Edit channels pane opens.
Make the required changes to the channel configuration and click Finish.
Deleting a Channel
In the left pane, locate the channel you want to delete.
Right-click the channel and select Delete.
A confirmation dialog box opens.
To delete the channel you selected, click OK.
The channel disappears from the list in the left pane.
