Skip Headers
Oracle® Application Server Adapter for PeopleSoft User's Guide
10g Release 2 (10.1.2)
B14060-03
  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
 

2 Configuring OracleAS Adapter for PeopleSoft

OracleAS Adapter Application Explorer (Application Explorer) enables the processing of Component Interfaces and Messages.

External applications that access PeopleSoft through the adapter use either XML schemas or Web services to pass data between the external application and the adapter. You can use Application Explorer to create the required XML schemas and Web services.

This chapter discusses the following topics:

Starting Application Explorer

To start Application Explorer:

  1. Ensure the server is started where Application Explorer is deployed.

  2. On Windows, select Start ,Programs, OracleAS_home Adapters, Application Explorer.

    On Windows, iaexplorer.bat is found under OracleAS_home\adapters\application\tools, where OracleAS_home is the directory where Oracle Application Server is installed.

    On UNIX, load the iwae script, iwae.sh, found under OracleAS_home/adapters/application/tools, where OracleAS_home is the directory where Oracle Application Server is installed.

Application Explorer starts. You are ready to define new targets to your PeopleSoft system.

Configuring Settings for BSE or J2CA

Before a repository project can be created, you must configure BSE. You need not configure the OracleAS Adapter J2CA because the ra.xml file is configured automatically during installation.

Configuring BSE

After BSE is deployed to Oracle Application Server, you can configure it through the BSE configuration page. This configuration is required only when pointing to BSE using a database repository.


Note:

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

To configure BSE:

  1. Display the following page in your browser:

    http://hostname:port/ibse
    
    

    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/ibse
    

Note:

If you are accessing this page for the first time, it may take longer to load.

  1. When prompted, log on.

    When first installed, the user ID and password are:

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

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


    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.

  4. Click Save.

Configuring BSE System Settings

To configure BSE system settings:

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

    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 pane is displayed, as shown in the following figure.

bse configuration page
Description of the illustration ibse_config_page.gif

  1. Configure the system settings.

    The following table lists the parameters with descriptions of the information to provide.

    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

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

  2. Configure the security settings.

    BSE security settings pane
    Description of the illustration security.gif

    The following table lists the parameters with descriptions of the information to provide.

    Parameter Description
    Admin User Provide a BSE administrator ID.
    Admin Password Enter the password associated with the BSE administrator ID.
    Policy Select the check box to enable policy security.

  3. 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 image shows all fields and check boxes for the Repository pane:

    configuring a repository
    Description of the illustration ibse_config_repos_loc.gif

    The following table lists the parameters with descriptions of the information to provide.

    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.

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

    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.

  3. Enter the following command:

    sqlplus userid/password @database @ iwse.ora
    

Configuring J2CA

During the J2CA deployment of OracleAS Adapter for PeopleSoft, 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.

Configuring a Database Repository for J2CA

To configure a database repository for J2CA:

  1. Execute the iwse.ora SQL statement on the machine where the database is installed.

  2. Copy the jcatransport.properties file to the following directory:

    OracleAS_home\adapters\application\config\jca_sample
    
    
  3. Uncomment the following fields and enter details for them in the jcatransport.properties file. For example:

    iwafjca.repo.url=jdbc:oracle:thin:@90.0.0.51:1521:orcl
    iwafjca.repo.user=scott
    iwafjca.repo.password=scott1
    
    
  4. Alter the JDBC driver path in Application Explorer's lcp. For example:

    lcp=..\lib\orabpel-adapters.jar;C:\jdev\jdbc\lib\classes12.jar;C:\jdev\jdbc\lib\nls_charset12.jar;%lcp%
    to
    lcp=..\lib\orabpel-adapters.jar;..\..\..\jdbc\lib\classes12.jar;..\..\..\jdbc\lib\nls_charset12.jar;%lcp%
    
    

Creating a Repository Configuration

Before you use Application Explorer with OracleAS Adapter for PeopleSoft, you must create a repository configuration. You can create two kinds of repository configurations, Web services and J2CA, depending on the container to which the adapter is deployed. During 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 J2CA repository is created for the default ManagedConnectionFactory. The name of this configuration is jca_sample.

Web services and BSE refer to the same type of deployment. See "Adapter Features" for more information.

Creating a Configuration for BSE

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

Defining a New Configuration for BSE

To define a new configuration for BSE:

  1. Right-click Configurations and select New.

    The New Configuration dialog box is displayed.

    New BSE configuration
    Description of the illustration ibsenewconfig1.gif

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

    The New Configuration dialog box is displayed.

    BSE configuration
    Description of the illustration ibseconfig.gif

  3. From the Service Provider list, select iBSE.

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

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

  1. Click OK.

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

    new configuration node
    Description of the illustration newconfig_a.gif

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.

    The New Configuration dialog box is displayed.

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

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

    new configuration
    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, myConfig.

Connecting to a BSE or J2CA Configuration

To connect to a new configuration:

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

  2. Select Connect.

Nodes appear for Adapters, Events, and Business Services (also known as Web services). The Business Services node is only available for BSE configurations. If you are connected to a J2CA configuration, you will not see the Business Services node. The following is an example of a BSE configuration named myConfig: Expanded configuration node
Description of the illustration confignodes.gif

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

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

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

Establishing a Connection (Target) for PeopleSoft

Part of the application definition includes adding a target for OracleAS Adapter for PeopleSoft. Setting up the target in Application Explorer requires information that is specific to the target.

To browse PeopleSoft business objects, you must create a target for the system you intend to use. The target serves as your connection point and is automatically saved after you create it. You must establish a connection to this system every time you start Application Explorer or after you disconnect from the system.

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.

Defining a Target to PeopleSoft

To connect to PeopleSoft for the first time, you must define a new target. OracleAS Adapter for PeopleSoft supports PeopleSoft standard security, in addition to component interface-level security. Once connected to the PeopleSoft application server, application security is managed by user ID, roles and privileges. For more information on PeopleSoft application security, see the appropriate PeopleSoft documentation.

To define a target:

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

    expanded adapter list
    Description of the illustration adapterexpandedpartial.gif

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

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

    1. In the Name field, enter a descriptive name for the target, for example, PSoftTarget.

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

    3. From the Target Type list, select Application Server.

      This is the only possible value for target type.

  3. Click OK.

    The Application Server dialog box is displayed. You must specify connection information for PeopleSoft and the application server that is hosting PeopleSoft.

    Application Server dialog box
    Description of the illustration wlw_newtarget11.gif

    Provide the following information:

    1. In the Application Server field, enter the host name or IP address for the computer that is hosting the PeopleSoft application.

    2. In the Port field, enter the port number where the PeopleSoft application is listening.

    3. In the User field, enter a valid user ID for the PeopleSoft application.

    4. In the Password field, enter a valid password for the PeopleSoft application.

  4. Click OK.

    In the left pane, the new target (PSoftTarget) appears the PeopleSoft node.

    disconnected PeopleSoft target node
    Description of the illustration wlw_newtarget5.gif

    You are ready to connect to your PeopleSoft target.

Connecting to a Defined PeopleSoft Target

To connect to an existing target:

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

  2. Expand the PeopleSoft node.

  3. Click the target name (for example, PSoftTarget) under the PeopleSoft node.

    The Connection dialog box displays the values you entered for connection parameters.

  4. Verify your connection parameters.

  5. Provide the correct password.

  6. Right-click the target name and select Connect.

    The x icon disappears, indicating that the node is connected. A list of PeopleSoft business objects is displayed.

    List of PeopleSoft business objects
    Description of the illustration wlw_newtarget7.gif

Managing a Target

Although you can maintain multiple open connections to different transaction processing systems, it is recommended that you disconnect from connections not in use. After you disconnect, you can modify an existing target.

You can modify the connection parameters when your system properties change. You also can delete a target. The following procedures describe how to disconnect from a target, edit a target, and delete a target.

Disconnecting from a Connection to PeopleSoft

To disconnect from a connection to PeopleSoft:

  1. Expand the Adapters node.

  2. Expand the PeopleSoft node.

  3. Right-click the target to which you are connected (for example, PSoftTarget), and select Disconnect.

    disconnecting from target
    Description of the illustration wlw_newtarget8.gif

    Disconnecting from PeopleSoft drops the connection with PeopleSoft, but the node remains. The x icon appears, indicating that the node is disconnected. disconnected PeopleSoft target node
    Description of the illustration wlw_newtarget5.gif

Modifying Connection Parameters

After you create a target for PeopleSoft using Application Explorer, you can edit any of the information that you provided previously.

To edit a target:

  1. Verify that the target you want to edit is disconnected.

  2. Right-click the target and select Edit.

    Edit PeopleSoft target
    Description of the illustration wlw_newtarget9.gif

    The Application Server dialog box displays the target connection information.

  3. Change the properties in the dialog box as required and click OK.

Deleting a Connection to PeopleSoft

To delete a connection to PeopleSoft:

  1. Locate the target you want to delete.

  2. Right-click the target (for example, PsoftTarget), and select Delete.

    Connect, Edit, and Delete options
    Description of the illustration wlw_newtarget10.gif

The node disappears from the list of available connections.

Viewing Application System Objects

After you are connected to PeopleSoft, Application Explorer enables you to explore and browse business object metadata. For example, Application Explorer enables you to view PeopleSoft Component Interface and Message metadata stored in the PeopleSoft business object repository.

For Component Interfaces(RPC), the adapter enables Delete, Insert, Query, Update, and Find.

To view application system objects:

  1. Click the icon to the left of the target name, for example, PSoftTarget.

    The target expands and the available system objects are displayed.

    PeopleSoft target objects
    Description of the illustration wlw_newtarget7.gif

  2. To expand the desired PeopleSoft repository node, click the icon to the left of the repository name, for example, Component Interfaces.

    A list of PeopleSoft Component Interfaces appears. You can now generate schemas.

Creating XML Schemas

After you browse the PeopleSoft business object repository, you can generate XML request and response schemas for the object you wish to use with your adapter.

Creating XML Request and Response Schemas Against BSE

To create XML request and response schemas for a PeopleSoft Component Interface against a BSE implementation:

  1. Expand the PeopleSoft node and then, expand the Component Interfaces node.

  2. From the list of Component Interfaces, select LOCATION.

  3. Click the Request Schema or Response Schema tab to view the request schema information.

    The schema you selected appears.

    After you browse the Component Interfaces and make a selection, the request and response XML schemas are automatically created for that Component Interface and stored in the repository you created.

Creating XML Request and Response Schemas Against the OraclesAS Adapter J2CA

To create XML request and response schemas for a PeopleSoft Component Interface against an OraclesAS Adapter J2CA implementation:

  1. Expand the PeopleSoft node and then, expand the Component Interfaces node.

  2. From the list of Component Interfaces, select LOCATION.

  3. Click the Request Schema or Response Schema tab to view the request schema information.

    The schema you selected appears.

    After you browse the Component Interfaces and make a selection, the request and response XML schemas are automatically created for that Component Interface and stored in the repository you created.

Generating WSDL (J2CA Configurations Only)

The Web Service Definition Language (WSDL) description of a 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.


Note:

The Create Inbound JCA Service (Event) option is only available when the selected node supports events.

To generate a WSDL file for request-response service:

  1. After you create a schema, right-click the respective object.

    The following menu is displayed.

    Export WSDL dialog box
    Description of the illustration wlae_exportwsdl.gif

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

    The Export WSDL dialog box is displayed.

    Export WSDL dialog box
    Description of the illustration bpel_41.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.

The procedure for generating WSDL for event notification is similar to request-response. To generate WSDL for event notification, you must first create a channel for every event. See "Generating WSDL for Event Notification" for a detailed example.

Creating and Testing a Web Service (BSE Configurations Only)

You can create Web services (also known as a business service) using Application Explorer. The PeopleSoft Component Interface called LOCATION is used as an example in the following procedure.


Note:

In a J2EE Connector Architecture (J2CA) implementation of adapters, Web services are not available. When the adapters are deployed to use OracleAS Adapter for J2CA, the Common Client Interface provides integration services using the adapters.

Creating a Web Service

To create a Web service, perform the following steps:

  1. Expand the PeopleSoft node and then the Component Interfaces node.

  2. From the list of Component Interfaces, select LOCATION.

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

    Create Web Service menu
    Description of the illustration create_webservice.gif

    The Create Web Service dialog box is displayed.

    Create Web Service dialog box
    Description of the illustration create_webservice_2.gif

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

  1. Click Next.

    The license and method dialog box is displayed.

    License and method name dialog box
    Description of the illustration create_webservice_3.gif

    Perform the following steps:

    1. In the License Name 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 Method Description field, enter a brief description of the method.

    4. The DTD Directory field specifies a destination for your Web service. You may click Browse to change the default location.

  2. 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 a Web service is created, you can test it to ensure that it functions properly. A test tool is provided for testing the Web service.

To test a business service:

  1. Click the Business Services node to access your Web services.

  2. Expand the Services node.

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

    The business service name appears as a link in the right pane.

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

  5. Enter the appropriate input.

  6. Click Invoke.

    Application Explorer displays the results.

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 PeopleSoft. The user name and password values that you provided for PeopleSoft 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.

Configuring an Event Adapter

Events are generated as a result of activity in an application system. You can use events to trigger an action in your application. For example, PeopleSoft may generate an event when customer information is updated. If your application performs an action 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.


Note:

If you are using a J2CA configuration, you must create a new channel for every event and select this channel when you generate WSDL. Additionally, you are not required to create or configure ports for use with BPEL Process Manager. See "J2CA Filtering Port Option for Integration with BPEL Process Manager" for details on using ports under a J2CA configuration.


Note:

Oracle Containers for J2EE (OC4J) currently conforms to J2CA 1.0, which does not call for event capabilities. When conforming to J2CA 1.0, only service interactions are supported.

Creating and Editing an Event Port

Application Explorer enables you to create event ports from the Adapters node or from the Events node.


Note:

You are not required to create event ports for J2CA configurations. You must create event ports for BSE configurations only.

Creating an Event Port from the Adapters Node

You can bypass the Events node and create an event port directly from the Adapters node. Perform the following steps:

  1. Right-click any node under Messages.

  2. Select Create Event Port.

    Create event port
    Description of the illustration create_eventport.gif

    The Create Event Port dialog is displayed. Perform the following steps:

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

    2. From the Protocol drop-down list, select the required disposition, for example, RMI.

    3. Enter the disposition URL.

    4. Specify the location of your Web service.

  3. Click OK.

    See "Creating an Event Port from the Events Node" for information on configuring port dispositions.

Creating an Event Port from the Events Node

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 J2CA deployment by choosing one or the other from the menu in the upper right of Application Explorer.

Creating an Event Port for RMI

To create a specific event port for RMI:

  1. Click the Events node.

    Events node
    Description of the illustration eventexpandedpartial.gif

  2. Expand the PeopleSoft node.

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

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

    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;errorTo=pre-defined port name or another disposition url
      
      

      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.
      errorTo Predefined port name or another disposition URL to which error logs are sent.

    4. 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 can now associate the event port with a channel. See "Creating and Editing 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. In the left pane, 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.

J2CA Filtering Port Option for Integration with BPEL Process Manager

This feature provides the option to use event ports when using OracleAS Adapter for PeopleSoft with BPEL PM under a J2CA configuration. Without this feature, all messages from a particular channel are forwarded to the endpoint and then to the BPEL PM Server. In this case, no schema validation takes place. With the filtering feature, you have the option to associate an event schema to a port that you create and configure in Application Explorer. In this case, at runtime the message is validated against the event schema and only the validated event message is forwarded to the endpoint. If the event message does not match the event schema that is associated to the port, then an error message is written to the log and the event message is ignored.

Creating and Editing a Channel

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


Note:

If using a J2CA configuration, you must create a new channel for every event and select this channel when creating an inbound service. Creating a channel is required for both BSE and J2CA configurations.

Creating a Channel Using Specific Protocols

You can create the following types of channels using Application Explorer:

  • HTTP

  • TCP

  • File

The following procedures explain how to create these channels.


Note:

OC4J currently conforms to J2CA 1.0, which does not call for event capabilities. When conforming to J2CA 1.0, only service interactions are supported.

Creating an HTTP Channel

To create an HTTP Channel:

  1. Click the Events node.

  2. Expand the PeopleSoft node.

    The ports and channels nodes appear in the left pane.

  3. Right-click Channels and select Add Channel.

    The Add Channel dialog box is displayed.

    Add Channel dialog box
    Description of the illustration addchannel_2.gif

    Provide the following information:

    1. Enter a name for the channel, for example, PSFT_channel.

    2. Enter a brief description.

    3. From the Protocol list, select HTTP Listener.

      Important: If you are using BPEL Process Manager with a J2CA configuration without the optional port feature, skip the following step. See "J2CA Filtering Port Option for Integration with BPEL Process Manager".

    4. Select an event port from the list of available ports.

      To transfer the port to the list of available ports, click the double right (>>) arrow. To associate all the event ports, control-click to select each port or click one port and press Control+A. Then, click the double right (>>) arrow.

  4. Click Next.

    The Basic dialog box is displayed.

    Basic dialog box
    Description of the illustration addhttpchannel.gif

  5. Enter the system information as specified in the following table:

    Parameter Description
    Listener port Port on which to listen for PeopleSoft event data.
    Https For a secure HTTP connection, select the Https check box.
    Synchronization Type Choose from the following synchronization options:
    • REQUEST_RESPONSE

    • REQUEST_ACK

    Important: The PeopleSoft channel will not work if the synchronization type is set to REQUEST.


  6. Click OK.

    A summary pane is displayed, providing the channel description, channel status, and available ports. All the information is associated with the channel you created.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.


    Note:

    If you are using OracleAS Adapter for PeopleSoft with BPEL Process Manager, do not start the channel, as it is managed by the BPEL PM Server. If you start the channel for testing and debugging purposes, stop it before runtime.

  7. Right-click the channel and select Start.

    The channel you created becomes active. The X over the icon in the left pane disappears.

  8. To stop the channel, right-click the channel and select Stop.

Creating a TCP Channel

  1. Click the Events node.

  2. Expand the PeopleSoft node.

    The ports and channels nodes appear in the left pane.

  3. Right-click Channels and select Add Channel.

    The Add Channel dialog box is displayed.

    Add Channel dialog box
    Description of the illustration wlw_channel2.gif

    Perform the following steps:

    1. Enter a name for the channel, for example, PSoftChannel.

    2. Enter a brief description.

    3. From the Protocol list, select TCP Listener.

      Important: If you are using BPEL Process Manager with a J2CA configuration without the optional port feature, skip the following two steps. See "J2CA Filtering Port Option for Integration with BPEL Process Manager".

    4. Select an event port from the list of available ports. To select more than one, hold down the Ctrl key and select the ports.

    5. Click >> to transfer the port(s) to the list of selected ports.

  4. Click Next.

    The Tcp Listener dialog box is displayed.

    TCP Listener dialog box
    Description of the illustration tcp_channel_synch.gif

    Provide the following information:

    1. In the Host field, specify the host for your TCP listener (required).

    2. In the Port Number field, specify the port number for your TCP listener (required).

    3. From the Synchronization Type list, select from the following synchronization type options:

      RECEIVE_REPLY or

      RECEIVE_ACK

      Important: The PeopleSoft channel will only work with one of these synchronization types.

    4. Is Length Prefix check box: For PeopleSoft events that return data that is not in XML format. The TCP/IP event application must prefix the data with a 4-byte binary length field when writing data to the TCP/IP port.

    5. Is XML check box: For PeopleSoft events that return data in XML format. No preparser is required.

    6. Is Keep Alive check box: Maintains continuous communication between the event transaction and the channel.

  5. Click OK.

    The channel appears under the Channels node in the left pane.

    Channels node
    Description of the illustration wlw_channel4.gif

    An X over the icon indicates that the channel is currently disconnected. You must start the channel to activate your event configuration.


    Note:

    If you are using OracleAS Adapter for PeopleSoft with BPEL Process Manager, do not start the channel, as it is managed by the BPEL PM Server. If you start the channel for testing and debugging purposes, stop it before runtime.

  6. Right-click the channel node and select Start.

    The channel becomes active.

    Active channel
    Description of the illustration app_exp_channelactive.gif

    The X over the icon disappears.

  7. To stop the channel, right-click the connected channel node and select Stop.

    The channel becomes inactive and an X appears over the icon.

Creating a File Channel

To create a channel for the File listener:

  1. Click the Events node.

  2. In the left pane, expand the PeopleSoft node.

    The ports and channels nodes appear.

  3. Right-click Channels and select Add Channel.

    The Add Channel dialog box is displayed.

    Add Channel dialog box
    Description of the illustration addchannel_file.gif

    Perform the following steps:

    1. Enter a name for the channel, for example, NewFileChannel.

    2. Enter a brief description (optional).

    3. From the Protocol list, select File Listener.

      Important: If you are using BPEL Process Manager with a J2CA configuration without the optional port feature, skip the following step. See "J2CA Filtering Port Option for Integration with BPEL Process Manager".

    4. Select an event port from the list of available ports.

      To transfer the port to the list of available ports, click the double right (>>) arrow. To associate all the event ports, control-click to select each port or click one port and press Control+A. Then, click the double right (>>) arrow.

  4. Click Next.

  5. The File Listener dialog box is displayed.

    File Listener dialog box
    Description of the illustration file_listener.gif

    Enter the system information as follows:

    1. In the Request tab, enter values for the following parameters:

      Parameter Description
      Polling Location Target file system location for the PeopleSoft XML file.
      File Mask File name to be used for the output file generated as a result of the operation.

    2. In the Response tab, enter values for the following parameters:

      Parameter Description
      Synchronization Type Choose from the following synchronization options:
      • REQUEST_RESPONSE

      • REQUEST_ACK

      Important: The PeopleSoft channel will not work if the synchronization type is set to REQUEST.

      Response/Ack Directory Target file system location for the PeopleSoft XML file.

    3. In the Advanced tab, enter values for the following parameters:

      Parameter Description
      Error directory Directory to which documents with errors are written.
      Poll interval (msec) Interval (in milliseconds) when to check for new input. The default is three seconds. Optional.
      Processing Mode Sequential indicates single processing of requests.

      Threaded indicates processing of multiple requests simultaneously.

      Thread limit If you selected threaded processing, indicate the maximum number of requests that can be processed simultaneously.

  6. Click OK.

    A summary pane is displayed, providing the channel description, channel status, and available ports. All the information is associated with the channel you created.

    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.


    Note:

    If you are using OracleAS Adapter for PeopleSoft with BPEL Process Manager, do not start the channel, as it is managed by the BPEL PM Server. If you start the channel for testing and debugging purposes, stop it before runtime.

  7. Right-click the channel and select Start.

    The channel you created becomes active. The X over the icon in the left pane disappears.

  8. To stop the channel, right-click the channel and select Stop.

Editing a Channel

You must stop the channel before you can edit it. To edit a channel:

  1. In the left pane, locate 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 Finish.

Deleting a Channel

You must stop the channel before you can delete it. To delete a channel:

  1. In the left pane, locate 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.