Creating Third-Party Integrations Using WSDL

PeopleSoft provides you with the ability to create inbound and outbound integrations with third-party systems, including enterprise resource planning (ERP) systems, using Web Services Description Language (WSDL). This chapter discusses how to:

• Perform Integrations using WSDL.

• Use iWay SOAPswitch.

• Start and stop iWay SOAPswitch.

• Log in to iWay SOAPswitch.

• Generate WSDL using ERP connectors.

• Import WSDL into PeopleSoft.

• Use the WSDL repository.

• Create service transaction metadata for imported WSDL.

• Generate WSDL from PeopleSoft component interface and message definitions.

Understanding Integrations Using WSDL

A WSDL document is an XML file that contains information about the interface, semantics and other details of a call to a web service.

When someone wants to use a service, they request a WSDL document to find out the location of the service, the function calls and how to access them. They then use this information in the WSDL to form a Simple Object Access Protocol (SOAP) request and send it via HTTP to the external system endpoint.

PeopleSoft provides the capability to manually import WSDL into PeopleSoft via a file or URL. PeopleSoft also provides access to a third-party software product, iWay SOAPswitch, that provides ERP adaptors, or connectors, that enable you to generate WSDL from SAP, Oracle and Siebel systems, and import it into PeopleSoft. You can then use the Operation Wizard to create transaction metadata. From there you can create any necessary transformations, write required PeopleCode, and execute the integration.

PeopleSoft also enables you to expose PeopleSoft component interface and message definitions as WSDL to create integrations.

To perform integrations using WSDL you should have an understanding of the following:

• WSDL.

• SOAP.

• Creating transformations using Extensible Stylesheet Transformations (XSLT) and PeopleCode.

• Concepts of setting up integration broker metadata, such as setting up nodes, messages, message channels and so on.

Terminology

The following terminology is used when creating integrations using WSDL.

See Also

http://www.w3.org/TR/wsdl

Bindings

PeopleSoft supports WSDL bindings that define document and remote procedure call (RPC) styles.

If you use RPC bindings you must develop the appropriate transformations to perform the RPC calls.

Understanding iWay SOAPswitch

iWay SOAPswitch is a wizard-driven product that enables you to expose software functionality via web services, enabling you to make web services available to major development environments, such as SAP, Oracle and Siebel. SOAPswitch generates WSDL for web services, allowing for simplified client development. SOAPswitch accepts SOAP requests for web services, translates them into calls to the back-end system, and formulates SOAP replies based on back-end system responses.

Installing iWay SOAPswitch

iWay SOAPswitch is an installation option during the PeopleSoft Pure Internet Architecture installation process.

Note. Check the Enterprise PeopleTools 8.46 Installation Guide for your database platform to verify that iWay SOAPswitch is supported for your environment.

During the installation process you are prompted to install and specify a location for ERP connectors. Choosing to install the ERP connectors is synonymous with installing iWay SOAPswitch.

Components

iWay SOAPswitch is comprised of three main components:

Delivered Adapters

The following adapters are provided with the iWay SOAPswitch product delivered with PeopleTools 8.46:

Note. iWay SOAPswitch uses the term adapter to refer to connector. The terms SOAPswitch adapters and ERP connectors are used interchangeably in this chapter.

Operation Types

An iWay SOAPswitch operation type is equivalent to a PeopleSoft transaction type. The following table maps PeopleSoft transaction types to their equivalent iWay SOAPswitch operation types.

The iWay SOAPswitch documentation provides more information about operation types.

See iWay SOAPswitch Administration Guide, “Chapter 2: iWay SOAPswitch Overview,” Operational Types in WSDLs.

Web Services and Notifications

A web service defined on iWay SOAPswitch specifies inbound asynchronous or synchronous transactions to SOAPswitch.

Notifications specify outbound asynchronous or synchronous transactions from iWay SOAPswitch.

MySQL Database

iWay SOAPswitch delivers MySQL as the default database for event and audit logging. However, you can use other databases for this purpose.

See Also

iWay SOAPswitch Administration Guide, “Chapter 3: Configuring Your SOAPswitch Environment,” Logging.

Jetty Servlet Server

The iWay SOAPswitch product that ships with PeopleTools uses a stand-alone Jetty servlet server. The Jetty server is bundled with and is automatically installed when you install SOAPswitch. The Jetty servlet server is installed in the \temp directory, not in <SOAPSwitch_HOME>.

Running iWay SOAPswitch as a servlet under BEA WebLogic 8.1 or IBM WebSphere 5.1 is not yet supported.

More information about the Jetty servlet server is located in a readme.txt file located in the \soapswitch\Jetty-4.2.11 directory.

iWay SOAPswitch and Adapter Documentation

This PeopleBook provides summary information about tasks you perform in iWay SOAPswitch and with the iWay SOAPswitch adapters, and provides cross references to iWay SOAPswitch documentation whenever possible.

To take full advantage of iWay SOAPswitch you should thoroughly review the iWay SOAPswitch documentation.

Locating Documentation

You can access iWay SOAPswitch documentation from the SOAPswitch Administration Console.

1. Select PeopleTools, Integration Broker, Web Services, ERP Connectors. The iWay SOAPswitch Administration Console displays.

2. From the left navigation area, select Documentation.

Documentation List

The following iWay SOAPswitch documentation is provided in HTML and PDF formats:

• SOAPswitch Getting Started Guide

• SOAPswitch Administration Guide

• Managing Existing Web Services Guide

The following iWay SOAPswitch adapter documentation is available.

• J2EE Adapter Guide

• Oracle Applications Database (OAP) Adapter Guide

• SAP R/3 Adapter Guide

• Siebel Adapter Guide

• XML Adapter Guide

Starting and Stopping iWay SOAPswitch

This section describes how to:

• Start SOAPswitch Server.

• Stop SOAPswitch Server.

Understanding Starting and Stopping iWay SOAPswitch

To start and access iWay SOAPswitch, you must start SOAPswitch server.

To stop iWay SOAPswitch, you stop SOAPswitch server.

Common Elements Used in This Section

Starting iWay SOAPswitch Server

To start the SOAPswitch Server:

• In the Windows environment, select Start, Programs, iWay SOAPswitch, Start SOAPswitch Server. When SOAPswitch server is running, the server icon displays on the system tray.

• In the UNIX environment, launch the file runsoapswitch.sh located in the <ERPConnector_Install_Dir>/bin.

Stopping iWay SOAPswitch Server

This section discusses how to stop SOAPswitch Server.

Stopping SOAPswitch Server in Windows

To stop SOAPswitch Server in the Windows environment:

1. Right-click the SOAPswitch Server icon in the system tray.

2. Select Close.

Stopping SOAPswitch Server in UNIX

To stop SOAPswitch Server in the UNIX environment:

1. Navigate to <ERPConnector_Install_Dir>/bin.

2. Enter the following command:

   runsoapswitch.sh stop

Logging In to iWay SOAPswitch

This section discusses how to:

• Log in to iWay SOAPswitch.

• Change the iWay SOAPswitch user ID and password.

Logging In to iWay SOAPswitch

Login information for iWay SOAPswitch is stored in the ERP Connectors Admin page in the ERP Connectors Admin component (PT_IBWSDLADMIN). To access this page, select PeopleTools, Integration Broker, Web Services, ERP Connector Admin.

This login provides access to the iWay SOAPswitch functionality in the PeopleTools, Integration Broker, Web Services, ERP Connectors component.

By default, you are automatically logged into iWay SOAPswitch with the following default settings and values:

http://<machinename>:4400/ssw/api

Note. Change the default iWay SOAPswitch user ID and password as soon as possible.

Changing the iWay SOAPswitch Login User ID and Password

To change the iWay SOAPswitch login information:

1. To change the user ID:

   1. Select the Change User ID box.

   2. In the User ID field, enter a new user ID.

2. To change the password:

   1. Select the Change Password box.

   2. In the Password field, enter a new password.

   3. In the Confirm Password field, enter the new password again.

3. Click the Save button.

Generating WSDL Using the ERP Connectors

You can generate WSDL from SAP, Oracle and Siebel systems using the delivered ERP connectors accessible in the iWay SOAPswitch Administration Console. To access the this page, select PeopleTools, Integration Broker, Web Services, ERP Connectors.

This section highlights the steps for generating outbound and inbound integrations using the ERP connectors. In addition, this section provides brief summaries of each task. Complete documentation for performing these tasks is located in the iWay SOAPswitch Administration Guide and the individual adapter guides for specific ERP environments. Information about how to access iWay SOAPswitch documentation is provided earlier in this chapter.

See iWay SOAPswitch and Adapter Documentation.

Generating WSDL for Outbound Transactions

The steps to generate WSDL using the ERP connectors delivered with PeopleTools for outbound transactions from PeopleSoft are:

1. Configure the appropriate ERP connector.

2. Add a system.

3. Add roles and users.

4. Add a web service to the system.

Generating WSDL for Inbound Transactions

The follow list shows the steps to generate WSDL using the ERP connectors delivered with PeopleTools for inbound transactions to PeopleSoft.

1. Configure the appropriate ERP connector.

2. Add a system.

3. Add a consumer system.

4. Add roles and users.

5. Add a destination.

6. Add a notification to the system.

Configuring ERP Connectors

iWay SOAPswitch provides ERP connectors for back-end systems that enable you to generate web services. When you generate a web service, WSDL is produced as a by-product. You can then import the WSDL into entities that can consume them, such as PeopleSoft.

You must configure an ERP connector for outbound and inbound transactions.

Please see the iWay SOAPswitch adapter documentation appropriate for your back-end system for setting up and configuring iWay SOAPswitch adapters.

Information about documentation and how to access it is provided earlier in this chapter.

See iWay SOAPswitch and Adapter Documentation.

Adding Systems

When you add a system, you use the System Definition Wizard to identify the back-end system to use to interact with iWay SOAPswitch.

You must add a system for outbound and inbound transactions.

To access the System Definition Wizard to add a system:

1. Access the iWay SOAPswitch Administration Console. Select PeopleTools, Integration Broker, Web Services, ERP Connectors.

2. Access the System Definition Wizard.

   • Under the Getting Started section of the Administration Console, click Step 1. Add a System, or

   • In the left navigation area, click Systems.

See Also

iWay SOAPswitch Administration Guide, “Chapter 4: Accessing Back-End Servers.”

Adding Consumer Systems

When you add a consumer system, you specify the destination that iWay SOAPswitch uses for a notification. To add a consumer system, you use the Consumer System Definition Wizard to name the system and provide the URL to it.

Adding a consumer system is required for inbound transactions to PeopleSoft.

To access the Consumer System Definition Wizard to add a consumer system:

1. Access the iWay SOAPswitch Administration Console. Select PeopleTools, Integration Broker, Web Services, ERP Connectors.

2. In the left navigation bar, click Consumer Systems.

See Also

iWay SOAPswitch Administration Guide, “Chapter 7: Configuring Consumer System for Notification”

Adding Roles and Users

Security for web services is controlled via roles. Users you create will be able to interact with the web services.

Adding roles and users is optional for outbound and inbound transactions.

To add users and roles you use the New Role Definition Wizard.

To access the New Role Definition Wizard to add users and roles:

1. Select PeopleTools, Integration Broker, Web Services, ERP Connectors.

2. Access the New Role Definition Wizard:

   • Under the Getting Started section of the Administration Console, click Step 2. Add Roles and Users, or

   • In the left navigation area, click Access Control.

See Also

iWay SOAPswitch Administration Guide, “Chapter 8: Using Access Control.”

Creating Web Services

To create a web service from an SAP, Oracle or Siebel back-end system, use the Web Services Definition Wizard.

When you create a web service you make a connection with the back-end system and you can browse through the classes, methods and other subcomponents of the back-end system, choose a service name, select the methods of the back-end system to expose, choose protocol and security mechanisms, and so on. The last step in the Web Service Definition Wizard is to publish the web service to PeopleSoft. A WSDL document is created as a by-product of publishing the web service.

When you create a web service, you connect in real time to SAP and Siebel systems to browse and choose data. On an Oracle system you browse and choose data from static interface tables, and connect to the system when you publish the service. If the Oracle system is not available when you attempt to publish the service, the system hangs and no error or warning message displays. However, a message is logged in the SOAPswitch error log.

When you create a web service from SAP in Linux environments, if you set SAP tracing to OFF, SAP continues to generate trace files if you cannot connect to SAP, which results in numerous trace files being generated on a failed connection. You have only to register a program (in this case iWay SOAPSwitch) if you want to perform an SAP outbound call, where SAP is the client and SOAPSwitch is the server. If you don't have such an SAP outbound scenario just remove TOMMY from the SSW system settings (ProgramID).

Creating a web service is required for outbound transactions from PeopleSoft.

To add a web service, use the Web Services Definition Wizard.

To access the Web Services Definition Wizard:

1. Select PeopleTools, Integration Broker, Web Services, ERP Connectors.

2. Access the Web Services Definition Wizard:

   • Under the Getting Started section of the Administration Console, click Step 3. Add Web Services, or

   • In the left navigation area, click Web Services.

After you publish the web service to PeopleSoft, in the Pure Internet Architecture the WSDL information page displays and is populated with the generated WSDL for you to import into PeopleSoft.

See Importing WSDL Into PeopleSoft.

See Also

iWay SOAPswitch Administration Guide, “Chapter 12: Developing New Web Services.”

iWay SOAPswitch Administration Guide, “Chapter 16: Maintaining Web Services.”

Adding Destinations

When you add a destination, you specify the machine and URL where iWay SOAPswitch sends a notification. For inbound transactions, the destination is the PeopleSoft system.

When you create a destination definition, the name you enter in the Name field must be the same as the machine name on which the integration gateway resides. For example:

machine051503

In addition, the URL you enter in the URL field must be the same as the integration gateway URL specified on the Gateways page—with the exception that the URL you enter in the destination definition is appended with the HTTP listening connector. For example, if the URL specified on the Gateways page is:

http://machine051503/PSIGW/PeopleSoftListeningConnector

then the URL that you enter in the destination definition is:

http://machine051303/PSIGW/HTTPListeningConnector

Creating a destination is required for inbound transactions to PeopleSoft.

To create a destination, you use the Destination Definition Wizard.

To access the Destination Definition Wizard:

1. Access the iWay SOAPswitch Administration Console. Select PeopleTools, Integration Broker, Web Services, ERP Connectors.

2. In the left navigation area, click Notifications.

3. In the upper right corner of the page, click the Destinations tab. The Destination Definition Wizard displays.

See Also

iWay SOAPswitch Administration Guide, “Chapter 18: Managing Web Services for Notification,” Create a Destination.

Creating Notifications

When you create a web service you can browse through the classes, methods and other subcomponents of a back-end system, choose a service name, select the methods of the back-end system to expose, choose protocol and security mechanisms, and so on.

Creating a notification is required for inbound transactions to PeopleSoft.

Creating Notifications to PeopleSoft

To create a notification:

1. Access the iWay SOAPswitch Administration Console. Select PeopleTools, Integration Broker, Web Services, ERP Connectors.

2. In the left navigation area, click Notifications.

3. In the upper right corner of the page, verify that the Notifications tab is selected.

See Also

iWay SOAPswitch Administration Guide, “Chapter 18: Managing Web Services for Notification.”

Importing WSDL Into PeopleSoft

You can import WSDL into PeopleSoft that you create with the ERP connectors, as well as WSDL that you create or access using different means. When you import WSDL into PeopleSoft, PeopleSoft Integration Broker adds it to the WSDL repository. This section discusses how to:

• Import WSDL that you generate using iWay SOAPswitch.

• Import WSDL from files and URLs.

Note. On DB2 and DB2/UNIX Unicode and non-Unicode databases, you can import up to 16 kilobytes of WSDL into PeopleSoft. On Sybase databases, you can import up to 21 kilobytes of WSDL into PeopleSoft.

Note. When you import WSDL into PeopleSoft a content type connector property with a value of text/xml is created at the transaction level.

Importing WSDL Generated Using iWay SOAPswitch

When you use the iWay SOAPswitch Web Services Definition Wizard to create a web service or Notification Wizard to create a notification, iWay SOAPswitch automatically generates a WSDL document, opens the PeopleSoft Pure Internet Architecture and displays the WSDL Information page populated with the generated WSDL for you to import.

To import the WSDL into PeopleSoft:

1. In the WSDL Name field, enter a proper name for the WSDL.

2. Click the Import button.

After you click the Import button, the WSDL Repository page displays, where you can inspect service details and create transaction metadata for the WSDL.

See Creating Service Transaction Metadata for Imported WSDL.

Importing WSDL from Files and URLs

To import WSDL from files and URLs, use the Import WSDL page in the Import WSDL component (WSDL_LOAD). To access this page, select PeopleTools, Integration Broker, Web Services, Import WSDL.

To import WSDL from a file or URL:

1. In theWSDL Name field, enter a unique name for the document.

2. Choose the import method.

   1. To import WSDL from a URL, select URL, enter a URL and click the Load from URL button.

      The WSDL Content box displays the WSDL content.

   2. To import WSDL from a file, click File, and click the Load from File button. A new page displays where you can browse and upload a file.

      Click the Browse button and navigate to the WSDL document to import. Click the Open button to load the file name into the Browse box. Click the Upload button. The Import File page appears with the WSDL contents displayed in the WSDL Content box.

3. Click the Import button.

You can now access the WSDL in the WSDL repository using the WSDL Repository page.

See Using the WSDL Repository.

Using the WSDL Repository

WSDL that you import into PeopleSoft is stored in the WSDL repository and accessible through the WSDL Repository page in the WSDL Repository component (WSDL_ANALYZER). To access the page, select PeopleTools, Integration Broker, Web Services, WSDL Repository.

When you select a WSDL document in the repository, use the Services tab to view high-level service information. Click the Service Detail link to view more detailed information about the service and to create transaction metadata using the WSDL Operation Wizard.

Use the WSDL Document tab to view a well-formed version of the WSDL.

See Also

Creating Service Transaction Metadata for Imported WSDL

Creating Service Transaction Metadata for Imported WSDL

PeopleSoft provides a WSDL Operation Wizard that guides you through the process of creating PeopleSoft Integration Broker transaction metadata from WSDL. You access the WSDL Operation Wizard from the WSDL repository.

Use the WSDL Operation Wizard to:

1. Specify the node for the transaction.

2. Specify the request message and, depending on the transaction type, the response message.

3. Select a message channel.

The WSDL Operation Wizard allows you to create new node definitions, message definitions and message channel definitions directly from the wizard.

After you complete the wizard, PeopleSoft Integration Broker, creates the transaction. However, you must create any necessary transformations, create any required relationships and add the appropriate PeopleCode to message definitions to complete the integration.

Common Elements Used to Create Service Transaction Metadata

Accessing the WSDL Operation Wizard

To access the WSDL Operation Wizard:

1. Select PeopleTools, Integration Broker, Web Services, WSDL Repository.

2. Select the WSDL that contains the service for which you want to create PeopleSoft Integration Broker metadata.

   1. Click the Search button to list all WSDL documents in the database.

   2. Click the appropriate WSDL document. The WSDL Repository page displays.

3. In the Service Detail column, click the Service Detail link of the service with which to work. The Service Details page displays.

4. In the Routing Data column, click Create in the row that contains the operation for which you want to create metadata.

   The WSDL Operation Wizard displays.

Specifying Nodes for Services

Use the first page in the WSDL Operation Wizard to specify a node for the service.

The WSDL Operation Wizard enables you to select an existing node definition for the transaction, or create a new node definition.

If you select an existing node definition and the default target connector for the node is defined as something other than the HTTP target connector, the WSDL Operation Wizard will override the connector at the transaction level and use the HTTP target connector. If you create a new node definition, the default target connector is the HTTP target connector.

Using Existing Node Definitions

To use an existing node definition:

1. Select the Use Existing Node Definition option.

2. Click the Lookup button to select the node name.

3. Click the Next button to proceed to the next page in the WSDL Operation Wizard, where, depending on the transaction type, you select request and response messages for the service.

Creating New Node Definitions

To create a new node definition:

1. Select the Create a New Node Definition button.

2. In the Node Name field, enter a name for the new node definition.

3. In the Node Description field, enter a descriptive name for the node.

4. From the Authentication drop-down list, select an authentication method.

   See Creating Node Definitions.

   The valid options are:

   • None. (Default)

   • Certificate

   • Password

5. (Optional.) In the Password field, enter a password.

6. (Optional.) In the Confirm Password field, re-enter the password.

7. Click the Next button to proceed to the next page in the WSDL Operation Wizard, where you select request and response messages for the service.

Selecting Request and Response Messages for Services

Use the second page in the WSDL Operation Wizard to select the request and response messages to use for the node transactions.

If the node transaction is synchronous, you must specify a request and response message. If the transaction is asynchronous, you need only select a request message.

You can select rowset-based or nonrowset-based messages, as long as you have created the appropriate transformations to transform the incoming SOAP messages into the proper format, and to transform the outgoing messages into SOAP format.

Request and response messages must reside in the same message channel.

If you are creating new messages for both the request and response, you will be prompted to create the message channel for the messages on the next page in the wizard or you can use the delivered WEB_SERVICE channel. If you are using one existing message and creating one new message, PeopleSoft Integration Broker automatically assigns the new message to the same message channel as the existing message you chose.

See Selecting Message Channels for Service Messages.

When you have specified the request and response messages for the service, click the Next button to proceed to the next page in the wizard.

Using Existing Messages

To use an existing request or response message:

1. Select the Use Existing Message option in the appropriate section.

   To specify an existing request message, select the option in the Request Message section. To specify an existing response message, select the option in the Response Message section.

2. In the Message Name field, click the Lookup button to select a message that has been defined for the node.

3. In the Message Version field, click the Lookup button to select a message version.

Creating New Messages

To create new request or response message:

1. Select the Create a New Message option in the appropriate section.

   To create a new request message, select the option in the Request Message section. To create a new response message, select the option in the Response Message section.

2. In the Message Name field, enter the name for the new message.

   Newly created messages default to VERSION_1. PeopleSoft Integration Broker populates the Message Version field with this value.

Selecting Message Channels for Service Messages

After you specify request and response messages for a service, you must select the message channel for them.

You can edit this page only if:

• You are working with an asynchronous transaction and you created a new message for the service on the previous page of the wizard, or

• You are working with a synchronous transaction and you created a new request and a new response message for the service on the previous page of the wizard.

In these cases you can choose to assign the message or messages to an existing message channel, or create a new message channel.

In all other situations PeopleSoft Integration Broker automatically populates the message channel name on this page, and the page is read-only with all options disabled. The following bullet points explain how PeopleSoft Integration Broker derives the channel name in these situations.

• When you are working with an asynchronous transaction, and you chose an existing message for the service on the previous page of the wizard, by default PeopleSoft Integration Broker uses the existing message channel for that message.

• When you are working with a synchronous transaction and:

  • You chose an existing request message and an existing response message for the service on the previous page of the wizard. In this case the name of the message channel to which both messages belong displays.

  • You chose one existing message and created one new message on the previous page of the wizard. In this case PeopleSoft Integration Broker automatically assigns the new message to the same message channel as the existing message you chose, and that channel name displays.

Using Existing Message Channels for Service Messages

To use an existing message channel:

1. Select the Use Existing Message Channel option.

2. Click the Lookup button to select a message channel from the database.

3. Click the Next button to proceed to the next page in the WSDL Operation Wizard.

Creating New Message Channels for Service Messages

To create a new message channel:

1. Select the Create a New Message Channel option.

2. Enter a name for the message channel

3. Click the Next button to proceed to the next page in the WSDL Operation Wizard.

Generating Service Transaction Metadata

The last page in the WSDL Operation Wizard enables you to review the values you have specified in the wizard and then generate the service transaction metadata.

To generate the service transaction metadata, click the Finish button.

A message displays indicating that the operation was added to the node, and the Service Details page displays.

Note. When you attempt to exit the WSDL Operation Wizard, a message displays that says there is unsaved data on the page. Disregard this message and click the Continue button to exit.

Viewing Generated Service Transaction Metadata

After you use the WSDL Operation Wizard, you can navigate to the appropriate PeopleSoft Application Designer and the PeopleSoft Pure Internet Architecture page to view any new node, message and message channel object definitions you created.

When you view the node definition, you will notice the following values that PeopleSoft Integration Broker has populated. To access the node definition, select PeopleTools, Integration Broker, Integration Setup, Node Definitions.

• If you created a new node, it displays in the search list.

• Select the new definition and click the Node tab. The description and authentication option you created displays.

• Click the Transaction tab. A transaction exists for the outbound message. Click the Edit link to view the following:

  • The Transaction Detail tab shows that the transaction is active. In addition, the Connector Override option is enabled and the HTTP target connector selected.

  • The Message tab shows the inbound and outbound messages.

  • The Connectors tab shows the SOAPAction property set to the same value shown on the Service Details page for the operation. In addition, the Primary URL property value is the same value as that shown for the endpoint on the Service Details page.

If you created new messages or new message channel, you can access the new definitions in PeopleSoft Application Designer.

If you view these definitions, you will note that they are active.

Completing Integrations

After you have completed using the WSDL Operation Wizard, you must perform the following steps to complete the integration:

1. Create a transformation for the imported message.

2. Create a relationship to consume the service.

3. Add the appropriate subscription OnRequest PeopleCode to the message for inbound integrations or create the client invocation PeopleCode for outbound integrations.

See Also

Configuring Relationships

Applying Transformations

Using Component Interface and Message Web Services

This section provides an overview of using component interface and message web services and discusses how to:

• Use component interface web services.

• Use message-based web services.

Understanding Using Component Interface and Message Web Services

PeopleSoft Integration Broker enables component interfaces and messages to be offered to third parties as web services. This functionality is independant from the iWay SoapSwitch and the WSDL respository.

You can generate WSDL documents dynamically for component interfaces and for incoming message transactions. You can then provide these WSDL documents to external parties, who can use the service description information contained within to invoke the particular component interface or message processing logic. In both of these cases, the PeopleSoft system is the service provider and the external party is the service consumer.

Component Interface Web Services

Component interface web services leverage the existing functionality for SOAPTOCI, making offering component interfaces as web services accessible.

Message-Based Web Services

Synchronous and asynchronous messages can be exposed via web services, regardless if they are rowset-based or nonrowset-based.

This functionality uses the basic PeopleSoft Integration Broker infrastructure with one exception: at runtime SOAP request messages are sent to a specific listening connector on the gateway.

External parties send web service requests to the PeopleSoftServiceListeningConnector, which is responsible for stripping the SOAP envelope and forwarding the request to the application server for processing. The application server receives the request as it would any other message, and invokes the appropriate message processing.

WS-I Compliance

The Web Services Interoperability (WS-I) Basic Profile 1.0 is the emerging specification for web service interoperability that identifies how web services specifications should be used to create interoperable web services. The specificiation outlines how protocols involved in web services—such as HTTP, Simple Object Access Protocol (SOAP), Web Services Definition Language (WSDL), and so on—are to be used.

WSDL generated from PeopleSoft messages and component interfaces is WS-I compliant. Moreover, SOAP messages exchanged at runtime are WS-I compliant.

Using Component Interface Web Services

This section provides prerequisites for using component interface web services and discusses how to generate WSDL for component interfaces.

Prerequisites

Before you generate WSDL from a component interface, verify that the SOAPTOCI message is active and that it has a transaction with the appropriate node. Also verify that you have added security to the SOAPTOCI Web Library.

Generating WSDL for Component Interfaces

PeopleSoft Integration Broker enables you to generate WSDL documents from PeopleSoft component interface and message object definitions. To generate WSDL for these PeopleSoft object definitions, use the Published EIPs page in the Published EIPs component (WSDL_APPMSG). To access this page, select PeopleTools, Integration Broker, Web Services, Published EIPs.

To generate WSDL from a component interface:

1. Select PeopleTools, Integration Broker, Web Services, Published EIPs.

2. Select the Component Interface option.

3. In the Web Service field, use the Lookup button and select a component interface.

4. In the Node Name field, use the Lookup button to select the external node that will be making the web service request.

   An inbound synchronous transaction for the SOAPTOCI message must be defined against this node for it to appear in the search results.

5. If a description exists for the component interface object you selected, it displays in the Description field.

6. Click the Search button. A Web Services to CI section displays at the bottom of the page and lists items that match your search.

7. Click the WSDL link in the desired row.

8. A new web browser window opens and displays the component interface as a WSDL document.

Using Message-Based Web Services

This section provides an overview and prerequisites of using message-based web services, and discusses how to generate WSDL for PeopleSoft messages.

Prerequisites

The prerequisites for using message-based web services is essentially the same as that for normal messaging. You must define messages and create node transactions. You must also write the appropriate OnRequest or message Subscription PeopleCode to process the message and execute the service.

Note. For synchronous responses, the PeopleCode you develop must wrapper the response in a SOAP envelope. The PeopleSoftServiceListeningConnector does not add one.

Understanding Generating WSDL for Nonrowset-based Messages

By definition, non-rowset based messages do not have an explicit record structure associated with them. However, it is possible to associate a schema with an unstructured message. If an unstructured message does not have an associated schema, the schema section of the WSDL document will be incomplete. You must modify this section so that the WSDL document completely describes the message. If a schema has been associated, that schema will appear in the WSDL.

Generating WSDL for PeopleSoft Messages

To generate WSDL for a message:

1. Access the Published EIPs page.

2. Select the Message option.

3. In the Node Name field, click the Lookup button to select a node name.

4. In the Message Name field, click the Lookup button to select a message name.

5. Click the Search button.

   An EIPs as WSDL section displays at the bottom of the page and lists items that match your search.

6. Click the WSDL link in the desired row.

7. A new web browser window opens and displays the node transaction as a WSDL document.

Warning! The search results will include rows for both incoming and outgoing transactions. If you wish to pass the WSDL document to an external party so that they can invoke the message as a service, be certain to only select incoming transactions. Outbound transactions are only listed as a convenience for those who might wish to pass the WSDL doc to a service provider. That provider could then use the WSDL as a starting point for building a new service offering.