13Mapping Definitions
Mapping Definitions
This chapter describes mapping definitions that Siebel Field Service Integration to Oracle Real-Time Scheduler uses. It includes the following topics:
Mapping Definitions That Manage an Appointment
This topic describes mapping definitions to manage an appointment.
Mapping Definitions That Book, Confirm, Insert, or Reschedule an Appointment
The following table describes mapping definitions to book an appointment. Note the following:
The integration component in Siebel CRM is a child object type of the integration object.
The parent element is in the Oracle Real-Time Scheduler Web service schema.
| Siebel CRM | Oracle Real-Time Scheduler | Description | ||
|---|---|---|---|---|
Integration Component |
Field Name |
Parent Element |
Field Name |
|
Action |
Id |
Task |
hostExternalId |
|
NoSoonerThanDate/Planned |
startDateTime |
|||
Due/Plannedcompletion |
endDateTime |
|||
ServiceRegionId |
serviceArea |
|||
ServiceRegionTimeZone |
timeZone |
|||
LateCost |
lateCost |
|||
WorkTimeMin(*60) |
estimatedDuration |
|||
ServiceCity |
city |
|||
ServiceCountry |
country |
|||
ServiceLatitude |
geocodeLatitude |
|||
ServiceLongitude |
geocodeLongitude |
|||
ServiceState |
state |
|||
ServiceStreetAddress |
address2 |
|||
ServiceZipCode |
postal |
|||
Error Desc |
ServerMessage/TEXT |
|||
Request_status |
No Mapping Available |
Value is set to SUCCESS or FAIL based on the message returned from MWM. |
||
Language code |
No Mapping Available |
Value is set in FMW after looking up the value in the DVM. |
||
FS Activity Skill |
ItemTypeName+LowChar1+ExpertiseCode |
capabilityType |
||
No Mapping Available |
action |
Value is hardcoded as M1UP in FMW. |
||
taskType |
Value is hardcoded as SIEBEL_GENERIC_ACTIVITY in FMW. |
|||
overrideCapabilities |
Value is hardcoded as M1YS in FMW. |
|||
crewSize |
Value is hardcoded as 1 in FMW. |
|||
count |
Value is hardcoded as 1 in FMW. |
|||
appointment |
Value is hardcoded as N in FMW. |
|||
timeWindowUsage |
Value is hardcoded as M1EF in FMW. |
|||
conditionalBooking |
Value is hardcoded as Y for confirm appointment in FMW. |
|||
Mapping Definitions That Cancel an Appointment
Table Mapping Definitions That Cancel an Appointment
| Siebel CRM | Oracle Real-Time Scheduler | Description | ||
|---|---|---|---|---|
Field Name |
Parent Element |
Field Name |
||
Id |
STOP |
STOP_ID |
No more information available. |
|
This topic describes mapping definitions that synchronize a status update.
Mapping Definitions That Synchronize an Activity
The following table describes mapping definitions that synchronize an activity. The Siebel CRM fields in the table reside in the Action business component. The Oracle Real-Time Scheduler fields reside in the Taskcomponent.
| Siebel CRM | Oracle Real-Time Scheduler | Description | |
|---|---|---|---|
Field Name |
Parent Element |
Field Name |
|
Id |
hostExternalId |
||
Status |
StatusFromHost |
||
StatusUpdateTimeStamp |
StatusUpdateDate |
||
RESULT |
Value is set as FAIL or SUCCESS in FMW. |
||
languageCode |
Value is set in FMW after looking up in the DVM |
||
| Siebel CRM | Oracle Real-Time Scheduler | Description | |
|---|---|---|---|
| Field Name |
Parent Element |
Field Name |
|
| Entity Reference Id |
BREAK_COMPLETE |
BREAK |
If the STATUS is COMPLETE, then this integration maps these Siebel CRM fields to the BREAK_COMPLETE parent element. |
| Due Date |
DATE |
||
| This integration maps the following fields:
|
TIME |
||
| Entity Reference Id |
BREAK_START |
BREAK |
If the STATUS is START, then this integration maps these Siebel CRM fields to the BREAK_START parent element. |
| Due Date |
DATE |
||
| This integration maps the following fields:
|
TIME |
||
| Status in Oracle Real-Time Scheduler | Parent Element |
|---|---|
| STARTED |
STOP_ STARTED |
| ENROUTE |
STOP_ ENROUTE |
| COMPLETED |
STOP_ COMPLETED |
| ARRIVED |
STOP_ ARRIVED |
| ACKNOWLEDGED |
STOP_ ACKNOWLEDGED |
| DESPATCHED |
STOP_ DESPATCHED |
Mapping Definitions That Synchronize a Shift, Break, or POU
The following table describes mapping definitions that synchronize a shift, break, or POU. The Siebel CRM fields in the table reside in the Integrated Shift Break POU business component. The Oracle Real-Time Scheduler fields reside in the Shift, Break, or POU component.
| Siebel CRM | Oracle Real-Time Scheduler | Description | |
|---|---|---|---|
Field Name |
Parent Element |
Field Name |
|
EntityReferenceID |
ShiftID |
||
Status |
boStatus |
||
Shift |
ShiftID |
||
crewName |
TechnicianID |
||
DueDate |
startDateTime |
||
EndTime |
completionDateTime |
||
EntityReferenceID |
taskId |
||
Type |
Value is hardcoded as SHIFT_BREAK in FMW. |
||
languageCode |
Value is set in FMW after looking up in the DVM. |
||
| Siebel CRM | Oracle Real-Time Scheduler | Description | |
|---|---|---|---|
Field Name |
Parent Element |
Field Name |
|
Entity Reference Id |
BREAK_COMPLETE |
BREAK |
If the STATUS is COMPLETE, then this integration maps these Siebel CRM fields to the BREAK_COMPLETE parent element. |
Due Date |
DATE |
||
This integration maps the following fields:
|
TIME |
||
Entity Reference Id |
BREAK_START |
BREAK |
If the STATUS is START, then this integration maps these Siebel CRM fields to the BREAK_START parent element. |
Due Date |
DATE |
||
This integration maps the following fields:
|
TIME |
||
| Siebel CRM | Oracle Real-Time Scheduler | Description | |
|---|---|---|---|
Field Name |
Parent Element |
Field Name |
|
Entity Reference Id |
POU_ARRIVED |
STOP_ID |
No more information available. |
This integration maps the following fields:
|
RSRC_ID |
Technician Id~Technician First Name Technician Last Name |
|
Shift |
SHIFT_ID |
No more information available. |
|
Due Date |
DATE |
This integration uses the following format: YYYYMMDD |
|
Start Time, UTC Offset |
TIME |
This integration uses the following format: HHMMZ+-HHMM |
|
Entity Reference Id |
POU _ COMPLETED |
STOP_ID |
No more information available. |
This integration maps the following fields:
|
RSRC_ID |
Technician Id~Technician First Name Technician Last Name |
|
Shift |
SHIFT_ID |
No more information available. |
|
Due Date |
DATE |
This integration uses the following format: YYYYMMDD |
|
End Time, UTC Offset |
POU _ DESPATCHED |
TIME |
This integration uses the following format:HHMMZ+-HHMM |
Entity Reference Id |
STOP_ID |
No more information available. |
|
Shift |
SHIFT_ID |
||
Entity Reference Id |
POU _ ENROUTE |
STOP_ID |
No more information available. |
This integration maps the following fields:
|
POU _ ENROUTE |
RSRC_ID |
Technician Id~Technician First Name Technician Last Name |
Shift |
SHIFT_ID |
No more information available. |
|
Entity Reference Id |
STOP_ID |
||
This integration maps the following fields:
|
POU _ STARTED |
RSRC_ID |
Technician Id~Technician First Name Technician Last Name |
Shift |
SHIFT_ID |
No more information available. |
|
Due Date |
DATE |
||
Start Time, UTC Offset |
TIME |
Z+- HH MM |
|
Entity Reference Id |
POU _ ACKNOWLEDGED |
STOP_ID |
No more information available. |
This integration maps the following fields:
|
No more information available. |
Technician Id~Technician First Name Technician Last Name |
|
Shift |
SHIFT_ID |
No more information available. |
|
Mapping Definitions That Update Data in Real Time
This topic describes mapping definitions that update data in real time.
Mapping Definitions That Update Employee Data in Real Time
The following table describes mapping definitions that update exception data in real time. Except where noted in the table, the Siebel CRM fields in the table reside in the Employee business component.
| Siebel CRM | Oracle Real-Time Scheduler | Description | ||
|---|---|---|---|---|
Integration Component |
Field Name |
Parent Element |
Field Name |
|
Employee |
Id |
Crew |
externalUserId |
|
FirstName |
firstName |
|||
LastName |
lastName |
|||
RowId |
externalUserId |
|||
SchedulingAvailabilityEndDate |
subscriptionEndDate or endDateTime |
|||
SchedulingAvailabilityStartDate |
subscriptionStartDate or startDateTime |
|||
ServiceRegionId |
serviceArea |
|||
TimeZoneNameStd |
timeZone |
|||
languageCode |
Value is set in FMW after looking up in the DVM. |
|||
Employee Skill / Employee Skill Item |
ItemTypeName+LowChar1+ExpertiseCode |
skill |
||
ItemTypeName+LowChar1+ExpertiseCode |
description |
|||
Mapping Definitions That Update Schedule Data in Real Time
The following table describes mapping definitions that update schedule data in real time. Except where noted in the table, the Siebel CRM fields in the table reside in the Shift business component.
| Siebel CRM | Oracle Real-Time Scheduler | Description | ||
|---|---|---|---|---|
Integration Component |
Field Name |
Parent Element |
Field Name |
|
Shift |
Id |
Shift Weekly Template |
externalId |
|
ExceptionId |
externalExceptionId |
|||
Description |
description |
|||
SyncSuccessFlag |
Value is set as Y or N. |
|||
languageCode |
Value is set in FMW after looking up in the DVM. |
|||
bo |
Value is hardcoded as M1-CrewShiftTemplate in FMW. |
|||
crewShiftType |
Value is hardcoded as SIEBEL_GENERIC_SHIFT_TYPE in FMW. |
|||
shiftCostProfile |
Value is hardcoded as SIEBEL_STD_PROFILE in FMW. |
|||
dripMode |
Value is hardcoded as M1AL in FMW. |
|||
shiftWeeklyTemplateId |
Value is hardcoded as SIEBEL_GENERIC in FMW. |
|||
standbyShift |
Value is hardcoded as M1NO in FMW. |
|||
This integration maps Shift Hours from Oracle’s Siebel CRM to the Shift Weekly Template in Oracle Real-Time Scheduler by applying following logic:
For all the Shift Hours with same Start Day:
The Start Time of the record with the Shift Start flag set to Y is mapped to Start Time for the Shift in Oracle Real-Time Scheduler.
The End Time of the last record is mapped to the End Time for Shift in Oracle Real-Time Scheduler.
The Gaps between these records are being mapped to Breaks in Oracle Real-Time Scheduler.
Mapping Definitions That Update Exception Datain Real Time
The following table describes mapping definitions that update exception data in real time. Except where noted in the table, the Siebel CRM fields in the table reside in the Employee business component. The Oracle Real-Time Scheduler fields reside in the Crew component.
| Siebel CRM | Oracle Real-Time Scheduler | Description | ||
|---|---|---|---|---|
Integration Component |
Field Name |
Parent Element |
Field Name |
|
Employee |
Id |
Crew |
externalUserId |
|
FirstName |
firstName |
|||
LastName |
lastName |
|||
RowId |
externalUserId |
|||
SchedulingAvailabilityEndDate |
subscriptionEndDate or endDateTime |
|||
SchedulingAvailabilityStartDate |
subscriptionStartDate or startDateTime |
|||
Mapping Definitions That Retrieve Geocodes for Single Addresses and Multiple Addresses
The following table describes mapping definitions that retrieve geocodes for single addresses and multiple addresses. The Siebel CRM fields in the table reside in the CUT Address business integration component. The Oracle Real-Time Scheduler fields reside in the Address component.
Field Name in Siebel CRM |
Field Name in Oracle Real-Time Scheduler | Description |
|---|---|---|
StatusDesc |
geocdFailescVal |
Any failure during the process of getting geocodes will be mapped here. |
LanguageCode |
Value is set in FMW after looking up the information in the DVM. |
|
StreetAddress |
ADDRESS1 |
No more information available. |
StreetAddress2 |
ADDRESS2 |
|
CrossStreet |
CrossStreet |
FMW has the required logic to map the Province, County, or Metro Area from Siebel CRM to stateOrProvince if State information is not available. |
Postal Code |
Postal |
No more information available. |
Country |
COUNTRY |
|
GeocodeValidFlag |
GeocodeValidFlag |
Value is set to Y or N in FMW. |
GeocodeFailDesc |
GeocodeFailDesc |
Value is set to the error message returned from Oracle Real-Time Scheduler. |