Activity Asynchronous Processor (Oracle Field Service Initiated)

This section describes data mapping for the following:

• Get Resource Time Zone Mapping

• Invoke OFS Activity Mapping

• Search Activities Mapping

• Get OFS Activity Details(CMP) Mapping

• Replace Link Mapping

• Send to Common Error Handler Mapping

• Send Acknowledgment Message Mapping

• Invoke Cancel OFSC Activity Mapping

• Call NMS Attachment Integration Mapping

Get Resource Time Zone Mapping

OFSC GetResourceTimeZone Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	DVM Name	Oracle Utilities Network Management System Column	Oracle Field Service Column
Template Parameters		OutermostTag				Resource/Get Resource
Template Parameters		Group
resourceId	Template Parameters	Group	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName	ofsc.bucket	Map the OFS bucket name from OUTL-BRT-NMS_OFSC_ConfigProps dvm

Invoke OFS Activity Mapping

NMS Request Message			OFS Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM Name	Oracle Utilities Network Management System Column	Oracle Field Service Column
activities		OutermostTag	bulkUpdate_POST		OutermostTag				Activity/Bulk Update Activity
			activities.definitions.customActionActivityBulkUpdateSchema	bulkUpdate_POST	Group
			updateParameters	activities.definitions.customActionActivityBulkUpdateSchema	Group
			activities	activities.definitions.customActionActivityBulkUpdateSchema	List
			identifyActivityBy	updateParameters	string				Hard code with “apptNumber”

					string
id	activities	Number	apptNumber	activities	string
controlZone[1..10]	event	Group
crewId	activities	String	resourceId	activities	string	OUTL-BRT-NMS_OFSC_InstanceIDToBucket	NMS_InstanceID	OFSC_BucketID	See the following figure for value date format: YYYY-MM-DD.
			date	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName="ofsc.isScheduledForPreAssignedCrew	Value “true”	See the following figure for value date format: YYYY-MM-DD.
instanceId	activities	String	nms_instanceId	activities	string
type	activities	String	activityType	activities	string	OUTL-BRT-NMS_OFSC_ActivityType	NMS_ActivityType	OFSC_ActivityType
controlZone[1..10]	event	Group				OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName="ofsc.workZone.default.FuzzyType	Value “NO_OUTAGE”
ncg	controlZone[1..10]	String	nms_control_zone_key	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName="ofsc.controlZone	Value	If type != fuzzyType, use the incoming ncg value for that defined control_zone property.
state	activities	String
value	activities	String	status	activities	string	OUTL-BRT-NMS_OFSC_ActivityStatusChange	PropertyName="OFSC_ActivityStatusNew	Value	Property NMS_ActivityEventStatus equals state+value. If notfound, ignore target field.
			nms_activity_suspended	activities	string				Hardcode with 1 if status is filled
longitude	activities/coordinates	String	longitude	activities	string
latitude	activities/coordinates	String	latitude	activities	string
		String	common_utilities_product_code	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName	Value
serviceArea	activities	String	nms_serviceArea	activities	string
dispAddress	event	String	streetAddress	activities	string
comment	activities	String	nms_activity_comments	activities	string
id	event	String	nms_event_id	activities	string
active	event	String	nms_event_status	activities	string
type	event	String	nms_event_type	activities	string	OUTL-BRT-NMS_OIC_EventTypeCategoryCaching_DND	PropertyName	Second	Retrieve using NMS Event Type field.
deviceAlias	event	String	nms_deviceAlias	activities	string
nms_deviceLocation	event	String	location	activities	string
nms_event_phases	event	String	phases	activities	string
nms_feederName	event	String	feederName	activities	string
beginTime	event	String	nms_event_beginTime	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName	Value	Perform the date time zone conversion and format the date as configured in OUTL-BRT-NMS_OFSC_ConfigProps dvm for OFS.
firstCallTime	event	String	nms_event_firstCallTime	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName	Value	Perform the date time zone conversion and format the date as configured in OUTL-BRT-NMS_OFSC_ConfigProps dvm for OFS.
restoreTime	event	String	nms_event_actualRestoreTime	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName	Value	Perform the date time zone conversion and format the date as configured in OUTL-BRT-NMS_OFSC_ConfigProps dvm for OFS.
value	event/ert	String	nms_event_estimatedRestoreTime	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName	Value	Perform the date time zone conversion and format the date as configured in OUTL-BRT-NMS_OFSC_ConfigProps dvm for OFS.
numCustOut	event	String	nms_numCustOut	activities	string
critCCustOut	event	String	nms_critCCustOut	activities	string
nms_critDCustOut	event	String	critDCustOut	activities	string
nms_critKCustOut	event	String	critKCustOut	activities	string
nms_numCalls	event	String	numCalls	activities	string
nms_userNumCustOut	event	String	userNumCustOut	activities	string
nms_weightedNumCustOut	event	String	weightedNumCustOut	activities	string
numLifeSupport	event	String	nms_numLifeSupport	activities	string
priority	event	String	nms_priority	activities	string
description	event	String	nms_event_desc	activities	string
troubleCodeDesc	event	String	nms_event_troubleCodeDesc	activities	string
cause	event	String	nms_event_cause	activities	string
jobComments	event	String	nms_event_jobComments	activities	string				Use the function get-content-as-string to read the content of the element.
dispAddress	event	String	nms_event_dispAddress	activities	string
daStatus	event	String	nms_event_daStatus	activities	string
troubleQueue	event	String	nms_event_troubleQueue	activities	string
latitude	event/coordinates	String	nms_event_latitude	activities	string
		String	nms_activity_ofscupdate	activities	string				Hard code with “0”
		String	nms_event_category	activities	string				Map the $category variable
			nms_event_incidents1	activities	string				Map the variable $incidents_node/icd_text[1]
			nms_event_incidents2	activities	string				Map the variable $incidents_node/icd_text[2]
			nms_event_incidents3	activities	string				Map the variable $incidents_node/icd_text[3]
			nms_event_incidents4	activities	string				Map the variable $incidents_node/icd_text[4]
			nms_event_incidents5	activities	string				Map the variable $incidents_node/icd_text[5]
longitude	event/coordinates	String	nms_event_longitude	activities	string
v[2]	event/eventDetails/details/value	String	{concat('nms_', $category, '_', lower-case(nssrcdfl:name))}	activities	string				The OFSC element will be created as part of admin sync and the element name is combination of nms_category_name. If v[1] is java.sql.TimeStamp, then convert v[2] into OFS-DateFormat.
v[2]	event/failedEquipment/fields/value	String	{concat('nms_', nssrcdfl:name)}	activities	string				The OFSC element will be created as part of admin sync and the element name is combination of nms_name. If v[1] is java.sql.TimeStamp, then convert v[2] into OFS-DateFormat.
			position	activities	string	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName="ofsc.setPositionInRoute	Value “notOrdered”

Search Activities Mapping

NMS Request Message			OFS Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM Name	Oracle Utilities Network Management System Column	Oracle Field Service Column
/orders
			QueryParameters						Activity/Search Activity
			searchInField	QueryParameters	String				Hard code “nms_event_id”
id	event	String	searchForValue	QueryParameters	String
			dateFrom	QueryParameters	String				Use the current-date function. Subtract -21days Format the date: YYYY-MM-DD
			dateTo	QueryParameters	String				Use current-date function Format the date: YYYY-MM-DD
/orders/complete
			QueryParameters						Activity/Search Activity
			searchInField	QueryParameters	String				“apptNumber”
id	actvities	String	searchForValue	QueryParameters	String
			dateFrom	QueryParameters	String				Use the current-date function and format the date.
			dateTo	QueryParameters	String				Use the current-date function and format the date.
			offset	QueryParameters	String				“0”
			limit	QueryParameters	String				“100”

Get OFS Activity Details(CMP) Mapping

NMS Request Message			OFSC GetActivity Data Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM Name	Oracle Utilities Work and Asset Management Column	Oracle Field Service Column
			canonical_GET		Outermosttag				GET getActivityDetails
			Template Parameters	canonical_GET	Group
externalId	actvities	String	activityId	TemplateParameters	String

Replace Link Mapping

NMS Request Message			OFSC Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM Name	Oracle Utilities Network Management System Column	Oracle Field Service Column
			Template Parameters						Activity/Replace Activity Link
activityId	$searchResult/items		activityId	TemplateParameters	String
activityId	$activityResponse Data/otherData		linkedActivityId	TemplateParameters	String
activities.linktype			linkType	TemplateParameters	String	OUTL-BRT-NMS_OFSC_ConfigProps	PropertyName	Value

Send to Common Error Handler Mapping

NMS Request Message			OIC NMS-OFS CommonErrorHandler Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM Name	Oracle Utilities Network Management System Column	Oracle Field Service Column
			POST		OutermostTag
			request-wrapper	POST	Group
			faultMessage	request-wrapper	Group				“Data Issue”
			reason	faultMessage	Field
			code	faultMessage	Field
instanceId			instanceId	faultMessage	Field				From runtime values
			syncErrorApp Name	faultMessage	Field	OUTL-BRT-NMS_OFSC_ConfigProps	notification.type. email	Value
$errorVar			details	faultMessage	Field
			notificationTypes	faultMessage	Field
			type	faultMessage	Field				“Business”
flowname+version			flowName	faultMessage	Field				from runtime values

Send Acknowledgment Message Mapping

NMS Request Message			OIC Activity Async Processor Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM	Oracle Utilities Network Management System Column	Oracle Field Service Column
execute		Outermost Tag	executeResponse		OutermostTag				ack
request_wrapper	execute	Group	request_wrapper	POST	Group
header	request_wrapper	Group	errors	request_wrapper	Group
			error	errors	List
			value	error	Field
			id	error	Field
			errorCode	error	Field
			errorTime	error	Field
Message Id	header	Field	Message Id	request_wrapper	Field
			Ack Type	request_wrapper	Field				“SUCCESS”
			When	request_wrapper	Field				Current datetime in Z format
			ConnectivityProperties	execute
			Plugin	ConnectivityProperties
instanceId			ConnectionId	Plugin		OUTL-BRT-NMS_OFSC_InstanceIDToBucket	NMS_InstanceID		Retrieve NMS instance
On Error
FaultObject			OIC Activity Async Processor Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM	Oracle Utilities Network Management System Column	Oracle Field Service Column
			executeResponse		OutermostTag
FaultObject		Outermost Tag
errorCode			request_wrapper	POST	Group
reason			errors	request_wrapper	Group
details			error	errors	List				Fault details
			value	error	Field
			id	error	Field
			errorCode	error	Field				“ERROR”
			errorTime	error	Field				Current datetime in Z format
			Message Id	request_wrapper	Field
			Ack Type	request_wrapper	Field				“ERROR”
			When	request_wrapper	Field				Current datetime in Z format
			ConnectivityProperties	execute
			Plugin	ConnectivityProperties
instanceId			BaseURI	Plugin		OUTL-BRT-NMS_OFSC_InstanceIDToBucket	NMS_InstanceID		Retrieve NMS instance

Invoke Cancel OFSC Activity Mapping

NMS Request Message			OFSC Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM	Oracle Utilities Network Management System Column	Oracle Field Service Column
topLevelArray		OutermostTag	bulkUpdate_POST		OutermostTag				Activity/Bulk Update Activity
			activities.definitions.customActionActivityBulkUpdateSchema	bulkUpdate_POST	Group
			updateParameters	activities.definitions.customActionActivityBulkUpdateSchema	Group
			activities	activities.definitions.customActionActivityBulkUpdateSchema	List
			identifyActivityBy	updateParameters	string				apptNumber
			ifInFinalStatus Then	updateParameters	string				doNothing
			ifExistsThenDo NotUpdateFields	updateParameters	string
			resourceId	activities	string
			accessSchedule	activities	string
			resourceInternalId	activities	integer
			date	activities	string
id	activities	Field	apptNumber	activities	string
			status	activities	string				$varState
			nms_cancelledby	activities	string				“NMS”

Call NMS Attachment Integration Mapping

NMS Request Message			OIC NMS OFS Attachment Request Message			DVM Mapping			Comments
Element Name	Parent Element	Type	Element Name	Parent Element	Type	DVM	Oracle Utilities Network Management System Column	Oracle Field Service Column
activities		OutermostTag	POST		OutermostTag
request_wrapper	execute	Group	request_wrapper	POST	Group
header	request_wrapper	Group	header	request_wrapper	Group
Message Id	header	Field	Message Id	header	Field
timestamp	header	Field	timestamp	header	Field
event	request_wrapper	Group	event	request_wrapper	Group
attachments	event	Group	attachments	event	Group				For each attachment
reportType	attachments	Field	reportType	attachments	Field
fileName	attachments	Field	fileName	attachments	Field
reportId	attachments	Field	reportId	attachments	Field
length	attachments	Field	length	attachments	Field
description	attachments	Field	description	attachments	Field
fileModifiedDae	attachments	Field	fileModifiedDae	attachments	Field
documentId	attachments	Field	documentId	attachments	Field
contentType	attachments	Field	contentType	attachments	Field
uri	attachments	Field	uri	attachments	Field
id	event	Field	id	event	Field
activities	request-wrapper	Group	activities	request-wrapper	Group
id	event	Field	eventIdx	activities	Field
externalId	activities	Field	externalId	activities	Field				Use incoming or response from OFS BulkUpdate response
id	activities	Field	id	activities	Field
instanceId	activities	Field	nms-instance	activities	Field