OFS Activity Event Receive Message | OFS Get ActivityDetails 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 | |
notify_POST | Outermosttag | canonical_GET | Outermosttag | ||||||
events.definitions. activityEvent | notify_POST | Group | Template Parameters | canonical_GET | Group | ||||
activityDetails | events.definitions. activityEvent | Group | |||||||
activityId | activityDetails | String | activityId | TemplateParameters | String |
OFS Activity Event Receive Message OFS Get ActivityDetails Response Message | NMS Update Event Request Message (If Activity Updated) | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
notify_POST | Outermosttag | Request -Wrapper | Outermosttag | updateEvents | |||||
events.definitions.activityEvent | notify_POST | Group | topLevelArray | Request-Wrapper | Group | ||||
activityDetails | events.definitions.activityEvent | Group | |||||||
apptNumber | activityDetails | String | activityId | topLevelArray | Field | ||||
resourceid | activityDetails | String | crewId | topLevelArray | Field | if resourceId present | |||
activityChanges | events.definitions.activityEvent | Group | Group | ||||||
event | topLevelArray | Group | |||||||
nms_event_actualRestoreTime | activityChanges | String | restoreTime | Event | Field | if present: Formatted in NMS DateTime format | |||
nms_event_estimatedRestoreTime | activityChanges | String | ert | Event | Field | if present: Formatted in NMS DateTime format | |||
nms_event_operatorComment | activityChanges | String | operatorComment | Event | Field | if present | |||
nms_device_confirmation | activityChanges | String | device Confirmation | topLevelArray | Field | if present | |||
nms_restoration | activityChanges | String | restoration | topLevelArray | Field | Hardcode to "true" when nms_restoration =1. Else, “False”. | |||
canonical_GET Response | Outermosttag | ||||||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | |||||||
nms_deviceAlias | activities.definitions.getActivitySchema | String | deviceAlias | Top-level Array/Event | Field | ||||
Connectivity Properties | |||||||||
Plugin | ConnectivityProperties | ||||||||
nms_instanceId | activities.definitions.getActivitySchema | String | ConnetionId | Plugin | OUTL-BRT-NMS_OFSC_InstanceIDToBucket | NMS_InstanceID | NMS_ConnectionID |
OFSC Activity Event Receive Message | OIC API Request Message | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
notify_POST | Outermosttag | POST | Outermosttag | ||||||
events.definitions.activityEvent | notify_POST | Group | request-wrapper | POST | Group | ||||
activityDetails | events.definitions.activityEvent | Group | |||||||
activityId | activityDetails | Field | activityId | request-wrapper | Field | ||||
apptNumber | activityDetails | Field | apptNumber | request-wrapper | Field | ||||
activityChanges | events.definitions.activityEvent | Group | activityChanges | request-wrapper | Group | ||||
nms_attachment_[1..10] | activityChanges | Field | fieldname | activityChanges | Field | parse element name() | |||
nms_attachment_[1..10] | activityChanges | Field | fieldValue | activityChanges | Field |
OFSC Get ActivityDetails Response Message | OIC API Request Message | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
canonical_GETResponse | Outermosttag | ||||||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | |||||||
nms_event_id | activities.definitions.getActivitySchema | Field | nms_event_id | request-wrapper | Field | ||||
nms_instanceId | activities.definitions.getActivitySchema | Field | nms_instanceId | request-wrapper | Field | ||||
nms_attach_output | activities.definitions.getActivitySchema | Field | nms_attachments | request-wrapper | Field | ||||
nms_attachment_[1..10] | activities.definitions.getActivitySchema | Group | |||||||
links | nms_attachment_[1..10] | Group | |||||||
mediaType | links | Field | mediaType | activityChanges | Field | Retrieve mediaType based on the changed ElementName found in the incoming event update. The mediatype is stored in the “alternate” links type group which is also the only group with a mediaType. |
OFS Activity Event Receive Message OFS Get ActivityDetails Response Message | NMS Update Activity Request Message (Activity Started/Suspended) | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
notify_POST | Outermosttag | request-wrapper | Outermosttag | updateActivities | |||||
events.definitions.activityEvent | notify_POST | Group | topLevelArray | Request-Wrapper | Group | ||||
eventType | events.definitions.activityEvent | String | state | topLevelArray | Field | OUTL-BRT-NMS_OFSC_ActivityStatus | OFSC_EventType | NMS_ActivityStatus | |
activityDetails | events.definitions.activityEvent | Group | |||||||
resourceId | activityDetails | String | crewId | topLevelArray | Field | ||||
canonical_GETResponse | Outermosttag | ||||||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | |||||||
activityType | activities.definitions.getActivitySchema | String | type | topLevelArray | Field | ||||
apptNumber | activities.definitions.getActivitySchema | String | id | topLevelArray | Field | ||||
activityId | activities.definitions.getActivitySchema | String | externalId | topLevelArray | Field | ||||
ConnectivityProperties | |||||||||
Plugin | ConnectivityProperties | ||||||||
nms_instanceId | activities.definitions.getActivitySchema | String | ConnetionId | Plugin | OUTL-BRT-NMS_OFSC_InstanceIDToBucket | NMS_InstanceID | NMS_ConnectionID |
OIC API Request Message | DVM Mapping | Comments | ||||
---|---|---|---|---|---|---|
Element Name | Parent Element | Type | DVM Name | Column 1 | Column 2 | |
execute | Outermosttag | GET /ic/api/integration/v1/lookups/{lookupName} | ||||
TemplateParameters | execute | |||||
lookupName | TemplateParameters | Lookup name is “OUTL-BRT-NMS_OIC_FailedEquipCaching_DND” | ||||
request-wrapper | execute | Group | ||||
columns | request-wrapper | String | Hardcoded “NMS_FIELDNAME” | |||
columns | request-wrapper | String | Hardcoded “NMS_DATATYPE” | |||
columns | request-wrapper | String | Hardcoded “NMS_LENGTH” | |||
columns | request-wrapper | String | Hardcoded “OFS_FIELDNAME” | |||
columns | request-wrapper | String | Hardcoded “OFS_LABEL” | |||
rows | request-wrapper | Array | ||||
rowData | rows | String | ||||
rowData | rows | String | ||||
rowData | rows | String | ||||
rowData | rows | String | ||||
rowData | rows | String | ||||
name | request-wrapper | String | Lookup name is “OUTL-BRT-NMS_OIC_FailedEquipCaching_ DND” |
OFSC Get ActivityDetails Response Message Event Details(var) Failed Equipment Details(var) | NMS Update Event Request Message (Activity Completed) | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
canonical_GETResponse | Outermosttag | request-wrapper | Outermosttag | ||||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | topLevelArray | Group | |||||
resourceId | activities.definitions.getActivitySchema | String | crewId | topLevelArray | Field | ||||
apptNumber | activities.definitions.getActivitySchema | String | activityId | topLevelArray | Field | ||||
nms_event_actualRestoreTime | activities.definitions.getActivitySchema | String | restoration | topLevelArray | Field | Hard code to “true” if nms_event_actualRestoreTime !='' | |||
cancellation | topLevelArray | Field | Hard code to “false” | ||||||
nms_cancel_reason | activities.definitions.getActivitySchema | String | cancelReason | topLevelArray | Field | ||||
event | topLevelArray | Group | |||||||
nms_event_id | activities.definitions.getActivitySchema | String | id | event | Field | ||||
nms_deviceAlias | activities.definitions.getActivitySchema | String | deviceAlias | event | Field | ||||
nms_event_phases | activities.definitions.getActivitySchema | String | phases | event | Field | ||||
nms_feederName | activities.definitions.getActivitySchema | String | feederName | event | Field | ||||
nms_event_actualRestoreTime | activities.definitions.getActivitySchema | String | restoreTime | event | Field | If present: Formatted in NMS DateTime format | |||
nms_event_estimatedRestoreTime | activities.definitions.getActivitySchema | String | ert | event | Field | Formatted in NMS DateTime format | |||
nms_event_operatorComment | activities.definitions.getActivitySchema | String | operatorComment | event | Field | ||||
eventDetails | event | Group | |||||||
fieldnames starting with nms_{nms_event_category}_ | details | eventDetails | Group | Iterate for each eventDetails details values | |||||
v[1] | details | Field | hardcoded as "java.lang.String" | ||||||
field value | v[2] | details | Field | values found from OFS GetActivityDetails | |||||
fieldname after nms_{nms_event_category}_ | name | details | Field | ||||||
failedEquipment | event | Group | Iterate for each failedEquipment rows in Lookup and retrieve from GetActivityDetails elements. | ||||||
fields | faileEquipment | Group | |||||||
v[1] | fields | Field | ROWDATA[2] | ||||||
v[2] | fields | Field | OFS value,date formatted if needed | ||||||
name | fields | Field | ROWDATA[1] | ||||||
ConnectivityProperties | |||||||||
Plugin | ConnectivityProperties | ||||||||
nms_instanceId | activities.definitions.getActivitySchema | String | ConnetionId | Plugin | OUTL-BRT-NMS_OFSC_InstanceIDToBucket | NMS_InstanceID | NMS_ConnectionID |
OFS Activity Event Receive Message OFS Get ActivityDetails Response Message " | NMS Update Activity Request Message (Activity Completed) | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
notify_POST | Outermosttag | request-wrapper | Outermosttag | updateActivities | |||||
events.definitions.activityEvent | notify_POST | Group | topLevelArray | Request-Wrapper | Group | ||||
eventType | events.definitions.activityEvent | String | state | topLevelArray | Field | OUTL-BRT-NMS_OFSC_ActivityStatus | OFSC_EventType | NMS_ActivityStatus | |
activityDetails | events.definitions.activityEvent | Group | |||||||
activityId | activityDetails | String | externalId | topLevelArray | Field | ||||
resourceId | activityDetails | String | crewId | topLevelArray | Field | ||||
apptNumber | activityDetails | String | id | topLevelArray | Field | ||||
eventType | events.definitions.activityEvent | String | action | topLevelArray | Field | OUTL-BRT-NMS_OFSC_ActivityStatus | OFSC_EventType | NMS_ActionCode | |
canonical_GETResponse | Outermosttag | ||||||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | |||||||
ConnectivityProperties | |||||||||
Plugin | ConnectivityProperties | ||||||||
nms_instanceId | activities.definitions.getActivitySchema | String | ConnetionId | Plugin | OUTL-BRT-NMS_OFSC_InstanceIDToBucket | NMS_InstanceID | NMS_ConnectionID |
OFS Get ActivityDetails Response Message | NMS Update Event Request Message (Activity Cancelled/NotDone) | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
canonical_GETResponse | Outermosttag | request-wrapper | Outermosttag | updateEvents | |||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | topLevelArray | Group | |||||
resourceId | activities.definitions.getActivitySchema | String | crewId | topLevelArray | Field | ||||
apptNumber | activities.definitions.getActivitySchema | String | activityId | topLevelArray | Field | ||||
cancellation | topLevelArray | Field | Hard code to “true” | ||||||
nms_cancel_reason | activities.definitions.getActivitySchema | String | cancelReason | topLevelArray | Field | ||||
ConnectivityProperties | |||||||||
Plugin | ConnectivityProperties | ||||||||
nms_instanceId | activities.definitions.getActivitySchema | String | ConnetionId | Plugin | OUTL-BRT-NMS_OFSC_InstanceIDToBucket | NMS_InstanceID | NMS_ConnectionID |
OFS Activity Event Receive Message OFS Get ActivityDetails Response Message | NMS Update Acticty Request Message (Activity Cancelled/NotDone) | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
notify_POST | Outermosttag | request-wrapper | Outermosttag | updateActivitities | |||||
events.definitions.activityEvent | notify_POST | Group | topLevelArray | Request-Wrapper | Group | ||||
eventType | events.definitions.activityEvent | String | state | topLevelArray | Field | OUTL-BRT-NMS_OFSC_ActivityStatus | OFSC_EventType | NMS_ActivityStatus | |
activityDetails | events.definitions.activityEvent | Group | |||||||
activityId | activityDetails | String | externalId | topLevelArray | Field | ||||
resourceId | activityDetails | String | crewId | topLevelArray | Field | ||||
apptNumber | activityDetails | String | id | topLevelArray | Field | ||||
eventType | events.definitions.activityEvent | String | action | topLevelArray | Field | OUTL-BRT-NMS_OFSC_ActivityStatus | OFSC_EventType | NMS_ActionCode | |
canonical_GETResponse | Outermosttag | ||||||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | |||||||
ConnectivityProperties | |||||||||
Plugin | Connectivity Properties | ||||||||
nms_instanceId | activities.definitions.getActivitySchema | String | ConnetionId | Plugin | OUTL-BRT-NMS_OFSC_InstanceIDToBucket | NMS_InstanceID | NMS_ConnectionID |
OFS Activity Event Receive Message | OFSC Get Resource Type 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 | |
notify_POST | Outermosttag | canonical_GET | Outermosttag | /ofscMetaData/v1/resourceTypes | |||||
events.definitions. activityEvent | notify_POST | Group | Template Parameters | canonical_GET | Group | ||||
activityChanges | events.definitions. activityEvent | Group | |||||||
resourceId | activityChanges | String | resourceId | TemplateParameters | String |
OFS Activity Event Receive Message OFS Get ActivityDetails Response Message | NMS Update Activity Request Message (Activity Moved) | DVM Mapping | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|
Element Name | Parent Element | Type | Element Name | Parent Element | Type | DVM Name | Oracle Field Service Column | Oracle Utilities Network Management System Column | |
notify_POST | Outermosttag | request-wrapper | Outermosttag | updateActivities | |||||
events.definitions.activityEvent | notify_POST | Group | topLevelArray | Request-Wrapper | Group | ||||
activityChanges | events.definitions.activityEvent | Group | |||||||
state | topLevelArray | Field | Map with the variable 'crewStaus' . (**crewStaus is 'DISPATCHED' or 'NO_CREW' depending on the resourceType**) | ||||||
resourceId | activityChanges | String | crewId | topLevelArray | Field | Map resourceId if crewStatus = 'DISPATCHED' | |||
canonical_GETResponse | Outermosttag | ||||||||
activities.definitions.getActivitySchema | canonical_GETResponse | Group | |||||||
activityId | activities.definitions.getActivitySchema | String | externalId | topLevelArray | Field | ||||
apptNumber | activities.definitions.getActivitySchema | String | id | topLevelArray | Field | ||||
activityType | activities.definitions.getActivitySchema | String | type | topLevelArray | Field | ||||
ConnectivityProperties | |||||||||
Plugin | ConnectivityProperties | ||||||||
nms_instanceId | activities.definitions.getActivitySchema | String | ConnectionId | Plugin | OUTL-BRT-NMS_OFSC_InstanceIDToBucket | NMS_InstanceID | NMS_ ConnectionID |