Creating Component Interface-Based Services

This chapter discusses how to:

• Select component interfaces to expose as services.

• Select component interface methods to include in service operations.

• Generate component interface-based services and service operations.

• View component interface-based service definitions.

Understanding Creating Component Interface-Based Services

PeopleSoft Integration Broker enables you to take an existing component interface and create a service that can be used to invoke the component interface. Further, it creates service operations, including request messages and response messages (if appropriate). The system creates an inbound any-to-local routing for the service operation version, as well as handlers for each method you choose to include in the service.

All service operations you generate from component interfaces are synchronous service operations.

Naming Conventions Integration Metadata Created

This section highlight the naming conventions that the PeopleSoft system uses when it creates services and services-related data based on component interfaces.

When it creates a web service from a component interface, the PeopleSoft system adds a CI_ prefix to the component interface name. So if the component interface name is MYCI, the service name the system creates is CI_MYCI

The following table highlights naming conventions the PeopleSoft systems applies to other services data based on the method with which you are working:

The naming convention used for message names, Mxxxxxx, is the letter M followed by a random six-digit number, as denoted by the x's. An example of a message name is M548902.

Note. The maximum number of characters for a service operation name is 30. If using a user-defined method name yields a greater result, the name is used is <service_name>_Mxxx, where xxx is a three-digit random number. An example of such a name is CI_USERCI_M101023.

User-Defined Method Restrictions

This section discusses restrictions related to using user-defined methods when exposing component interfaces as services.

User-Defined Method Actions

User-defined methods which are executed with the Create action should not be exposed as web services.

Specifying Method Parameters and Parameter Names

All user defined methods that will be accessed via the service interface must have a doc string.

The doc string contains:

1. The keyword GET. .

2. An ordered list of parameter names corresponding to the method's parameters.

The following example shows the format of the doc string:

Function simpleFunction(&sParm As string, &dParm As date, 
                        &nParm As number, &bParm As boolean) 
                        Returns string
   Doc "GET, StringParm, DateParm, NumParm , BoolParm"
   
   Local string &aString = &sParm;
   &aString = &aString | " -- " | &dParm;
   &aString = &aString | " -- " | &nParm;
   &aString = &aString | " -- " | &bParm;
   Return &aString;
   
End-Function;

The contents of the doc string are used when the function is invoked. For example, if GET is specified, then the GET keys are set, and GET is called on the component interface before the used-defined method is invoked.

The list of parameters are used at runtime to match the data in the input message with the method's parameters. This is an ordered list; if the parameter list in the doc string and the method parameters don't match, then the method may not work correctly. The names in the doc parameter list will be the names visible in any WSDL created for the service.

Method parameters and return values must be of a primitive type, such as a string, date or number. Object parameters or return values are not supported.

Impact of Changing Component Interfaces

If a user modifies or deletes a component interface in PeopleSoft Application Designer, when the user saves the changes, PeopleSoft Integration Broker checks if a service exists for the component interface. If a service exists, and the component structure/properties have changed in the component interface, a warning message appears stating that a service exists for the component interface.

If the component interface structure changes, a status of Does not match appears in the CI-Based Services Review Status grid, and the operation appears as active in the Service Operations component.

Prerequisites

Prior to creating any component interface-based web services and service operations, you must define the schema namespace, service namespace, and target location in the Service Configuration page

See Configuring PeopleSoft Integration Broker for Handling Services.

Selecting Component Interfaces to Expose as Services

This section discusses how to select component interfaces to expose as web services.

The first step to creating component interface-based services is to choose the component interface on which to base a service. To do so, use the CI-Based Services component (IB_CISERVICES) and the Select Component Interface page (IB_CISERVICES). The following graphic shows this page:

When you search for component interfaces to select, the system returns results only for those component interfaces to which you have permissions.

To select a component interface:

1. Access the Select Component Interfaces page (PeopleTools, Integration Broker, Web Services, CI-Based Services).

2. Search for a component interface:

   Note. You can search only for those component interfaces to which you have permissions.

   • Click the Search button to search from all component interfaces in the database, or

   • Select one or more of the following criteria to narrow your search and then click the Search button.

     Component Interface Name	Enter part or all of the name of the component interface to use, or click the Lookup button to search for one.
     Component Name	Enter part or all of the component name to which a component interface belongs.
     Owner ID	Owner ID drop-down list box, select the person or group that owns the component interface.

   The Select CIs grid displays are component interfaces that match your search.

3. Check the Select box next to one or more component interfaces.

4. Click the Review CI Status button.

The Review CI Status page appears where you can review details about the select component interface and select the methods to include as operations in the service.

Selecting Component Interface Methods to Include as Service Operations

This section discusses selecting methods to include web services as service operations.

The following example shows the Review Status page:

The Review Status page shows the following information about the component interface you select to expose as a service:

Generating Component Interface-Based Services

This section discusses how to:

• Generate services and service operations from component interface methods.

• Add message names and descriptions to generated service operations.

Generating Services and Service Operations from Component Interface Methods

The following example shows the Confirm Actions page (IB_CISERVICES_SEC):

You can work with the following page elements:

Adding Message Names and Descriptions to Generated Service Operations

The Confirm Actions page features a Message Names and Descriptions link for each service operation. Click the link to open the Message Names and Descriptions page (IBCISERVICES2_SEC). On the page you can enter names for each message in the service operations. You can also enter a description for each message name. The message names and description will appear in the generated XML message schema for the service operation.

The following example shows the Message Names and Descriptions page:

In the message name fields, enter a message name. You do not need to append the message name with a version number. The system automatically creates versions the message as version one, and appends the message name with .V1.

When you have completed entering message names and descriptions, click the OK button to return to the Confirm Actions page.

Viewing Component Interface-Based Service Definitions

After you generate services and service operations, the Review Status page (IB_SERVICES2) appears as shown in the following example:

Use this page to review the actions performed. For example, the previous graphic shows the names of the two service operations created as well as the service operation status of Operation created.

From this page you can continue to create additional service operations using the remaining available methods for the component interface.

Or, you can click the Return to Select CI link to return to the Select Component Interface page to select new component interfaces for which to generate services and service operations.

You can also click the View Service Definition link to view the service definition for the service created.

When you click the View Service Definition link the service you created, CI_CURRENCY_CD_CI appears in the Services page as shown in the following graphic:

From this page you can perform actions as you would on any other service, including:

• Click the Provide Web Service link to generate WSDL for the service.

• Use the Service Operations box to add additional service operations to the service.

• Click either of the operations that display in the Existing Operations box to generate routing definitions, view the response, request or fault messages, view handler details, and more.

• And so on.

See Also

Managing Services

Managing Service Operations