Skip Headers
Oracle® Application Integration Architecture Oracle Driver Management for Oracle Transportation Management and Oracle E-Business Suite Implementation Guide
Release 3.1

Part Number E23246-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

2 Process Integration for Driver Profile

This chapter provides an overview of the process integration for driver profile and discusses business process flows, driver profile integration details, assumptions and constraints, Oracle E-Business Suite (Oracle EBS) and Oracle Transportation Management (OTM) interfaces, core Oracle Application Integration Architecture (Oracle AIA) components, and integration services.

This chapter includes the following sections:

2.1 Overview

Drivers are an important part of a company's fleet. Driver satisfaction and retention are critical to the successful and profitable operation of the fleet. Drivers are engaged in a variety of ways, such as full-time or part-time employees. Others may be independent contractors. Driver profile information entails driver personal data such as name, address, phone, and so forth.

2.2 Business Process Flows

The process integration for driver profile between Oracle Human Resources (HR) and OTM supports these integration flows:

2.3 Driver Profile Integration Details

This integration flow uses these services:

2.3.1 Initial Load of Driver Information

When you initiate the process, these events occur:

  1. The SyncWorkerListEbizInitialLoad is a business process execution language (BPEL) process that you initiate manually by providing the range of the person IDs that need to be synced to OTM as part of the initial load. For every person ID, this service invokes the SyncWorkerListBPELAggregator.

  2. The SyncWorkerListEbizBPELAggregator invokes the get_details API, which then returns the complete driver profile details. This service then checks for the completeness of the payload and invokes the get_training_details API and the get_certification_details API. All the messages generated by the API calls are then merged into one message into a payload.

  3. The SyncWorkerListEbizJMSProducer service reads the complete payload from the SyncWorkerListEbizBPELAggregator and drops the messages into AIA_EbizWorkerJMSQueue individually.

  4. The SyncWorkerListEbizJMSConsumer service listens to the AIA_EbizWorkerJMSQueue, dequeues the messages, and invokes the SyncWorkerListEbizReqABCSImpl with the WorkerListEBizABM.

  5. The SyncWorkerListEbizReqABCSImpl service transforms the WorkerListEBizABM into the SyncWorkerListEBM and populates the enterprise business message (EBM) header. The transformation does cross-referencing for system-specific values and invokes the WorkerEBS with the SyncWorkerList operation. The WorkerEBS is a routing mediator service with several operations on the WorkerEBO.

  6. The WorkerEBS service with the SyncWorkerList operation routes the messages based on the Composite Application Validation System (CAVS) flag to either the SyncWorkerListLogisticsProvABCSImpl service or the CAVS simulator.

  7. The SyncWorkerListLogisticsProvABCSImpl transforms the SyncWorkerListEBM into the WorkerListLogisticsABM, and invokes the OTMWebService, which connects to the OTM application.

2.3.2 Updating Driver Profile Information

The purpose of this flow is to load into OTM the driver profile information that was updated in Oracle EBS.

When you initiate the process, these events occur:

  1. The SyncWorkerListEbizGroupEventAdapter service listens to the oracle.apps.per.person.profile Business Event. This business event is raised when a person is created in Oracle E-Business Suite or any data related to a person is updated. The event information is then passed to the SyncWorkerListEbizEventAggregator.

  2. The SyncWorkerListEbizEventAggregator enqueues the events in an EBIZ_OBJECTS_EVENTS table through the DBAdapter. The procedure REGISTEREBIZEVENT.EVENTDETAILS, which fires for a period specified in the configuration, then reads the data from the table and invokes the SyncWorkerListEbizBPEL Aggregator.

  3. The SyncWorkerListEbizBPELAggregator invokes the get_details API, which then returns the complete driver profile details. This service then checks for the completeness of the payload and invokes the get_training_details API and the get_certification_details API. All the messages generated by the API calls are then merged into one message into a payload.

  4. The SyncWorkerListEbizJMSProducer service reads the complete payload from the SyncWorkerListEbizBPELAggregator and drops the messages into AIA_EbizWorkerJMSQueue individually.

  5. The SyncWorkerListEbizJMSConsumer service listens to the AIA_EbizWorkerJMSQueue, dequeues the messages, and invokes the SyncWorkerListEbizReqABCSImpl with the WorkerListEBizABM.

  6. The SyncWorkerListEbizReqABCSImpl service transforms the WorkerListEBizABM into the SyncWorkerListEBM and populates the EBM Header. The transformation does cross-referencing for system-specific values and invokes the WorkerEBS with the SyncWorkerList operation. The WorkerEBS is a routing mediator service with several operations on the WorkerEBO.

  7. The WorkerEBS service with the SyncWorkerList operation routes the messages based on the Composite Application Validation System (CAVS) flag to either the SyncWorkerListLogisticsProvABCSImpl service or the CAVS simulator.

  8. The SyncWorkerListLogisticsProvABCSImpl transforms the SyncWorkerListEBM into the WorkerListLogisticsABM and invokes the OTMWebService, which connects to the OTM application.

2.4 Assumptions and Constraints

These are the assumptions and constraints:

  1. This integration supports only the person type ID of an employee and a contingent worker.

  2. The default location role is SHIPFROM/SHIPTO.

  3. The country codes, qualification types, and delivery methods are manually maintained in OTM and Oracle EBS. These values are mapped using domain value maps (DVM).

  4. License state and country flexfields need to be configured at implementation time for human resources (HR).

2.5 Oracle EBS Interfaces

The Oracle EBS interfaces are:

For more information about Oracle EBS web services, see Oracle E-Business Suite references: Oracle E-Business Suite Electronic Technical Reference Manual (eTRM) located on My Oracle Support and Oracle Applications Online Documentation Library, located on the Oracle Technology Network (http://www.oracle.com/technology/documentation/applications.html)

2.5.1 SyncWorkerListEbizInitialLoad

The SyncWorkerListEbizInitialLoad is a business process execution language (BPEL) process that you invoke manually by providing the range of the person IDs that need to be synced to OTM as part of the initial load. For every person ID, this invokes the SyncWorkerListBPELAggregator service.

2.5.2 SyncWorkerListEbizGroupEventAdapter

The SyncWorkerListEbizGroupEventAdapter is a mediator process with a database adapter and routing services. This service listens to the business events and then invokes SyncWorkerListEbizEventAggregator.

2.5.3 SyncWorkerListEbizEventAggregator

The SyncWorkerListEbizEventAggregator is a BPEL process that is triggered when any OAAdapter raises an Oracle EBS Event and enqueues the events in an EBIZ_OBJECTS_EVENTS table through the DBAdapter. The procedure named REGISTEREBIZEVENT.EVENTDETAILS reads the data from the table and invokes the SyncWorkerListBPELAggregator service.

2.5.4 SyncWorkerListBPELAggregator

The SyncWorkerListBPELAggregator is a business process execution language (BPEL) process that the SyncWorkerListEventAggregator triggers upon listening to an Oracle EBS business event. This service invokes the get_person_details API, which returns the complete driver profile details. This service then checks for the completeness of the payload and then triggers the get_training_details application programming interface (API) and the get_certification_details API. All the messages generated by the API calls are then merged into one message.

2.5.5 SyncWorkerListEbizJMSProducer

The SyncWorkerListEbizJMSProducer service is a BPEL process used for both initial and incremental loads. The Oracle EBS application invokes this service when:

  • A new driver is created.

  • An existing driver is updated

This service reads the complete payload from the SyncWorkerListBPELAggregator and drops the messages into the AIA_EbizWorkerJMSQueue individually.

2.5.6 SyncWorkerListEbizJMSConsumer

The SyncWorkerListEbizJMSConsumer is a mediator service that picks up the messages from the AIA_EbizWorkerJMSQueue and invokes the SyncWorkerListEbizReqABCSImpl service.

2.6 OTM Interfaces

OTM provides an interface through a web service to connect to its application. This connectivity is established as a partner link in the provider service. Once invoked, the Logistics web service immediately returns an acknowledgement with a transmission number. Once the processing is complete, it then sends a transmission report back indicating the success or the failure. The application business message (ABM) details can be seen in the GLOG xsd with the driver element.

For more information about the Logistics Service, see Oracle Transportation Management Integration Guide.

2.7 Core Oracle AIA Components

The integration flow uses these components:

The core enterprise business object (EBO) and enterprise business message (EBM) XSD files can be located by EBO within the $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseObjectLibrary/Core/EBO/ parent folder.

The core enterprise business services (EBS) web services definition language (WSDL) files can be located by EBO within the $AIA_HOME/AIAMetaData/AIAComponents/EnterpriseBusinessServiceLibrary/Core/EBO/parent folder.

For detailed documentation of individual EBOs and EBMs, click AIA Reference Doc link on EBO and EBM detail pages in the Oracle Enterprise Repository.

For more information about using the Oracle Enterprise Repository and configuring it to provide the AIA Reference Doc link, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, "Configuring and Using Oracle Enterprise Repository as the Oracle AIA SOA Repository.

EBOs can be extended, for instance, to add new data elements. These extensions are protected and remain intact after a patch or an upgrade.

2.8 Integration Services

These are the services delivered with this integration:

2.8.1 SyncWorkerListEbizReqABCSImpl

SyncWorkerListEbizReqABCSImpl is a business process execution language (BPEL) process and a single operation service. It has WorkerEBS as a partner service. This service receives the WorkerListEbizABM message as a request and does not return a response to the calling service.

These actions are performed by this service:

  • Accepts WorkerListEbizABM message from Oracle E-Business Suite. This message contains a cross-reference for drivers, addresses, contacts, and driver information.

  • Transforms WorkerListEbizABM into WorkerListEBM. While transforming from application business message (ABM) to enterprise business message (EBM), it looks up these cross-references:

    • WORKER_ID

    • WORKER_CONTACTID

    • WORKER_DELIVERYMETHODID

    • WORKER_PHONEID

    • WORKER_QUALIFICATIONID

    • WORKER_BOOKINGID

    • WORKER_CERTIFICATIONENROLLID

    • WORKER_ADDRESS_ID

    • WORKER_ASSIGNMENTID

  • Sends WorkerListEBM message as input to SyncWorkerList operation in WorkerEBS service.

    These domain value map (DVM) lookups are used:

  • ADDRESS_COUNTRYID – Domain value mapping for country codes.

  • STATE – Domain value mapping for state codes.

  • QUALIFICATIONTYPE_ID – Domain value mapping for the qualification type.

  • COMMUNICATION_METHOD – Domain value mapping for the communication method.

  • PHONE_TYPE – Domain value mapping for phone types.

  • WORKER_PERSON_TYPE_ID – Domain value mapping for person type ID.

  • BLOOD_TYPE – Domain value mapping for blood type.

  • WORKER_ASSIGNMENT_STATUS – Domain value mapping for assignment status.

  • BUSINESSGROUP_DOMAIN – Domain value mapping for business group.

  • CONTACT_GENDERCODE – Domain value mapping for gender.

  • WORKER_ADDRESSTYPE – Domain value mapping for address type.

  • WORKER_CERTIFICATIONID – Domain value mapping for certification ID.

  • WORKER_PERIOD_STATUS_CODE – Domain value mapping for status.

  • WORKER_COMPETENCE_ID – Domain value mapping for competence ID.

2.8.2 WorkerEBS

The WorkerEBS is the Enterprise Business Service (EBS) that exposes all the enterprise operations related to the worker like create WorkerList, update WorkerList, synchronize WorkerList, and so on. This integration uses only the SyncWorkerList operation. This Enterprise Business Service routes the request to the appropriate provider like the SyncWorkerListLogisticsProvABCSImpl or the Composite Application Validation System (CAVS) based on the filter condition and operations. The EBS does updates and creates using the synchronization. This service does not do transformations. Oracle Transportation Management (OTM) determines whether this synchronize worker message is for a create or an update action.

For more information about this EBS, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, Designing and Developing Enterprise Business Services and Oracle Fusion Middleware Concepts and Technologies Guide for Oracle Application Integration Architecture Foundation Pack, Understanding Enterprise Business Services.

2.8.3 SyncWorkerListLogisticsProvABCSImpl

This SyncWorkerListLogisticsProvABCSImpl is a business process execution language (BPEL) process that receives the SyncWorkerListEBM, transforms the message into the WorkerLogisticsABM, invokes the Logistics web service with the SyncWorkerListEBM, and waits for the transmission report from the Logistics web service. If the transmission report specifies that the transaction is successful, it creates/updates the cross-reference values; otherwise, it invokes the AIAAsyncErrorHandlingBPEL process to generate the error messages.

These domain value map (DVM) lookups are used by this service:

  • ADDRESS_COUNTRYID - Domain value mapping for country codes.

  • STATE – Domain value mapping for state codes.

  • COMMUNICATION_METHOD – Domain value mapping for the communication method.

  • BUSINESSGROUP_DOMAIN – Domain value mapping for business group.

  • WORKER_CERTIFICATIONID – Domain value mapping for certification ID.