Mapping HCM Services to Integration Broker
These topics provide an overview of HCM service mapping to Integration Broker and discuss how to:
Map HCM services to Integration Broker.
Delete mapped services.
Use Integration Broker to provide web services.
You can invoke HCM services from remote (non-PeopleSoft) systems. The SOA framework contains built-in functionality to process an incoming requests (services) and return the required response. This built in functionality gives you the ability to:
Generate a web service automatically.
Publish WSDL to the PeopleSoft repository.
Publish WSDL to UDDI.
Synchronize Integration Broker services with the Integration Services Repository (ISR) automatically.
PeopleTools Integration Broker serves as the transport mechanism for services. By mapping your HCM services to Integration Broker, you ensure that your Service Registry conforms to industry standards.
These topics discuss how to:
Map an HCM Interface Registry folder to an Integration Broker service.
Map an HCM service to an Integration Broker service operation.
Map interface details.
View service operation security.
View service operation handlers.
View service operation routings.
Mapping an HCM Interface Registry Folder to an Integration Broker Service
Initiate the mapping of HCM services to Integration Broker through the HCM Interface Registry. The system permits mapping at only third level folders, which are the lowest sub-categorization of HCM services for products.
To map the HCM Interface Registry metadata for a particular folder to an Integration Broker service:
Click the folder name link on the Service Registry page for a third level folder.
The system displays the WSDL for that registry folder.
Click the Add to service repository button to add to the service repository.
Provided that you have set up Integration Broker, the system displays details of the service.
Note: The Delete from service repository button is available only when you have mapped the registry folder to the Integration Broker service repository, at which time the Add to service repository button becomes unavailable. This ensures that you can only perform the correct action.
The system automatically generates an Integration Broker service name for the folder. This service name is the IUD for the folder, which is unique string within the HCM Interface Registry and thus guarantees that each service has a unique name. Optionally, you can rename the Integration Broker service to give it a more meaningful name through the Service Administration component If you rename the service, the system still guarantees a unique name because the Service Alias field contains a copy of the IUD service name. This ensures that the delete process has a means of correlating the service with the HCM Interface Registry.
Note: Do not change the Service Alias field under any circumstances because it is critical to service delete processing.
Mapping an HCM Service to an Integration Broker Service Operation
Each HCM service that is in a registry folder on the Service Registry page is mapped to an Integration Broker service operation and can be found in the service that you have generated for the folder on the Services page The system uses the name of the HCM service as the name for the service operation, unless that service operation already exists. If the service operation does already exist, an algorithm works within the length constraints of the Service Operation Name field (30 characters). The algorithm replaces the endmost characters with digits until it generates a unique name. The system retrieves the version for the service operation from the HCM Interface Registry.
Mapping Interface Details
The system maps each input and output interface to an integration Broker non-rowset based message, complete with generated schema. The system also assigns the version from the HCM Interface Registry. The base name for the messages is the HCM service name plus the suffix _IM or _OM to designate input or output interfaces, respectively (for example, ADDPOITYPE_IM).
The system maps outfault interfaces to Integration Broker non-rowset based part messages. This is due to the limitation of Integration Broker having only one fault message per service operation. Therefore, the system creates all outfaults that are associated with a mapped HCM service within an Integration Broker container message. The system indicates outfault messages by using the suffix _FM (for example, ADDPOITYPE_FM).
Viewing Service Operation Security
The system assigns each service operation that you generate the standard HCSPSERVICE permission list. Access the permission list details for the web service on the Web Service Access page click the Service Operation Security link).
Viewing Service Operation Handlers
The system assigns a handler to each service operation that you generate. The assigned handler references a generic handler class that is processing the incoming request, and generates the required response. The generic handler is HMCR_FRAMEWORK:IB_Framework:Handlers:IB_SyncRequestHandler. Access handlers for service operations on the Handlers page of the Service Operations component
Viewing Service Operation Routings
Within the HCM Registry there is no indication of consumers for a given service, so the system does not generate routings during the mapping process. It is up to the development teams to create the necessary routings.
Use the Service Registry to delete HCM services that you have mapped to Integration Broker. The system makes available the Delete from service repository button in the Service Registry only for folders that you have already added to the Integration Broker metadata.
The delete process removes the following objects from the Integration Broker metadata:
WSDL
Services
Service operations
Service operation security
Service operation handlers
Service operation routings
Messages (input, output, fault container, and part)
Message schemas
One main reason for mapping HCM services to Integration Broker is to use Integration Broker's capability of providing web services. You can provide a web service only for service operations that you define as having any-to-local routing. You create these service operations, along with their handlers and routings, in the Service Operations component.
To set up any-to-local routings for service operations:
Access the Service Operations component
Select the Generate Any-to-Local check box in the Routing Actions Upon Save area of the General page.
Save the component.
The system updates the Any-to-Local value of the Routing Status area to Exists.
The system also generates the routing and displays it on the Routings page of the component.
You can publish as a web service any service that has at least one service operation defined as any-to-local.
To publish a qualifying service as a web service:
Access the Provide Web Service component to launch the Provide Web Service Wizard.
The system displays the Select Services page.
Search for the service that you wish to publish as a web service.
Select that service in the returned search results, and then click the Next button.
The system displays the Select Service Operations page.
Select the service operation for the service that you want to publish as a web service, and then click the Next button.
The system displays the View WSDL page.
Click the View WSDL link for a service to view the WSDL that the system generated for the service.
Return to the View WSDL page and click the Next button.
The system displays the Specify Publishing Options page.
Define where to publish the selected services.
Select the Publish to UDDI check box or the WSDL Repository check box to publish the services to the corresponding location.
The system displays the Provide Web Service - Results page.
View the WSDL generation log to confirm the results of the wizard.