2 Configuring Oracle Application Server Adapter for Siebel

Configuring BSE

After BSE is deployed to Oracle Application Server, you can configure it through the BSE configuration page.

To configure BSE:

1. Display the following page in your browser:

   http://hostname:port/bse
   
   

   Where hostname is the host name of Oracle Application Server and port is the HTTP port for Oracle Application Server.

For example,

http://localhost:7777/bse

2. When prompted, log on.

   When first installed, the user ID and the password are:

   • User name: admin

   • Password: admin

The BSE configuration page is displayed.

3. Ensure that 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.

4. For security purposes, enter a new password in the Admin Password field.

5. Click Save.

Configuring BSE System Settings

To configure BSE system settings:

1. Display the BSE configuration page by entering the following URL:

   http://hostname:port/ibse/IBSEConfig
   
   

   Where hostname is the machine where BSE is installed and port is the port number on which BSE is listening.

Note: The server to which BSE is deployed must be running.

The BSE settings window is displayed.

Description of the illustration ibse_config_page.gif

2. Configure the system settings by providing information for the parameters according to the following table.

   1. Parameter	Description
      Language	Specify the required language.
      Adapter Lib Directory	Enter the full path to the directory where the adapter jar files reside
      Encoding	Specify the default encoding from one of the following options: UTF-8 EBCDIC-CP-US ISO-88859-1 Shift JIS Shift JIS UNICODE
      Debug Level	Specify the debug level from one of the following options: None Fatal Error Warning Info Debug
      Number of Async. Processors	Select the number of asynchronous processors.

      
      

The following image illustrates the Security pane of the window.

Description of the illustration security.gif

3. Configure the security settings by providing information for the parameters according to the following table.

Parameter	Description
Admin User	Provide an BSE administrator ID.
Admin Password	Enter 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 boxes for the Repository pane.

Description of the illustration ibse_config_repos_loc.gif

4. Configure the repository settings by providing information for the parameters according to the following table.

   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.

Parameter	Description
Repository Type	Select one of the following repositories from the list: Oracle File (Do not use a file repository for BSE in production environments.)
Repository URL	Enter the URL to use when opening a connection to the database.
Repository Driver	Provide the driver class to use when opening a connection to the database (optional).
Repository User	Enter the user ID to use when opening a connection to the database.
Repository Password	Enter the password associated with the user ID.
Repository Pooling	Select the check box to enable pooling.

5. Click Save.

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.

Note: Do not use a file repository for BSE in production environments.

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:

1. 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.

2. Open a command prompt and navigate to the setup directory. Its default location on Windows is:

   OracleAS_home\adapters\application\etc\setup
   

   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 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.

3. Enter the following command:

   sqlplus userid/password @database @ iwse.ora
   

Configuring J2CA

During the J2CA deployment of OracleAS Adapter for Siebel, OC4J generates a deployment descriptor called oc4j-ra.xml. This descriptor provides OC4J-specific deployment information for resource adapters. See Chapter 3, "OC4J Deployment and Integration" for more information on J2CA deployment and configuration.

No configuration changes are necessary if you are using the default file based repository with J2CA deployment.

Creating a Configuration for BSE

To create a configuration for BSE using Application Explorer, you must first define a new configuration.

Defining a New Configuration for BSE

To create a new configuration for BSE:

1. Right-click Configurations and select New.

   The New Configuration dialog box is displayed.

2. Enter a name for the new configuration (for example, SampleConfig) and click OK.

   The following dialog box is displayed.

   
   Description of the illustration app_exp_new_config_type.gif
   
   

3. From the Service Provider list, select iBSE.

4. In the iBSE URL field, accept the default URL or replace it with a different URL with the following format:

   http://hostname:port/ibse/IBSEServlet
   
   

   Where hostname is the machine where your application server resides and port is the port number where the application server is listening.

5. Click OK.

   A node representing the new configuration appears beneath the root Configurations node.

   
   Description of the illustration newconfig_a.gif
   
   

The configuration file is stored in OracleAS_home\j2ee\home\applications\ws-app-adapter\ibse.

Creating a Configuration for J2CA

To create a configuration for OracleAS Adapter J2CA using Application Explorer, you must first define a new configuration.

Defining a New Configuration for J2CA

To define a new configuration for J2CA:

1. Right-click Configurations and select New.
   Description of the illustration selectnewconfig.gif
   
   

   The New Configuration dialog box is displayed.

2. Enter a name for the new configuration (for example, SampleConfig) and click OK.

   
   Description of the illustration jcaconfig.gif
   
   

3. From the Service Provider list, select JCA.

4. In the Home field, enter a path to your J2CA configuration directory where the repository, schemas, and other information is stored, for example:

   OracleAS_home\adapters\application
   
   

5. Click OK.

   A node representing the new configuration appears beneath the root Configurations node.

   
   Description of the illustration newconfig_a.gif
   
   

The OracleAS Adapter J2CA configuration file is stored in OracleAS_home\adapters\application\config\configuration_name

Where configuration_name is the name of the configuration you created; for example, SampleConfig.

Connecting to a New Configuration

To connect to a new configuration:

1. Right-click the configuration to which you want to connect, for example, SampleConfig.

2. Select Connect.

   Nodes appear for Adapters, Events, and Business Services (also known as Web services).

   
   Description of the illustration wlw_newconfig8.gif
   
   

• Use the Adapters folder to create inbound interaction with Siebel. For example, you use the Siebel node in the Adapters folder to configure a service that updates Siebel.

• Use the Events folder to configure listeners that listen for events in Siebel.

• Use the Business Services folder (available for BSE configurations only) 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 Siebel.

Defining a Target to Siebel

To define a target to Siebel:

1. In the left pane, expand the Adapters node.

   
   Description of the illustration adapterexpandedpartial.gif
   
   

2. Right-click the Siebel node and select Add Target.

   The Add Target dialog box is displayed. Provide the following information:

   1. In the Name field, enter a name for the new target.

   2. In the Description field, enter a description (optional).

   3. From the Target Type list, select the type of target. For Siebel 6.0, choose Siebel 6.2 or lower (COM). For Siebel 6.3 or higher, choose Java Bean Data Connection.

3. Click OK.

   When you select Siebel 6.2 or lower (COM):

   1. In the User Agent File field, enter the name of the configuration file.

   2. In the Username field, enter the user name.

   3. In the Password field, enter the password associated with the user name.

   4. In the Repository field, enter the Siebel Repository where Application Explorer looks for metadata describing Business Services, Business Objects, and Integration Objects.

      If no repository is specified, a full list of objects from all available repositories will be returned. If a specified repository is not found, an empty list of objects will be returned.

   When you select 6.3 or higher (JDB):

   1. In the Gateway Server field, enter the name of the server. To specify a Gateway Server that uses a port other than the default (usually, 2320), add a colon and the port number, for example, gateway name:port number.

   2. In the Enterprise Name field, enter the appropriate name.

   3. In the Siebel Server field, enter the name of your Siebel server. You do

      not have to supply a value in this field when connecting to a Siebel 7.7 system.

   4. In the User field, enter the user name.

   5. In the Password field, enter the password associated with the user name.

   6. Click the Advanced tab and verify the following:

      Language

      Object Manager

      For Siebel 7.0.3, the default Object Manager is EAIObjMgr. For Siebel 7.7, the default is EAIObjMgr_enu. Siebel 7.7 requires that you add a language extension (for example, _enu) to the end of the Object Manager name. Check with your Siebel Administrator for the specific names that apply to your system.

      If no repository is specified, a full list of objects from all available repositories is returned. If a specified repository is not found, an empty list of objects is returned.

      The configuration parameters supplied are used by Siebel client applications to connect to the Siebel system. For more information about these parameters, see your Siebel documentation or ask your Siebel system administrator.

      Repository Manager

      If no repository is specified, a full list of objects from all available repositories will be returned. If a specified repository is not found, an empty list of objects will be returned.

      The configuration parameters supplied are those used by Siebel client applications to connect to the Siebel system. For more information about these parameters, see your Siebel documentation or ask your Siebel system administrator.

   
   

   Note: These parameters are typically found in Siebel configuration files stored under the Siebel server root/bin/<language> directory, where language is the Siebel code for the language you installed (enu for U.S English). For example, for Siebel versions 7 and higher on a Windows platform, for the Siebel Call Center module, these values can be found in the uagent.cfg file. Consult your Siebel administrator and you Siebel bookshelf documentation for more information

   
   

4. Click OK.

   In the left pane, the target you create appears under the Siebel node.

Connecting to a Defined Target

To connect to a defined target:

1. Expand the Siebel node and click the target name to which you want to connect.

   
   Description of the illustration siebel_target.gif
   
   

2. In the right pane, enter the password for that target.

3. In the left pane, right-click the target name and select Connect.

   The target icon changes, indicating that you are connected to the Siebel system.

   
   Description of the illustration siebel_objects.gif
   
   

You can browse available Business Objects, Business Services, and Integration Objects in the Siebel system.

Disconnecting From Siebel

Although you can maintain multiple open connections to different application systems, it is good practice to close connections when not in use.

To disconnect from Siebel:

1. In the left pane, select the target to which you are connected.

2. Right-click the target and select Disconnect.

   Disconnecting from the application system drops the target, but the node remains. The SiebelConnection node in the left pane changes to reflect that the target is disconnected.

Editing a Target

To edit a target:

1. In the left pane, ensure the target you wish to edit is disconnected.

2. Right-click the target and select Edit.

   The Edit pane is displayed on the right.

3. Modify the target information.

4. Click OK.

Deleting a Target to Siebel

You can delete a target, rather than just disconnecting and closing it. When you delete the target, the node disappears from the list of Siebel targets in the left pane of Application Explorer.

To delete a target:

1. In the left pane, select the target.

2. Right-click the target and select Delete.

   A confirmation dialog box is displayed.

3. Click OK to delete the target you selected.

   The SiebelConnection node disappears from the left pane.

Viewing Metadata

To view metadata:

1. If you have not started Application Explorer, start Application Explorer and connect to your Siebel system.

2. In the left pane, expand the Business Object or Business Service containing the component for which you want to generate schema.

3. Expand the Business Object or Business Service node.

4. Expand the Business Component or the Business Service node to view the objects under it.

   • For a Business Component, select the node in which you are interested, for example, Account.

     
     Description of the illustration app_exp_bus-obj_accountm.gif
     
     

   • For a Siebel Business Service ,select the object in which you are interested, for example, addAccount.

     
     Description of the illustration app_exp_select_simple_add_ac.gif
     
     

5. In the right pane, click the ellipsis (...) in the Table row of the properties table.

   The metadata table appears in the right pane.

   
   Description of the illustration app_exp_showmetadata.gif
   
   

Creating a Web Service

To generate a Web service for a Siebel Business Object:

1. If you have not already connected, connect to your Siebel system.

2. Expand a Business Object node.

3. Expand the Business Component for which you want to create a Web service.

   
   Description of the illustration app_exp_select_busobject_query.gif
   
   

4. Expand the object and select a method for creating the Web service, for example, QueryWithView under Account.

5. Right-click the node from which you want to create a business service and select Create Business Service.

   The Create Web Service dialog box is displayed.

   You can add the business object as a method for a new Web service or as a method for an existing one. Perform the following steps:

• 1. From the Existing Service Names list, select either <new service> or an existing service.

  2. 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.

  3. Enter a description for the service (optional).

  4. Select one of the available licenses.

6. Click Next.

   The License and Method dialog box is displayed. Perform the following steps:

   1. 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.

   2. In the Method Name field, enter a descriptive name for the method.

   3. In the Description field, enter a brief description of the method.

7. 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

After you create a Web service for the Siebel Business Object, test it to ensure it functions properly. Application Explorer includes a test tool for testing a Web service.

Testing a Web Service for a Business Object

1. In the left pane of Application Explorer, expand the Business Services node.

2. Expand the Services node.

3. Select the name of the business service you want to test.

   
   Description of the illustration app_exp_test_select_busobj.gif
   
   

4. Expand the Methods node under the service and select the method you want to test.

   The test option appears in the right pane.

   If you are testing a Web service that requires XML input, an input field appears.

5. Click Invoke.

   Application Explorer displays the results in the results pane.

   
   Description of the illustration app_exp_querywithview_results.gif
   
   

Testing a Web Service for a Business Service

After you create a Web service for the Siebel Business Service, test it to ensure it functions properly. Application Explorer includes a test tool for testing a Web service.

1. If it is not expanded, expand the Business Services node.

2. Expand the Services node.

3. Select the name of the business service you want to test.

4. Expand the Methods node and select the name of the method you want to test.

   The test option appears in the right pane.

   If you are testing a Web service that requires XML input, an input field appears.

5. Provide the appropriate input.

6. Click Invoke.

   Application Explorer displays the results in the results pane.

Identity Propagation

If you test or execute a Web service using a third party XML editor, for example XMLSPY, the Username and Password values that you specify in the SOAP header must be valid and are used to connect to Siebel. The user name and password values that you provided for Siebel during target creation using Application Explorer are overwritten for this Web service request. The following is a sample SOAP header that is included in the WSDL file for a Web service:

<SOAP-ENV:Header>
  <m:ibsinfo xmlns:m="urn:schemas-iwaysoftware-com:iwse">
    <m:service>String</m:service>
    <m:method>String</m:method>
    <m:license>String</m:license>
    <m:disposition>String</m:disposition>
    <m:Username>String</m:Username>
    <m:Password>String</m:Password>
    <m:language>String</m:language>
  </m:ibsinfo>
</SOAP-ENV:Header>

You can remove the <m:disposition> and <m:language> tags from the SOAP header, since they are not required.

Creating an Event Schema for a Siebel Integration Object

You can listen for Siebel Integration Object events by configuring ports and channels. Before you create the ports and channels, you must create a schema. To create XML schemas for Siebel Integration Objects, you must first generate XDR schemas using the Siebel Tools Schema Wizard.

The XDR schema is used as input to Application Explorer when generating schemas for integration objects. After you generate the XDR schema, Application Explorer uses the XDR file to generate the XML schema.

OracleAS Adapter for Siebel supports access to Siebel Integration Objects by using Siebel XML to handle events. Using Siebel Integration Objects through supported transports requires Siebel workflows.

Creating a Siebel XDR Schema for a Siebel Integration Object

To generate a Siebel XDR schema:

1. Log on to Siebel Tools.

   
   Description of the illustration sibu_04_logon.gif
   
   

   1. Enter your user ID and password.

   2. Select a database from the list.

2. Click OK.

   The Siebel Tools window is displayed. Integration Objects appear in the right pane.

   
   Description of the illustration sibu_04_integobj.gif
   
   

3. To create a schema, select an Integration Object, for example, Sample Account.

4. Click Generate Schema.

   The Generate XML Schema wizard is displayed.

   
   Description of the illustration sibu_genxmlschema.gif
   
   

   1. From the Select a Business Service list, select EAI XML XDR Generator.

   2. From the Select an envelope type list, select Siebel Message envelope.

   3. In the Choose the file name field, specify a file name for the XDR schema and a directory where it can be accessed by Application Explorer.

      
      

      Note: The XDR schema file must be saved to a directory on the same computer as Application Explorer.

      
      

5. Click Finish.

   Now you can use Application Explorer to generate XML schemas for the Siebel Integration Object.

Creating a Schema from a Siebel XDR Schema

After you create the Siebel XDR schema for a selected Siebel Integration Object, you can create an XML schema using Application Explorer.

You must provide Application Explorer with the location of the previously created Siebel XDR schema for the particular integration object selected.

To create a schema from a Siebel XDR Schema:

1. In Application Explorer, expand the Integration Objects node to browse the Integration Objects in the Siebel system.

   
   Description of the illustration sampleaccount.gif
   
   

2. Scroll down and select an integration object, for example, Sample Account.

3. To generate event schema, right-click the object and choose Add event.

   The Add Event dialog box is displayed.

   1. In the Node name field, enter a name for the node to be created under Sample Account.

   2. Enter or browse to the location of the XDR schema where Application Explorer generates the service or event schema.

4. Click Add.

   The Schemas pane is displayed.

   
   Description of the illustration app_exp_event_gen_sche.gif
   
   

5. To view the XML for a schema, click the Event Schema tab.

   The results appear in the right pane.

   
   Description of the illustration app_exp_sampacct_bo_schema.gif
   
   

6. Click the browser Back button to return.

   A directory structure is created to store the schemas.

   You are now ready to configure ports and channels for Siebel Integration Objects.

Generating Web Service Definition Language (WSDL) (J2CA Configurations Only)

The Web Service Definition Language (WSDL) description of a Web service enables you to make the service available to other services within a host server. You use Application Explorer to create both request-response (outbound) and event notification (inbound) JCA services of the adapter.

To generate a WSDL file for request-response service:

1. Under your connected Siebel target, expand Business Object > Account > Account, navigate to an object, and right-click the object.

   The following menu is displayed.

   
   Description of the illustration wlae_exportwsdl.gif
   
   

2. Select Create Outbound JCA Service (Request/Response).

   The Export WSDL dialog box is displayed.

   
   Description of the illustration export_wsdl.gif
   
   

3. Accept the default name and location for the file.

   The .wsdl file extension is added automatically. By default, the names of WSDL files generated for request-response services end with _invoke, while those generated for event notification end with _receive.

   
   

   Note: You can organize your WSDL files in subfolders, creating your own WSDL hierarchy structure. Create the folders under OracleAS_home\adapters\application\wsdls\. The WSIL browser in JDeveloper will display the full tree structure of your WSDL hierarchy.

   
   

4. Click OK.

   The WSDL file is saved in the specified location.

Creating an Event Port

To create an event port for Siebel Integration Objects, you must first indicate the location of the XDR schema for that object.

You can create an event port from the Events node for Siebel Integration Objects. To create event ports for Siebel Business Objects and Siebel Business Services, you must use the Events node.

Creating an Event Port from the Adapters Node

For Siebel Integration Objects, you can bypass the Events node and create an event port directly from the Adapters node.

1. Select the Integration Object event you created.

2. Right-click the Integration Object event and select Add IO Node. You should not select Add Port.

   The Add IO Node dialog box is displayed. Perform the following steps:

   1. Enter a name for the event port and provide a brief description.

   2. From the list, select the required disposition, for example, RMI.

   3. In the URL field, enter the disposition URL.

3. Click OK.

4. Create a DTD for a Siebel event in one of two ways:

   • Right-click the IO node under Integration Objects, and select Create Web Service. A DTD created this way will have the name of <Node_Name>_request.dtd.

     Or

   • Right-click the IO node under Integration Objects, and select Create Event Port. A DTD created this way will have a name of <Node_Name>_event.dtd.

Creating an RMI Event Port From the Events Node

The following procedure describes how to create an event port from the Events node for an RMI disposition using Application Explorer.

To create an event port for Siebel Integration Objects, you must first indicate the location of the XDR schema for that object. See "Creating a Schema from a Siebel XDR Schema" for more information.

You also can create an event port directly from the Adapters node. See "Creating an Event Port from the Adapters Node" for more information.

Creating an Event Port for RMI

To create a specific event port for RMI:

1. Click the Events node.

   
   Description of the illustration eventexpandedpartial.gif
   
   

2. Expand the Siebel node.

3. Right-click the Ports node and select Add Port.

   The Add Port dialog box is displayed. Perform the following steps:

4. 1. Enter a name for the event port and provide a brief description.

   2. From the Protocol list, select RMI.

   3. In the URL field, specify a destination file to which the event data is written using the following format:

      rmi://host:port;RemoteObject=[APPNAME]
      
      

      APPNAME must be in uppercase. It is the adapter name you configured for the EIS Adapter Plugin.

   4. 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 JavaBeans (EJB) object.

   
   

5. 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" for more information.

Editing an Event Port

To edit an event port:

1. In the left pane, select the event port you want to edit.

2. Right-click the port and select Edit.

   The Edit Port pane is displayed.

3. Make the required changes and click OK.

Deleting an Event Port

To delete an event port:

1. Select the event port you want to delete.

2. Right-click the port and select Delete.

   A confirmation dialog box is displayed.

3. To delete the event port you selected, click OK.

   The event port disappears from the list in the left pane.

Creating a Channel

The following procedure describes how to create a channel for your event. All defined event ports must be associated with a channel.

Three channel types are available:

• HTTP

• MQ Series

• File

Editing a Channel

To edit a channel:

1. In the left pane, select the channel you want to edit.

2. Right-click the channel and select Edit.

   The Edit channels pane is displayed.

3. Make the required changes to the channel configuration and click OK.

Deleting a Channel

To delete a channel:

1. In the left pane, select the channel you want to delete.

2. Right-click the channel and select Delete.

   A confirmation dialog box is displayed.

3. To delete the channel you selected, click OK.

   The channel disappears from the list in the left pane.