PeopleTools 8.52: PeopleSoft Integration Broker Administration

Configuring PeopleSoft Integration Broker for Handling Services

This section discusses how to:

Use the Service Configuration Page to set service configuration properties
Using the Target Locations Page to set target locations for services.
Setting service and schema namespaces.
Setting service system status.
Setting the system for multi-queue processing.
Enabling WSDL alias generation checking.
Setting target locations for services.
Setting target locations for REST services.

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.

Target Locations

When configuring the PeopleSoft system for services, you set target locations for web services and for REST services, using the Target Locations page.

For web services, target locations are URLs that PeopleSoft Integration Broker uses to build and validate XML message schemas, export WSDL documents, and as the SOAP endpoint. For REST services, target locations are URLS that PeopleSoft Integration Broker uses to export WADL documents and as the REST endpoint.

PeopleSoft Integration Broker enables you to define an unsecured target location and a secured target location URL for each type of service, and provides separate fields for doing so.

In general, the URL you specify as a target location should be an unsecured URL.

Note. XML schema validation will fail if you enter a secured URL in the Target Location field.

If you need to use a secure URL for a SOAP or REST endpoint, you may do. Any secure URL you enter overrides any unsecured URL entered.

In addition, you can override the (unsecured) target location URL for exporting WSDL and WADL documents on a case–by–case basis. The Provide Web Service wizard features a Use Secure Target Location box in Step 2 – Select Service Operations of the Wizard. If you select the box, the system exports the WSDL or WADL document to the URL specified in the secure target location defined on the Target Locations page. The override is in effect only for that particular export of WSDL or WADL. If you need to generate WSDL or WADL again for the service, the system defaults back to using the (unsecured) target location URL, unless you again check the Use Secure Target Location box in the wizard to override the URL to use the secure target location.

To use services with PeopleSoft Integration Broker, you must specify a target location. Specifying a secure target location is optional.

Service System Status

The Services Configuration page contains a Service System Status drop-down 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 drop-down list box: Production or Development.

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

Object	Action	Production Mode	Development Mode
Messages	Rename	You cannot rename a message that is associated to a service that has WSDL or WADL provided. You must first delete the WSDL or WADL documents before you can rename the message.	An alert message displays indicating that WSDL or WADL documents have been provided for the service to which the message is associated, but you may continue with the action and rename the message.
Messages	Delete	You cannot delete a message that is associated to a service that has WSDL or WADL provided. You must first delete the WSDL or WADL documents before you can delete the message.	An alert message displays indicating that WSDL or WADL documents have been provided for the service to which the message is associated, but you may continue with the action and delete the message.
Message Schemas	Delete	You cannot delete a message schema that is associated to a service that has WSDL or WADL provided. You must first delete any WSDL or WADL documents before you can rename the schema.	An alert message displays indicating that WSDL or WADL documents have been provided for the service to which the message schema is associated, but you may continue with the action and rename the schema
Queues	Rename	The Service System Status has no impact on renaming queue definitions. However, you cannot rename a queue if it is referenced in a service operation or if it is referenced in the runtime tables.	The information that applies to renaming queues in production mode also applies to renaming queues in development mode.
Queues	Delete	The Service System Status has no impact on deleting queue definitions. However, you cannot delete a queue if it is referenced in a service operations or if it is referenced in a runtime table.	The information that applies to deleting queues in production mode also applies to deleting queues in development mode.
Routings	Rename	The Service System Status has no impact on renaming routing definitions.	The information that applies to renaming routing definitions in production mode also applies to renaming routings in development mode.
Routings	Delete	You cannot delete an any-to-local routing definition that is tied to a service that has WSDL or WADL provided. You must first delete the WSDL or WADL document from the service before deleting the routing definition.	An alert message displays indicating that WSDL or WADL documents have been provided for the service to which the routing is associated, but you may continue with the action and delete the routing definition.
Service	Rename	You cannot rename services that have had WSDL or WADL documents provided. The WSDL or WADL documents must be deleted before you can rename a service.	An alert message displays indicating that WSDL or WADL documents have been provided for the service, but you can continue with the action and rename the service.
Service	Delete	The Service System Status has no impact on deleting services. However, you cannot delete any service that is referenced by a service operation.	The information that applies to deleting services in production mode also applies to deleting services in development mode.
Service Operation	Rename	You cannot rename service operations that are associated to services that have WSDL or WADL provided. You must delete the WSDL or WADL before you can rename the service operation.	An alert message displays indicating that WSDL or WADL documents have been provided for the associated service, but you may continue with the action and rename the service operation.
Service Operation	Delete	You cannot delete service operations that are associated to services that have WSDL or WADL provided. You must delete the WSDL or WADL document before you can delete the service operation. If you delete the default service operation version, all versions of the service operation are deleted. You cannot delete a service operation that is referenced in the runtime tables.	An alert message displays indicating that WSDL or WADL documents have been provided for the associated service, but you may continue with the action and delete the service operation. You cannot delete a service operation that is referenced in the runtime tables.
Service Operation	Change Service	You cannot change a service operation that is associated to a service that has WSDL or WADL provided. You must first delete the WSDL or WADL documents before you can modify the setting. The new service to which you associate an operation may have had WSDL or WADL generated. However, if you want the WSDL or WADL from the newly associated service operation to be included in the WSDL or WADL document, you must export the service again.	An alert message displays indicating that WSDL or WADL documents have been provided for the associated service, but you may continue with the action and change the service associated with the service operation. The new service to which you associate an operation may have had WSDL or WADL generated. However, if you want the WSDL or WADL from the newly associated service operation to be included in the WSDL or WADL document, you must export the service again.

Using the Service Configuration Page to Set Service Configuration Properties

You set service configuration properties on the Service Configuration page (IB_SVCSETUP) and on the Target Locations page (IB_SVCSETUP_SEC) in the Services Configuration component (IB_SVCSETUP).

Use the Service Configuration page to define the service namespace, schema namespace and service system status. Use the page to also enable multi-queue functionality whereby multiple queues process asynchronous transactions, and to set alias enforcement in generated WSDL.

To access the Service Configuration page, select PeopleTools, Integration Broker, Services Configuration. The following example shows the Service Configuration page:

Using the Target Locations Page to Set Target Locations for Services

Use the Target Locations page (IB_SVCSETUP_SEC) to set service target locations. To access the page, select PeopleTools, Integration Broker, Configuration, Service Configuration, and click the Setup Target Locations link. The following example shows the page:

Use the Web Services Target Locations section of the Target Locations page to set an unsecured or secured URL to be used for XML message schema, WSDL, and as the SOAP endpoint when working with SOAP-based services. Use the REST Services Target Location section of the Target Locations page to set an unsecured or secured URL to be used for WADL and as the REST endpoint.

Setting Service and Schema Namespaces

To set service and schema namespaces:

Access the Service Configuration Properties page (PeopleTools, Integration Broker, Configuration, Services Configuration).
In the Service Namespace field, declare a service namespace.
In the Schema Namespace field, declare a schema namespace.
Click the Save button.

See Also

Namespaces

Using the Target Locations Page to Set Target Locations for Services

Setting Service System Status

To set the service system status:

Access the Service Configuration Properties page (PeopleTools, Integration Broker, Configuration, Services Configuration).
From the Service System Status drop-down list box, select one of the following options:
- Development. (Default.)
- Production.
These statuses are discussed elsewhere in this chapter

See Understanding Configuring PeopleSoft Integration Broker for Handling Services.
Click the Save button.

Setting the System for Multi-Queue Processing

To set the system for multi-queue processing:

Access the Service Configuration Properties page (PeopleTools, Integration Broker, Configuration, Services Configuration).
(Optional) Check the Enable Multi-queue box to use multiple queues to process inbound and outbound asynchronous requests.

This feature is discussed elsewhere in PeopleBooks.

See Assigning Multiple Queues to Process Service Operations.
Click the Save button.

Enabling WSDL Alias Generation Checking

To enable WSDL alias generation checking:

Access the Service Configuration Properties page (PeopleTools, Integration Broker, Configuration, Services Configuration).
From the WSDL Generation Alias Check drop-down list, select an option for enforcing field and record alias names in generated WSDL.

This feature is discussed elsewhere in PeopleBooks.

See Enforcing Message Record and Field Aliases in Generated WSDL.

Setting Target Locations for Services

To set the target location for services:

Access Target Location page (PeopleTools, Integration Broker, Configuration, Services Configuration and click the Set Target Locations link).
Locate the Web Services Target Locations section of the page.
In the Target Location field, enter an unsecured URL to be used for XML message schema, WSDL, and as the SOAP endpoint.

If you enter a secure URL in the Target Location field, XML message schema validation will fail.

If you require a secure target location for the SOAP endpoint, see Step 8c.

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 location URL format: .
```
http://<machine>:<port>/PSIGW/PeopleSoftServiceListeningConnector
/<defaultlocalnode>
```
(Optional) In the Secure Target Location field, enter a secure URL to be used as the SOAP endpoint.

The URL entered here overrides the target location defined in Step 8b for the target location for the SOAP endpoint.

The URL you enter here is also used as a secure target location for exporting WSDL, if you choose the Use Secure Target Location box in the Provide Web Service wizard.

If you do not enter a value in this field, the system uses the unsecured URL that you specify in the Target Location field for both the SOAP endpoint and for exporting WSDL.

See Step 2: Select Service Operations.

If you have a dedicated integration gateway, the format of the value that you enter is:
```
https://<machine>:<port>/PSIGW/PeopleSoftServiceListeningConnector
```
If the default local node points to a different gateway server, use the alternate location URL format:
```
https://<machine>:<port>/PSIGW/PeopleSoftServiceListeningConnector
/<defaultlocalnode>
```
Click the OK button.

The Service Configuration page appears.
Click the Save button.

See Also

Target Locations

Using the Target Locations Page to Set Target Locations for Services

Setting Target Locations for REST Services

To set the target location for REST services:

Access Target Location page (PeopleTools, Integration Broker, Configuration, Services Configuration and click the Set Target Locations link).
Locate the REST Services Target Location section of the page.
In the Target Location field, enter an unsecured URL to be used when exporting WADL documents and as the REST endpoint.

If you require a secure target location for the REST endpoint, see Step 9c.

If you have a dedicated integration gateway, the format of the value that you enter is:
```
http://<machine>:<port>/PSIGW/RESTListeningConnector
```
If the default local node points to a different gateway server where WADL documents and XSD schemas are available, use the alternate location URL format: .
```
 http://<machine>:<port>/PSIGW/RESTListeningConnector/<defaultlocalnode>  
```
(Optional) In the Secure Target Location field, enter a secure URL to be used as the REST endpoint.

The URL entered here overrides the target location defined in Step 9b for the target location for the REST endpoint.

The URL you enter here is also used as a secure target location for exporting WADL, if you choose the Use Secure Target Location box in the Provide Web Service wizard.

If you do not enter a value in this field, the system uses the unsecured URL that you specify in the Target Location field for both the REST endpoint and for exporting WADL.

See Step 2: Select Service Operations.

If you have a dedicated integration gateway, the format of the value that you enter is:
```
https://<machine>:<port>/PSIGW/RESTListeningConnector
```
If the default local node points to a different gateway server, use the alternate location URL format:
```
 https://<machine>:<port>/PSIGW/RESTListeningConnector/<defaultlocalnode>
```
Click the OK button.

The Service Configuration page appears.
Click the Save button.

See Also

Target Locations

Using the Target Locations Page to Set Target Locations for Services