Configuration Properties
Below are the lookup properties that can be defaulted in the integration.
Lookup: OUTL-BRT-NMS_OFSC_Email_ID
Property Name
Value
Description
from
nms-ofsc-administrator@yourdomain.com
Specify where the error email will be sent from.
to
mailID@yourdomain.com
Specify where the error email will be sent to.
 
Lookup: OUTL-BRT-NMS_OFSC_ConfigProps
Property Name
Value
Description
ofsc.bucket
OHMeter
Default OFS work bucket that is linked to this NMS instance
source.system
NMS
Used in several integrations to denote where the request is coming or going to.
activities.linktype
related_activity2
Default value.
This value needs to match the label in the OFS Link Templates configuration for second "related activity".
failedEquipment.props
 
No longer used
failedEquipment.enumProps
MANUF_TEXT RATING_UNITS_OM THREE_PH_TOGGLE SINGLE_PH_TOGGLE
Denote what properties require extra processing in OFS to complete the form formats.
failedEquipment.dateProps
 
No longer used
ofs.language
en
Default value of OFSC request for language.
workSkill.sharing.default
summary
Default value
workSkillProperty.type.default
string
Default value
workSkillProperty.entity.default
activity
Default value
workSkillProperty.gui.default
text
Default value
workSkillProperty.nameSuffix.default
needed
Default value
workSkillCond.actvtySameSkillMaxWorker.default
1
Default value
workSkillCond.function.default
in
Default value
activeFlag.default
true
Default value
bucket.timeZone.default
America/New_York
Default timezone in OFS
parentBucket.default
UGBU
Top level OFS bucket
ofsc.controlZone
3
Depth of zones that will be synced and used to assign activities
ofsc.useControlZoneFromNMS
true
Use the NMS provided controlzones for preassigned activities
ofsc.resourceDetail.loopLimit
100
The amount of OFS resource read at once during traversing all resources.
ofsc.workZone.default.NMSncgClass
4802
Default work bucket value in NMS
ofsc.workZone.default.status
active
Default value
ofsc.workZone.default.travelArea
sunrise_enterprise
Default value for a workzone travel area
ofsc.workZone.default.Fuzzy
Type
NO_OUTAGE
NMS value for workzone during admin sync process
failedEquipment.nms.tableName
PICKLIST_INFO_EQ_
FAIL
Failed Equipment schema name in NMS GetAdminData request
nms.crew.outOfRange
false
Default flag during crew updates in NMS
nms.crew.isAvailForOp
true
Default flag during crew updates in NMS
nms.crew.isMobileIntegrated
true
Default flag during crew updates in NMS
notification.chat.assertion
{JWT-Token}
JWT token received from creating assertion and used to request an OFS Access Token
notification.chat.grantType
urn:ietf:params:oauth:grant-type:jwt-bearer
Grant Type used in conjunction with jwt token to request the OFS Access Token
ofsc.resourceType.FieldResource
field_resource
Value of OFS ResourceType used when sending to NMS
notification.type.chat
chat
Notification value for chat
notification.type.email
email
Notification value for email
notification.email.flag
true
Denotes if email notification to be sent if error occur
notification.chat.flag
true
Denotes if chat notification to be sent if error occur
ofsc.isScheduledForPreAssignedCrew
true
Default value
ofsc.setPositionInRoute
notOrdered
Default value
nms.adminSync.EventCategories
true
Process this phase during Admin Sync?
nms.adminSync.EventCategories
true
Process this phase during Admin Sync?
nms.adminSync.Failed
Equipment
true
Process this phase during Admin Sync?
nms.adminSync.Phases
true
Process this phase during Admin Sync?
nms.adminSync.Manufacturers
true
Process this phase during Admin Sync?
nms.adminSync.CrewTypes
true
Process this phase during Admin Sync?
nms.adminSync.ControlZones
true
Process this phase during Admin Sync?
nms.adminSync.WorkZones
true
Process this phase during Admin Sync?
nms.adminSync.CustomerTypes
true
Process this phase during Admin Sync?
nms.adminSync.EventType
Categories
true
Process this phase during Admin Sync?
notification.chat.default
Dispatcher
{ofs default dispatcher} externalID
Default dispatcher that will receive error chats on generic requests
dateTimeFormat.default.OFS
[Y0001]-[M01]-[D01] [H01]:[m01]:[s01]
Default datetime format for OFS
dateTimeFormat.default.NMS
[Y0001]-[M01]-[D01]T[H01]:[m01]:[s01].000Z
Default datetime format for NMS
failedEquipment.oic.Lookup
Name
OUTL-BRT-NMS_OIC_FailedEquipCaching_DND
Name of cached failed equipment lookup, used for performance
eventTypeCategory.oic.Lookup
Name
OUTL-BRT-NMS_OIC_EventTypeCategoryCaching_DND
Name of cached EventTypeCategory lookup, used for performance
findInstance.oic.LookupName
OUTL-BRT-NMS_OFSC_InstanceIDToBucket
Name of DVM to retrieve the NMS instance from an OFS resource
findInstance.oic.LookupSource
ColumnName
OFSC_BucketID
Name of the source column that contains the OFS configured bucket
findInstance.oic.LookupTarget
ColumnName
NMS_ConnectionID
Name of the target column that points to the NMS connection instance
findInstance.oic.LookupNotFoundValue
NotFound
Value if the OFS Resource cannot be found returned by the Find Resource Bucket integration
attachment.nms.limit
10
Number if NMS Operator allowed attachments
attachment.ofs.limit
10
Number if OFS Operator configured attachments
attachment.nms.file.prefix
nms_sourced_attachment_
NMS attachment prefix inside OFS customized fields
operatorComments.eventDetails
Event Details updated [system-generated]
Static operator comment message when OFS forms were triggered
operatorComments.failedEquipment
Failed Equipment updated [system-generated]
Static operator comment message when OFS forms were triggered
 
Lookup: OUTL-BRT-NMS_OFSC_ InstanceIDToBucket
Match the Oracle Utilities Network Management System instance to the Oracle Field Service bucket. Oracle Utilities Network Management System URL and InstanceID are used to send requests to the appropriate Oracle Utilities Network Management System instance. There can be multiple Oracle Utilities Network Management System instance but it has to be 1 Oracle Field Service bucket per 1 Oracle Utilities Network Management System instance.
NMS_InstanceID
OFSC_BucketID
NMS_InstanceURL
NMS_InstanceID
NMS-
OHMeter
URL pointing to NMS instance
OUTL-BRT-NMS1_NMSOFSC
 
Lookup: OUTL-BRT-NMS_OFSC_ActivityStatus
OFSC_EventType
NMS_ActivityStatus
NMS_ActionCode
activityCreated
Initial
CREATE
activityStarted
STARTED
UPDATE
activitySuspended
SUSPENDED
UPDATE
activityNotDone
CANCELLED
UPDATE
activityCompleted
COMPLETE
UPDATE
activityCanceled
CANCELLED
UPDATE
activityUpdated
 
UPDATE
activityMoved
DISPATCHED
UPDATE
activityTravelStarted
EN_ROUTE
UPDATE
activityTravelStopped
DISPATCHED
UPDATE
 
Lookup: OUTL-BRT-NMS_OFSC_ActivityStatusChange
NMS_ActivityEventStatus
NMS-OFSCActivityStatus
OFSC_ActivityStatusNew
STARTED:SUS
 
suspended
SUSPENDED:SUS
 
suspended
 
CANCELLED:started
notdone
 
CANCELLED:enroute
notdone
 
CANCELLED:cancelled
ERROR:Activity already in cancelled status in OFS
 
CANCELLED:notdone
ERROR:Activity already in notdone status in OFS
 
CANCELLED:completed
ERROR:Activity already in completed status in OFS
 
CANCELLED:
ERROR:No matching OFS activity status found
 
CANCELLED:pending
cancelled
 
Lookup: OUTL-BRT-NMS_OFSC_ActivityType
Convert Oracle Utilities Network Management System ActivityType into Oracle Field Service ActivityType value
NMS_ActivityType
OFSC_ActivityType
Description
NMS_Trouble
NMS_Trouble
Default Value