Resources Sync (Oracle Field Service Initiated)
This section describes data mapping for the following:
Get NMS System Data Mapping
OIC Get Admin Data Request Message
NMS GetAdmin Data Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management
Oracle Field Service Column
 
 
 
 
execute
 
Outermosttag
 
 
 
getAdminData
 
 
 
 
 
 
 
 
 
 
 
 
 
ConnectivityProperties
 
 
 
 
 
 
 
 
 
Plugin
ConnectivityProperties
 
 
 
 
 
 
 
 
ConnectionId
Plugin
 
OUTL-BRT-NMS_OFSC_InstanceIDToBucket
OFSC_BucketID
NMS_ConnectionID
 
 
 
 
 
 
 
OUTL-BRT-NMS_OFSC_ConfigProps
PropertyName
Value
“ofsc.bucket” as source
Get OFSC Resource Type Mapping
OFSC GetResourceType Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management Column
Oracle Field Service Column
 
canonical_GET
 
Outermosttag
 
 
 
GET /rest/ofscMetadata/v1/resourceTypes
TemplateParameters
canonical_GET
Group
 
 
 
 
offset
TemplateParameters
 
 
 
 
if not passed = 0
limit
TemplateParameters
 
 
 
 
if not passed = 100
Resource Created/Updated Mapping
OIC ResourceCreated/Updated Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management Column
Oracle Field Service Column
 
notify_POST
 
Outermosttag
 
 
 
 
resourceEvent
notify_POST
 
 
 
 
 
user
resourceEvent
String
 
 
 
 
applicationId
resourceEvent
String
 
 
 
 
time
resourceEvent
String
 
 
 
 
eventType
resourceEvent
String
 
 
 
 
resourceDetails
resourceEvent
Group
 
 
 
 
resourceInternalId
resourceDetails
String
 
 
 
 
resourceId
resourceDetails
String
 
 
 
 
name
resourceDetails
String
 
 
 
 
resourceType
resourceDetails
String
 
 
 
 
resourceChanges
resourceEvent
Group
 
 
 
 
resourceId
resourceChanges
String
 
 
 
 
organization
resourceChanges
String
 
 
 
 
resourceInternalId
resourceChanges
String
 
 
 
 
parentResourceInternalId
resourceChanges
String
 
 
 
 
status
resourceChanges
String
 
 
 
 
parentResourceId
resourceChanges
String
 
 
 
 
resourceType
resourceChanges
String
 
 
 
 
name
resourceChanges
String
 
 
 
 
email
resourceChanges
String
 
 
 
 
phone
resourceChanges
String
 
 
 
 
language
resourceChanges
String
 
 
 
 
languageISO
resourceChanges
String
 
 
 
 
timeZoneDiff
resourceChanges
Integer
 
 
 
 
timeZone
resourceChanges
String
 
 
 
 
timeZoneIANA
resourceChanges
String
 
 
 
 
dateFormat
resourceChanges
String
 
 
 
 
timeFormat
resourceChanges
String
 
 
 
 
durationStatistics
InitialRatio
resourceChanges
Double
 
 
 
 
durationStatistics
InitialPeriod
resourceChanges
Integer
 
 
 
 
Resource_0x737063_type
resourceChanges
String
 
 
 
 
tech_photo
resourceChanges
Group
 
 
 
 
links
tech_photo
Group
 
 
 
 
rel
links
String
 
 
 
 
href
links
String
 
 
 
 
mediaType
links
String
 
 
 
 
gender
resourceChanges
String
 
 
 
 
credence
resourceChanges
String
 
 
 
 
wam_resource_address
resourceChanges
String
 
 
 
 
wam_resource_source
resourceChanges
String
 
 
 
 
wam_resource_
lastUpdateDttm
resourceChanges
String
 
 
 
 
nms_resource
resourceChanges
String
 
 
 
 
common_utilities_
resource_code
resourceChanges
String
 
 
 
 
nms_crew_size
resourceChanges
Integer
 
 
 
 
Get OFS Resources Mapping
OFS GetActivity Data Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
DVM Name
PropertyName
Value
 
get_0x737063__0x736c68_rest_0x736c68_ofscCore_0x736c68_v1_0x736c68_resources
 
Outermosttag
 
 
 
GET Resource/Get Resources
QueryParameters
get_0x737063__0x736c68_rest_0x736c68_ofscCore_0x736c68_v1_0x736c68_resources
Group
 
 
 
 
offset
QueryParameters
String
 
 
 
offset+limit
limit
QueryParameters
String
OUTL-BRT-NMS_OFSC_ConfigProps
ofsc.resource
Detail.loopLimit
100
default if not found = “100”
Get NMS Instance URL Mapping
OIC ResourceCreated/Updated Request Message
OIC GetNMSInstanceURL Message
DVM Mapping
Comments
Element Name
Parent Element
Type
Element Name
Parent Element
Type
DVM Name
Property
Value
 
notify_POST
 
Outermosttag
execute
 
Outermosttag
 
 
 
 
resourceEvent
notify_POST
 
QueryParameters
execute
Group
 
 
 
 
resourceId
resourceDetails
String
resourceId
QueryParameters
String
 
 
 
 
 
 
 
bucketDVM
QueryParameters
String
OUTL-BRT-NMS_OFSC_ConfigProps
findInstance.oic.LookupName
OUTL-BRT-NMS_OFSC_InstanceIDToBucket
 
 
 
 
sourceColumn
QueryParameters
String
OUTL-BRT-NMS_OFSC_ConfigProps
findInstance.oic.LookupSourceColumnName
OFSC_BucketID
 
 
 
 
targetColumn
QueryParameters
String
OUTL-BRT-NMS_OFSC_ConfigProps
findInstance.oic.LookupTargetColumnName
NMS_ConnectionID
 
 
 
 
notFoundValue
QueryParameters
String
OUTL-BRT-NMS_OFSC_ConfigProps
findInstance.oic.LookupNotFoundValue
NotFound
 
Get OFS Resource Workskills Mapping
OFS Resources Responses Message
OFSC GetResourceWorkSkills Data Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management
Oracle Field Service Column
 
get_0x737063__0x736c68_rest_0x736c68_ofscCore_0x736c68_v1_0x736c68_
resources
 
Outermosttag
canonical_GET
 
Outermosttag
 
 
 
GET ofscCore/v1/resources/{resourceId}/workSkills
totalResults
get_...
Integer
Template
Parameters
canonical_GET
Group
 
 
 
 
offset
get_...
Integer
 
 
 
 
 
 
 
limit
get_...
Integer
 
 
 
 
 
 
 
items
get_...
String
 
 
 
 
 
 
 
Resource_0x737063_type
items
String
 
 
 
 
 
 
 
gender
items
String
 
 
 
 
 
 
 
credence
items
String
 
 
 
 
 
 
 
wam_resource_
address
items
String
 
 
 
 
 
 
 
wam_resource_
source
items
String
 
 
 
 
 
 
 
wam_resource_
lastUpdateDttm
items
String
 
 
 
 
 
 
 
nms_resource
items
String
 
 
 
 
 
 
 
common_utilities_
resource_code
items
String
 
 
 
 
 
 
 
timeZone
items
String
 
 
 
 
 
 
 
timeZoneIANA
items
String
 
 
 
 
 
 
 
email
items
String
 
 
 
 
 
 
 
phone
items
String
 
 
 
 
 
 
 
name
items
String
 
 
 
 
 
 
 
resourceType
items
String
 
 
 
 
 
 
 
resourceId
items
String
resourceId
TemplateParameters
String
 
 
 
 
resourceInternalId
items
String
 
 
 
 
 
 
 
dateFormat
items
String
QueryParameters
TemplateParameters
 
 
 
 
 
status
items
String
dateFrom
QueryParameters
 
 
 
 
current-dateTime YYYY-MM-DD - OFSC.timeZoneDiff
language
items
String
 
 
 
 
 
 
 
parentResourceId
items
String
 
 
 
 
 
 
 
timeFormat
items
String
 
 
 
 
 
 
 
timeZoneDiff
items
Integer
 
 
 
 
 
 
 
durationStatistics
InitialRatio
items
Double
 
 
 
 
 
 
 
durationStatistics
InitialPeriod
items
Integer
 
 
 
 
 
 
 
organization
items
String
 
 
 
 
 
 
 
avatar
items
Group
 
 
 
 
 
 
 
links
avatar
Group
 
 
 
 
 
 
 
rel
links
String
 
 
 
 
 
 
 
href
links
String
 
 
 
 
 
 
 
mediaType
links
String
 
 
 
 
 
 
 
nms_crew_size
items
Integer
 
 
 
 
 
 
 
eventType
 
String
 
 
 
 
 
 
 
resourceDetails
 
Group
 
 
 
 
 
 
 
resourceInternalId
 
String
 
 
 
 
 
 
 
resourceId
 
String
 
 
 
 
 
 
 
name
 
String
 
 
 
 
 
 
 
resourceType
 
String
 
 
 
 
 
 
 
resourceChanges
 
Group
 
 
 
 
 
 
 
parentResource
InternalId
 
String
 
 
 
 
 
 
 
languageISO
 
String
 
 
 
 
 
 
 
Get OFSC Workskill Details Mapping
OFSC GetResourceWorkSkills Data Response Message
OFSC GetWorkSkillDetails Data Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management
Oracle Field Service Column
 
executeResponse
 
Outermosttag
execute
 
Outermosttag
 
 
 
GET ofscCore/v1/resources/{resourceId}/workSkills
response-wrapper
executeResponse
Group
Template
Parameters
execute
Group
 
 
 
 
items
response-wrapper
Group
 
 
 
 
 
 
 
workSkill
items
String
workSkillId
TemplateParameters
String
 
 
 
If multiple active skills exist, then if non-temporary skills exist, then use the first non-temporary skill. Else, use first temporary skills. Else, use the skill returened.
ratio
items
String
 
 
 
 
 
 
 
startDate
items
String
 
 
 
 
 
 
 
totalResults
response-wrapper
Group
 
 
 
 
 
 
 
links
response-wrapper
Group
 
 
 
 
 
 
 
rel
links
String
 
 
 
 
 
 
 
href
links
String
 
 
 
 
 
 
 
Get OFSC Resource Work Zones Mapping
OFS Resources Responses Message
 
OFSC GetResourceWorkZones Data Request Message
DVM Mapping
 
Comments
 
Element Name
Parent Element
Type
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management
Oracle Field Service Column
 
get_0x737063__0x736c68_rest_0x736c68_ofscCore_0x736c68_v1_0x736c68_
resources
get_...
Outermosttag
canonical_GET
 
Outermosttag
 
 
 
GET Resource/Get Resources Work Zones
totalResults
get_...
Integer
Template
Parameters
canonical_GET
Group
 
 
 
 
offset
get_...
Integer
 
 
 
 
 
 
 
limit
get_...
Integer
 
 
 
 
 
 
 
items
items
String
 
 
 
 
 
 
 
Resource_0x737063_type
items
String
 
 
 
 
 
 
 
gender
items
String
 
 
 
 
 
 
 
credence
items
String
 
 
 
 
 
 
 
wam_resource_
address
items
String
 
 
 
 
 
 
 
wam_resource_
source
items
String
 
 
 
 
 
 
 
wam_resource_
lastUpdateDttm
items
String
 
 
 
 
 
 
 
nms_resource
items
String
 
 
 
 
 
 
 
common_utilities_
resource_code
items
String
 
 
 
 
 
 
 
timeZone
items
String
 
 
 
 
 
 
 
timeZoneIANA
items
String
 
 
 
 
 
 
 
email
items
String
 
 
 
 
 
 
 
phone
items
String
 
 
 
 
 
 
 
name
items
String
 
 
 
 
 
 
 
resourceType
items
String
 
 
 
 
 
 
 
resourceId
items
String
resourceId
TemplateParameters
String
 
 
 
 
resourceInternalId
items
String
 
 
 
 
 
 
 
dateFormat
items
String
 
 
 
 
 
 
 
status
items
String
 
 
 
 
 
 
 
language
items
String
 
 
 
 
 
 
 
parentResourceId
items
String
 
 
 
 
 
 
 
timeFormat
items
String
QueryParameters
canonical_GET
Group
 
 
 
 
timeZoneDiff
items
Integer
dateFrom
TemplateParameters
String
 
 
 
current-dateTime YYYY-MM-DD - OFSC.timeZoneDiff
durationStatistics
InitialRatio
items
Double
 
 
 
 
 
 
 
durationStatistics
InitialPeriod
items
Integer
 
 
 
 
 
 
 
organization
items
String
 
 
 
 
 
 
 
avatar
avatar
Group
 
 
 
 
 
 
 
links
links
Group
 
 
 
 
 
 
 
rel
links
String
 
 
 
 
 
 
 
href
links
String
 
 
 
 
 
 
 
mediaType
items
String
 
 
 
 
 
 
 
nms_crew_size
 
Integer
 
 
 
 
 
 
 
eventType
 
String
 
 
 
 
 
 
 
resourceDetails
 
Group
 
 
 
 
 
 
 
resourceInternalId
 
String
 
 
 
 
 
 
 
resourceId
 
String
 
 
 
 
 
 
 
name
 
String
 
 
 
 
 
 
 
resourceType
 
String
 
 
 
 
 
 
 
resourceChanges
 
Group
 
 
 
 
 
 
 
parentResource
InternalId
 
String
 
 
 
 
 
 
 
languageISO
 
String
 
 
 
 
 
 
 
Get OFSC Resource Route Mapping
OIC ResourceCreated/Updated Request Message
OFSC GetResourceRoute Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management
Oracle Field Service Column
 
notify_POST
 
Outermosttag
canonical_GET
 
Outermosttag
 
 
 
GET /ofscCore/v1/resources/{resourceId}/routes/{date}
resourceEvent
notify_POST
 
Template
Parameters
canonical_GET
Group
 
 
 
 
user
resourceEvent
String
 
 
 
 
 
 
 
applicationId
resourceEvent
String
 
 
 
 
 
 
 
time
resourceEvent
String
 
 
 
 
 
 
 
eventType
resourceEvent
String
 
 
 
 
 
 
 
resourceDetails
resourceEvent
Group
 
 
 
 
 
 
 
resourceInternalId
resourceDetails
String
 
 
 
 
 
 
 
resourceId
resourceDetails
String
resourceId
TemplateParameters
String
 
 
 
 
name
resourceDetails
String
 
 
 
 
 
 
 
resourceType
resourceDetails
String
 
 
 
 
 
 
 
resourceChanges
resourceEvent
Group
 
 
 
 
 
 
 
resourceId
resourceChanges
String
 
 
 
 
 
 
 
organization
resourceChanges
String
 
 
 
 
 
 
 
resourceInternalId
resourceChanges
String
 
 
 
 
 
 
 
parentResource
InternalId
resourceChanges
String
QueryParameters
canonical_GET
Group
 
 
 
 
timeZoneDiff
resourceChanges
Integer
date
TemplateParameters
 
 
 
 
current-dateTime YYYY-MM-DD - OFSC.timeZoneDiff
status
resourceChanges
String
 
 
 
 
 
 
 
parentResourceId
resourceChanges
String
 
 
 
 
 
 
 
resourceType
resourceChanges
String
 
 
 
 
 
 
 
name
resourceChanges
String
 
 
 
 
 
 
 
email
resourceChanges
String
 
 
 
 
 
 
 
phone
resourceChanges
String
 
 
 
 
 
 
 
language
resourceChanges
String
 
 
 
 
 
 
 
languageISO
resourceChanges
String
 
 
 
 
 
 
 
timeZone
resourceChanges
String
 
 
 
 
 
 
 
timeZoneIANA
resourceChanges
String
 
 
 
 
 
 
 
dateFormat
resourceChanges
String
 
 
 
 
 
 
 
timeFormat
resourceChanges
String
 
 
 
 
 
 
 
durationStatistics
InitialRatio
resourceChanges
Double
 
 
 
 
 
 
 
durationStatistics
InitialPeriod
resourceChanges
Integer
 
 
 
 
 
 
 
Resource_0x737063_type
resourceChanges
String
 
 
 
 
 
 
 
tech_photo
resourceChanges
Group
 
 
 
 
 
 
 
links
tech_photo
Group
 
 
 
 
 
 
 
rel
links
String
 
 
 
 
 
 
 
href
links
String
 
 
 
 
 
 
 
mediaType
links
String
 
 
 
 
 
 
 
gender
resourceChanges
String
 
 
 
 
 
 
 
credence
resourceChanges
String
 
 
 
 
 
 
 
wam_resource_
address
resourceChanges
String
 
 
 
 
 
 
 
wam_resource_
source
resourceChanges
String
 
 
 
 
 
 
 
wam_resource_
lastUpdateDttm
resourceChanges
String
 
 
 
 
 
 
 
nms_resource
resourceChanges
String
 
 
 
 
 
 
 
common_utilities_
resource_code
resourceChanges
String
 
 
 
 
 
 
 
Upsert NMS Crew Mapping
OFSC GetResourceDetail Response Message
NMS UpsertCrew Request Message
DVM Mapping
Comments
Element Name
Parent Element
Type
Element Name
Parent Element
Type
DVM Name
Oracle Utilities Work and Asset Management
Oracle Field Service Column
 
canonical_GETResponse
 
Outermosttag
execute
 
Outermosttag
 
 
 
createUpdateCrews
resources.definitions.resource
canonical_GETResponse
 
request_wrapper
execute
Group
 
 
 
 
resourceId
 
String
crewName
request_wrapper
String
 
 
 
 
phone
 
String
mobileNum
request_wrapper
String
 
 
 
 
status
 
String
isActive
request_wrapper
Boolean
 
 
 
If status = 'active' --> true
 
 
 
timeActivated
request_wrapper
String
 
 
 
If status = 'active', then timeActivated = current-dateTime in epoch format. Else, timeDeactivated = current-dateTime in epoch format.
 
 
 
timeDeactivated
request_wrapper
String
 
 
 
nms_crew_size
 
Integer
crewSize
request_wrapper
Integer
 
 
 
 
OFSC GetWorkSkillDetails Response Message
executeResponse
 
Outermosttag
 
 
 
 
 
 
 
response-wrapper
executeResponse
Group
 
 
 
 
 
 
 
name
response-wrapper
String
crewType
request_wrapper
String
 
 
 
If not empty
OFSC GetResourceRoute Response Message
executeResponse
 
Outermosttag
 
 
 
 
 
 
 
response-wrapper
executeResponse
Group
 
 
 
 
 
 
 
routeStartTime
response-wrapper
String
timeOnShift
request_wrapper
String
 
 
 
If incoming routeEndTime then timeOffShift = routeEndTime in epoch format. Else, if incoming routeReactivationTime then timeOnShift = routeReactivationTime in epoch format. Else, if incoming routeStart
Time then timeOnShift = routeStart
Time in epoch format. Else, timeOffShift = current-dateTime in epoch format.
routeEndTime
response-wrapper
String
timeOnShift
request_wrapper
String
 
 
 
routeReactivation
Time
response-wrapper
String
timeOnShift
request_wrapper
String
 
 
 
OFSC GetResourceWorkSkills Request Message
workZonesResponse
 
Outermosttag
 
 
 
 
 
 
 
getResourceWork
Zones
workZones
Response
Group
 
 
 
 
 
 
 
items
getResourceWork
Zones
Array
 
 
 
 
 
 
 
workzone
items
String
zoneHdlIdx
request_wrapper
String
 
 
 
 
NMS Get Admin Data Response Message
$Get_AdminData
 
Outermosttag
 
 
 
 
 
 
 
response-wrapper
$Get_AdminData
Group
 
 
 
 
 
 
 
controlZones
response-wrapper
Group
 
 
 
 
 
 
 
name
controlZones
String
zoneName
request_wrapper
String
 
 
 
If 'workzone' is found, use the first workzone.
ncg
controlZones
Integer
 
 
 
 
 
 
 
ncgClass
controlZones
Integer
zoneHdlCls
request_wrapper
Integer
 
 
 
If 'workzone' is found, use the first workzone.
 
 
 
outOfRange
request_wrapper
Boolean
OUTL-BRT-NMS_OFSC_ConfigProps
PropertyName = "nms.crew.outOfRange"
Value = "true"
 
 
 
 
isAvailForOp
request_wrapper
Boolean
OUTL-BRT-NMS_OFSC_ConfigProps
PropertyName = "nms.crew.isAvailForOp"
Value = "true"
 
 
 
 
isMobileIntegrated
request_wrapper
Boolean
OUTL-BRT-NMS_OFSC_ConfigProps
PropertyName = "nms.crew.outOfRange"
Value = "true"
 
OIC retrieveNMSinstanceURL Message Response
 
 
 
ConnectivityProperties
execute
 
 
 
 
 
GETResponse
 
Outermosttag
Plugin
ConnectivityProperties
 
 
 
 
 
components.schemas.response-wrapper
GETResponse
Group
 
 
 
 
 
 
 
resourceValue
components.schemas.response-wrapper
String
 
 
 
 
 
 
 
resourceBucket
components.schemas.response-wrapper
String
 
 
 
 
 
 
 
targetValue
components.schemas.response-wrapper
String
Connection
Plugin
 
OUTL-BRT-NMS_OFSC_InstanceIDToBucket
NMS_InstanceID
 
Retrieved NMS instance