Managing Services

This chapter provides an overview of managing services and discusses how to:

• Configure PeopleSoft Integration Broker for handling services.

• Specify UDDI repositories in the PeopleSoft system.

• Access and view service definitions.

• Add service definitions.

• Configure service definitions.

• Restrict write access to services.

• Rename and delete services.

Understanding Managing Services

Services are used to logically group a set of service operations.

For example, if you have a number of service operations that are related to customers, such as those pertaining to customer information, adding customers, updating customers, deleting customers, and so on, you can create a customer web service and then associate the related service operations with that service.

Warning! PeopleSoft delivers two services with PeopleSoft Integration Broker: IB_GENERIC and IB_UTILITY. These services are used internally by the system. Do not delete or modify these services.

Common Elements Used in This Chapter

Configuring PeopleSoft Integration Broker for Handling Services

Before you can work with services in PeopleSoft Integration Broker, you must set several configuration properties.

This section provides an overview of configuring PeopleSoft Integration Broker for handling services and discusses how to set service configuration properties.

Understanding Configuring PeopleSoft Integration Broker for Handling Services

This section provides an overview of several of the service configuration properties that you must set to use services with PeopleSoft Integration Broker.

Namespaces

Namespaces provide a method for qualifying element and attribute names that are used in XML documents and are identified by Uniform Resource Identifier (URI) references.

To use services with PeopleSoft Integration Broker, you must specify a service namespace and a schema namespace.

Service System Status

The Services Configuration page contains a Service System Status dropdown list box that enables you to restrict rename, delete, and other administrative actions that users can perform on services, service operations, messages, and other integration metadata.

You can select one of two values from the dropdown list box: Production or Development.

The following table describes the impact of the setting on managing integration metadata:

Page Used to Configuring PeopleSoft Integration Broker for Handling Services

Setting Service Configuration Properties

You set service configuration properties on the Service Configuration page in the Services Configuration component (IB_SVCSETUP). To access this page, select PeopleTools, Integration Broker, Services Configuration. The following example shows the Service Configuration page:

To set service configuration properties:

1. Access the Service Configuration Properties page.

2. In the Service Namespace field, declare a service namespace.

3. In the Schema Namespace field, declare a schema namespace.

4. In the Target Location field, enter a URL to be used for service requests.

   If you have a dedicated integration gateway, the format of the value that you enter is http://<machine>:<port>/PSIGW/PeopleSoftServiceListeningConnector.

   If the default local node points to a different gateway server where WSDL documents and XSD schemas are available, use the alternate target location URL format of http://<machine>/PSIGW/PeopleSoftServiceListeningConnector/<defaultnode>.

5. From the Service System Status dropdown list box, select one of the following options:

   • Development. (Default.)

   • Production.

   See Understanding Configuring PeopleSoft Integration Broker for Handling Services.

6. Click the Save button.

Specifying UDDI Repositories in the PeopleSoft System

This section discusses how to specifying UDDI repositories in the PeopleSoft system for providing and consuming services.

Understanding Specifying UDDI Repositories in the PeopleSoft System

You can provide services to and consume services from one or more UDDI repositories. Before doing so, you must configure each repository in the PeopleSoft system.

Page Used to Specify UDDI Repositories in the PeopleSoft System

Specifying UDDI Repositories in the PeopleSoft System

Use the Service Configuration-UDDI Configuration page to specify UDDI repositories in the PeopleSoft system for providing services to and consuming services from UDDI repositories.

To access this page, select PeopleTools, Integration Broker, Integration Setup, Service Configuration and click the UDDI Configuration tab. The following graphic shows the UDDI Configuration page:

To specify a UDDI repository in the PeopleSoft system:

1. Access the UDDI Configuration page.

2. In the UDDI Name field, enter the name of the UDDI server.

3. In the Description field, enter a descriptive information for the UDDI server.

4. Specify the URL used when consuming services from UDDI repositories.

   1. In the Inquiry URL field, enter the URL to use to inquire for services available on the UDDI server. This is the URL used when consuming services from UDDI repositories. It is also used when publishing to UDDI repositories to inquire the server for possible existing WSDL document versions.

   2. Click the Ping button next to the Inquiry URL field to verify that you entered the correct URL.

5. Specify the Publish URL.

   1. In the Publish URL field, enter the URL for publishing WSDL documents to the UDDI server. This URL is used when providing services to UDDI repositories.

   2. Click the Ping button next to the Publish URL field to verify that you entered the correct URL.

To specify additional UDDI repositories to use for providing or consuming services, click the plus (+) button at the top right corner of the UDDI Server section to add a row.

See Also

Consuming Services

Providing Services

Accessing and Viewing Service Definitions

This section discusses how to.

• Access service definitions.

• View WSDL documents generated for services.

• View service operation information services.

• View messages defined for services.

Pages Used to Access and View Service Definitions

Accessing Service Definitions

The following example shows the Services page:

The top of the Service page displays general information about the service, including the name of the service, its description, its alias name, and so on.

Viewing WSDL Documents Generated for Services

Click the View WSDL link to display a page that provides a summary of all the WSDL documents that are generated for the service, as well as the service operations, request messages, response messages, and fault messages that are contained in each.

Note. Service operations must exist for a service to view WSDL documents for the service.

Click the View WSDL link to view the contents of the document.

Click the Return button to return to the Services page.

Viewing Service Operation Information

The Existing Service Operations section of the Services page contains an Operation tab that displays service operations and service operation versions that are associated with the service. It also displays descriptions of the service operations, the type of operation, and whether the service operation is active.

When you click the name of a service operation, the operation opens on the Service Operations page, where you can view and modify service operations information, work with the service operation handlers, routing definitions, and do much more.

See Also

Managing Service Operations

Viewing Messages Defined for Service Operations

The Existing Service Operations section of the Services page contains a Messages Links tab that displays the request and response messages defined for each service operation.

The following example shows the Message Links tab displaying request and response messages for the service operation that is associated with the QE_FLIGHTPLAN_SYNC service:

Click the request or response message name to open the message in the Message Definitions page, where you can view and modify message definition information, message schema information, and more.

See Also

Managing Messages

Adding Service Definitions

This section discuses how to add a service definition to the system

Page Used to Add Service Definitions

Adding Services

To add a service definition to the system, use the Add a New Value tab on the Services search page. To access this page, select PeopleTools, Integration Broker, Integration Setup, Services. Then select the Add a New Value tab.

Note. Before you can add a service, you must configure PeopleSoft Integration Broker to handle services using the Service Configuration page.

To add a service definition:

1. Access the Services page and select the Add a New Value tab.

2. In the Service field, enter a name for the service.

3. Click the Add button.

The Services page appears, and you can now define the service.

See Also

Configuring Service Definitions

Setting Service Configuration Properties

Configuring Service Definitions

This section discusses how to configure service definitions.

Page Used to Configure Service Definitions

Configuring a Service Definition

After you add a service definition to the system, the Services page appears and you can configure the service definition.

To configure a service, use the Services page in the Services component (IB_SERVICEDEFN) in the PeopleSoft Pure Internet Architecture. The following example shows the Services page:

To configure a service definition:

1. If it is not already open, access the Services page.

2. In the Description field, enter a description for the service.

3. (Optional.) In the Comments field, enter comments about the service or the service.

4. (Optional.) In the Service Alias field, enter an alias name for the service.

5. (Optional.) From the Object Owner ID dropdown list box, select the owner of the service.

6. Enter a namespace URI for the service.

   The default value is the namespace that is declared in the Service Namespace field on the Service Configuration page.

7. Click the Save button.

You can add service operations to the service definition now or at a later time.

See Also

Setting Service Configuration Properties

Restricting and Enabling Write Access to Services

This section provides an overview of restricting access to services and discusses how to:

• Restrict write access to services.

• Enable write access to services.

Understanding Restricting Write Access to Services

When you restrict write access to a service, sensitive fields of the service definition and of associated service operations appear in read-only mode. The following table lists the components and pages that contain fields and data that are related to services and describes the impact that restricting access to services has to each of them.

You cannot delete or rename a restricted service. In addition, you cannot change, rename or delete any service operation that is defined as part of a restricted service.

Page Used to Restrict and Enable Write Access to Services

Restricting Write Access to Services

The following example shows the Restricted Services page.

To restrict write access to services:

1. Select PeopleTools, Integration Broker, Service Configuration. Click the Restricted Services tab. The Restricted Services page appears.

2. In the Service field, enter a service name and click the Search button, or click the Lookup button to search for a service.

   The service name or search results display in the Services list.

3. Check the Restricted Service check box next to the service name to which you want to restrict access.

4. Click the Save button.

Enabling Write Access to Services

To enable write access to services that you previously restricted:

1. Select PeopleTools, Integration Broker, Service Configuration. Click the Restricted Services tab.

   The Restricted Services page appears.

2. Select the service to write-enable using one of the following methods:

   • In the Service field, enter a service name and click the Search button.

   • Click the Lookup button to search for a service.

   • Check the Restricted Services check box, and click the Search button to display and select from all currently restricted services in the system.

   The service name or search results appear in the Services list.

3. Clear the check box next to the service name to write access enable.

4. Click the Save button.

Renaming and Deleting Services

You can rename and delete services using the Services tab in the Service Administration component (IB_HOME_PAGE). The Services tab contains two sections: a Delete section that enables you to delete services and a Rename section that enables you to rename services.

When you first access the Services tab, both sections are collapsed. Click the section header arrow buttons to expand and collapse each section.

The following example shows the Services tab with both Delete and Rename sections expanded.

Page Used to Rename and Delete Services

Renaming Services

The service system status that you set on the Services Configuration page affects the ability to rename services.

See Understanding Configuring PeopleSoft Integration Broker for Handling Services, Setting Service Configuration Properties.

To rename a service:

1. Select PeopleTools, Integration Broker, Service Utilities. Click the Service tab.

   The Service page displays.

2. Click the arrow next to the Rename section header to expand the section.

3. In the Service field, enter the service to rename, or click the Lookup button to search for and select the service to rename.

4. In the New Name field, enter the new name for the service.

5. Click the Rename button.

After you click the Rename button, the Results field displays a message that the action was successful or displays a warning or error message with a description of the problem.

Deleting Services

You can delete services only when the service has no service operations associated with it. When you search for a service to delete, only such services that have no service operations associated with them are retrieved from the system.

To delete a service:

1. Select PeopleTools, Integration Broker, Service Utilities. Click the Service tab.

   The Service tab displays.

2. Click the arrow next to the Delete section header to expand the section.

3. In the Service field, enter the service name to delete, and click the Search button.

   Search results display in the results grid.

4. In the results grid, check the check box next to the service or services to delete.

5. Click the Delete button.