Managing Services

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

• Access and view service definitions.

• Add service definitions.

• Add service operations to service definitions.

• Create and manage integration groups.

• Restrict write access to service definitions.

• Rename and delete service definitions.

• Activate and deactivate services in bulk.

Note. Before you can provide or consume services in a PeopleSoft system, you must configure the system for handling services.

See Also

Configuring PeopleSoft Integration Broker for Handling 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

Accessing and Viewing Service Definitions

This section discusses how to.

• Access service definitions.

• View WSDL documents generated for services.

• View service operation information.

• View messages defined for services.

Accessing Service Definitions

Service definitions appear on the Services page (IB_SERVICEDEFN) in the Service component (IB_SERVICEDEFN).

To access the Services page, select PeopleTools, Integration Broker, Integration Setup, Services. 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 the WSDL Repository page (IB_SERVICEDEFN_SEC). This page 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.

The following example shows the WSDL Repository page for the SOAP-based service IB_EXAMPLES.

Click the View WSDL link on the WSDL Repository page to view the WSDL document in the WSDL Viewer page (IB_SERVICEWSDL_SEC). The following example shows the WSDL document for the IB_EXAMPLES page in the WSDL Viewer page:

To view a WSDL document generated for a service:

1. Access the service definition. (PeopleTools, Integration Broker, Integration Setup, Services.)

2. Click the View WSDL link.

   The WSDL Repository page appears.

3. Click the View WSDL link.

   The document appears in the WSDL Viewer page.

4. Click the Return button to return to the WSDL Repository page.

5. Click the Return button again 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 IB_EXAMPLES 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 discusses how to add service definitions to the PeopleSoft system.

Understanding Naming Services and Service Aliases

Service names and service alias names can be exposed as web services. As a result, the following restrictions apply when you name a service or a service alias. Service names and service alias names:

• Cannot begin with XML, xml, or Xml.

• Cannot begin with a digit.

• Cannot begin with a character.

Adding Service Definitions

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

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

See Understanding Configuring PeopleSoft Integration Broker for Handling Services.

After you add a service definition to the system, the Services page (IB_SERVICEDEFN) appears where provide additional service definition information. The following example shows the Services page for a non-REST service called DEMO_SOAP_SERVICE:

To add a service definition:

1. Access the Services page (PeopleTools, Integration Broker, Integration Setup, Services).

2. Click the Add a New Value link.

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

   Restrictions for naming services are discussed elsewhere in this section.

   See Understanding Naming Services and Service Aliases.

4. Click the Add button.

   The Services page appears.

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

6. (Optional.) If the service is REST-based, check the Is Provider box to define the service as a provider service.

   By default, when you add a REST-based service to the system it is a provider service.

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

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

   Restrictions for naming service aliases are discussed elsewhere in this section.

   See Understanding Naming Services and Service Aliases.

9. (Optional.) From the Object Owner ID drop-down list box, select the owner of the service.

10. In the Namespace field, 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.

11. Click the Save button.

See Also

Adding Service Operations to Service Definitions

Adding Service Operations to Service Definitions

This section discusses how to:

• Add existing service operations to service definitions.

• Define new service operations for SOAP-based service definitions.

• Define new service operations for REST-based service definitions.

Understanding Adding Service Operations to Service Definitions

You can add a service operation that already exists in the database to a service definition, or you can add and configure a new service operation and then add it to a service.

Adding Existing Service Operations to Service Definitions

To add an existing service operation to a service:

1. Access the Add Existing Operations page (PeopleTools, Integration Broker, Integration Setup, Services. Click the Link Existing Operations link).

   The Add Existing Operations page appears.

2. Select a service operation to add to the service.

   1. In the Service Operation field, enter the name of the service operation to add to the service and click the Search button. The service operation appears in the Available Service Operations grid.

      Check the box next to the service operation name.

   2. In the Service Operation field, click the Lookup button. The Look Up Service Operation page appears.

      Select a service operation from the list to add to the service.

   3. Click the Search button to show a list of service operations in the database.

      Select one or more service operations to add to the service.

3. On the Add Existing Operations page, click the Save button.

   The Services page appears and the service operations that you added appear in the Existing Operations grid.

4. On the Services page, click the Save button.

Defining New Service Operations for SOAP-Based Service Definitions

This section describes how to define new service operations for SOAP-based services.

To add and configure a new service operation for a SOAP-based service:

1. Access the Services page (PeopleTools, Integration Broker, Integration Setup, Services).

   The Services page appears.

2. In the Service Operations section, locate the Service Operation field and enter a name for the new service operation.

3. From the Operation Type drop-down list, select the type of service operation you are adding.

   The valid values are:

   • Asynch Request/Response.

   • Asynch to Synch.

   • Asynch–One Way.

   • Synchronous.

   Service operation types are discussed elsewhere in this PeopleBook.

   See Services Operation Types.

4. Click the Add button.

   The Service Operations-Definitions page appears. Use the page to configure the service operation.

   See Configuring Service Operation Definitions.

Creating and Managing Integration Groups

This section provides and overview of integration groups and discusses how to:

• Add integration groups.

• Add integration subgroups.

• Add services to integration groups and subgroups.

• Rename and delete integration groups.

• Copy integration groups using Project Copy.

Understanding Integration Groups

PeopleSoft provides you with the ability to great groups and subgroups of integrations that you can then deploy using the Integration Network. Your PeopleSoft integration partners can then use the Integration Network to introspect and activate those integrations on their systems.

You can assign services to one or more integration groups or subgroups. However, there can only be one instance of a service within a group or subgroup assignment.

Adding Integration Groups

To add an integration group to the system, use the Integration Group search page shown in the following example:

After you name the integration group, the Integration Group Definitions page (IB_INTGROUPDEFN) appears where you can add an optional description for the group and save the definition. The following example shows the Integration Group Definitions page:

To add a service integration group:

1. Select PeopleTools, Integration Broker, Integration Setup, Integration Groups.

   The Integration Group search page appears.

2. Click the Add a New Value tab.

3. In the Integration Group Name field, enter a name for the integration group.

4. Click the Add button.

   The Integration Group Definitions page appears.

5. In the Description field, add a description for the group.

6. (Optional.) From the Object Owner ID field, select the owner of the object.

7. Click the Save button.

After you have added the definition to the system you can proceed to add services to the integration group, as well as create integration subgroups and add services to them.

The process for adding services to integration groups and to integration subgroups is identical and is described elsewhere in this section.

See Adding Services to Integration Groups.

Adding Services to Integration Groups

Use the Integration Group Definitions page shown in the previous section to add services to integration groups.

Note. The information presented in this section for searching for services to add to an integration group also applies to searching for services to add to integration subgroups.

You can search for the services to add to a group (or subgroup) by using the Add Services link on the Integration Group Definitions page. The following example shows the search page (IB_INTGROUP_SEC) that appears when you click the Add Services link:

You can search for a service by entering a partial or complete service name in the Service Name field and then clicking the Search button. You can also leave the Search Name field blank and click the Search button to display a list of all services in the database. The following example shows the results of searching for a service by entering a partial name.

After you locate the service or services to add to the group, check the Select box next to each service name to add to the group and click the OK button.

To add services to an integration group:

1. Access the Integration Group Definitions page. (Select PeopleTools, Integration Broker, Integration Setup, Integration Groups.)

2. Click the Add Services link.

   The services search page appears.

3. Search for one or more services to add to the integration group, as described previously in this section.

4. Click the OK button to return to the Integration Group Definitions page.

5. Click the Save button.

Adding Integration Subgroups

The Integration Group Definitions page features a Subgroups section where you define subgroups for an integration group and then add services to the subgroups.

The following example shows the Subgroups section of the Integration Group Definitions page:

To add a service integration subgroup:

1. Access the Integration Group Definitions page. (Select PeopleTools, Integration Broker, Integration Setup, Integration Groups.)

2. Locate the Subgroup section of the page.

3. In the Integration Subgroup Name field, enter a name for the subgroup.

4. In the Description field, enter a description for the subgroup.

5. Click the Add Services link to add services to the subgroup.

   The process for adding services to integration groups and to integration subgroups is identical and is described elsewhere in this section.

   See Adding Services to Integration Groups.

6. Click the Save button.

To add additional subgroups to the integration group, in the Subgroups section of the page, click the plus (+) button to add another subgroups grid to the page and repeat the steps described in this section to define the subgroup and add services to it.

Deleting Services from Integration Groups and Integration Subgroups

To delete a service from an integration group or an integration subgroup:

1. Access the Integration Group Definition page. (PeopleTools, Integration Broker, Integration Setup, Integration Group.)

2. In the Services or Subgroup Services section of the page, click the minus (-) button next to the name of the service to delete.

3. Click the Save button.

Renaming and Deleting Integration Groups

This section discusses how to:

• Rename integration groups.

• Delete integration groups.

Understanding Renaming and Deleting Integration Groups

You can rename and delete integration groups using the Integration Groups tab (IB_INTGROUPADM) in the Service Administration component (IB_HOME_PAGE).

The Integration Group tab contains two sections: a Delete section that enables you to delete integration groups and a Rename section that enables you to rename integration groups. When you first access the Integration Groups tab, both sections are collapsed. Click the section header arrow buttons to expand and collapse each section.

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

The service system status has no impact on renaming or deleting integration groups.

Renaming Integration Groups

To rename and integration group:

1. Access the Service Administration – Integration Groups page. (Select PeopleTools, Integration Broker, Service Utilities, Service Administration. Click the Integration Groups tab.)

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

3. In the Integration Group Name field, enter the service to rename, or click the Lookup button to search for and select the group to rename.

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

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 Integration Groups

To delete and integration group:

1. Access the Service Administration – Integration Groups page. (Select PeopleTools, Integration Broker, Service Utilities, Service Administration. Click the Integration Groups tab.)

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

3. In the Integration Group Name field, enter the integration group to delete, and click the Search button. Search results display in the results grid.

4. In the results grid, check the box next to the integration group or groups to delete.

5. Click the Delete button.

Copying Integration Groups Using Project Copy

You can copy integration groups between PeopleSoft databases using Project Copy.

When using Project Copy to copy integration groups select the Integration Groups as one of the definition types. To copy all of the service information, such as service, service operation, handler, and so on, select all of the definitions in the Related Definitions box.

Note. At a minimum you must select Services in the Related Definitions box.

Restricting and Enabling Write Access to Service Definitions

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

• Restrict write access to services.

• Enable write access to services.

Note. The information in this section applies to REST and non-REST service definitions.

Understanding Restricting Write Access to Service Definitions

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.

Restricting Write Access to Service Definitions

Use the Restricted Service page (IB_SVCSETUP3) in the Service Configuration component (IB_SVCSETUP) to restrict a service.

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 Service Definitions

This section describes how to enable write access to services that you previous restricted.

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 Service Definitions

This section discusses renaming and deleting service definitions.

Note. The information in this section applies to REST and non-REST service definitions.

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.

Renaming Service Definitions

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

See Using the Service Configuration Page to Set 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 Service Definitions

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.

Activating and Deactivating Service Definitions in Bulk

This section describes activating and deactivating service definitions in bulk.

Note. The information in this section applies to REST and non-REST service definitions.

The Service Activate/Deactivate page (IB_HOME_PAGE9) in the Service Administration component enables you to activate and deactivate services in bulk.

This page enables you to quickly activate or deactivate services. If any problems occur during activation, the system displays a message indicating a problem activating a certain object, for example routing, handler, and so on. If such a message occurs, you must look on the corresponding object definition to determine the problem. This page is not intended to be used to debug activation problems or problems with integration metadata definitions.

The following example shows the Service Activate/Deactivate page:

When you activate one or more services, all of the default service operation associated with the services become active. In addition, the handlers, routings and queues associated with the service operations become active as well.

When you deactivate one or more services, all selected services become deactivated. The default service operations for the services become deactivated as well. In addition, the handlers, routings and queues associated with the service operations become deactivated.

To activate or deactivate services in bulk:

1. Access the Service Activate/Deactivate page (PeopleTools, Integration Broker, Service Utilities, Service Administration).

2. In the Service field, enter part or all of the service name you want to activate or deactivate.

3. Click the Search button.

4. Check the Select box next to each service to activate or deactivate.

5. Click the Activate button to activate the selected services; click the Deactivate button to deactivate the selected services.

   When the system has performed the selected action, the Results column displays Success for each service you activated or deactivated.