Mapping HCM Services to Integration Broker

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:

  1. Click the folder name link on the Service Registry page for a third level folder.

    The system displays the WSDL for that registry folder.

  2. 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 (PeopleTools, and then Integration Broker, and then Service Utilities, and then Service Administration). 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 (PeopleTools, and then Integration Broker, and then Integration Setup, and then Services). 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 (PeopleTools, and then Integration Broker, and then Service Operations, and then General 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 (PeopleTools, and then Integration Broker, and then Integration Setup, and then Service Operations).

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.