Parameter | Description |
|---|---|
config.enabled | Enable/disable NMS-OFS interface. Default: true |
config.credentials | Absolute path to the file containing user credentials the adapter will use to communicate with Oracle Utilities Network Management System. Either this parameter or both config.username and config.password parameters should be provided. If all are present, then the config.username/config.password pair is used. |
config.username | Valid NMS username, which has the 'NmsService' role in WebLogic Server. |
config.password | NMS user password. Value of this parameter should be encrypted. |
config.nms_url | URL for accessing Oracle Utilities Network Management System. If this parameter is not provided then it is assumed that the adapter is deployed on the same WebLogic server as cesejb.ear. |
mwm.use_rest | Use REST API for sending messages to the Oracle Field Service system. This parameter must be enabled, which is the default setting. |
config.activity_accepted_action | Key of the state transition action, which is executed when activity create/update message is accepted by the Oracle Field Service system. |
config.activity_rejected_action | Key of the state transition action, which is executed when activity create/update message is rejected by the Oracle Field Service system. |
config.default_crew_type | Default crew type. The adapter uses this crew type when it needs to create a mobile crew which does not exist in NMS. This parameter should be set to the name of a valid NMS crew type. If not specified then the adapter will not be able to create crews. |
config.allow_device_ops | Allow the adapter to operate device in NMS model. Default: false |
config.call_send_limit | Maximum number of customer calls (incidents) to be included into an activity create/update message sent by the adapter. Customer calls with higher priority are included ahead of the calls with lower priority. Note: Including large number of calls greatly increases message size. Default: 0 |
mwm.activity_id_prefix | Activity id prefix. Default: NMS- |
mwm.ws_request_timeout | Timeout (in seconds) for the outgoing web service requests. Requests would fail if response is not received before the timeout expires. Default: 30 |
mwm.ack_wait_timeout | Timeout (in seconds) when waiting for acknowledgment of outgoing messages sent asynchronously. Link failure is declared if acknowledgment is not received before the timeout expires. Default 60 |
mwm.url | Default URL of the web service where the adapter should send outgoing messages. |
mwm.url.<operation name> | Operation-specific web service URLs. Allows for the outgoing messages to be send to the different URLs based on the message type (operation). Valid operation names: • PingURL - hearbeat message • CreateUpdateOrder - creating or updating mobile activity • CompleteOrder - completing or canceling mobile activity • Notification - notification message |
mwm.username | Username included in the outgoing messages as part of HTTP Basic authentication. |
mwm.password | Password included in the outgoing messages as part of HTTP Basic authentication. Value of this parameter should be encrypted. |
mwm.failure_limit | If the connection to OFS fails the number of times specified by this parameter within the time window specified by the 'mwm.failure_limit_window' parameter then NMS-OFS adapter will be stopped. Setting the parameter to zero will disable the failure limit functionality. After the adapter is stopped it needs to be restarted manually. Default: 3 |
mwm.failure_limit_window | If the connection to OFS fails the number of times specified by the 'mwm.failure_limit' parameter within the time window (in seconds) specified by this parameter then NMS-OFS adapter will be stopped. Default: 3600 seconds |
Parameter | Description |
|---|---|
msg.started | The adapter has been started. |
msg.stopped | The adapter has been stopped. |
msg.established | Connection to the Oracle Field Service system has been established. |
msg.synchronized | Synchronization sequence has finished. |
msg.failed | Connection to the Oracle Field Service system has failed. |
msg.too_many_failures | The adapter will be stopped due to failure limit. |
msg.activity_rejected | Oracle Field Service returned error in response to a request to create an activity. Note: this alarm is not current being generated. |
msg.event_canceled | Event cancellation has been requested from the Oracle Field Service system but the event cannot be canceled in NMS. |
msg.outage_restored | Outage restoration has been reported from the Oracle Field Service system but the outage cannot be restored in NMS (most likely because outage device cannot be closed). |
msg.outage_confirmed | Outage has been confirmed by the Oracle Field Service system but the outage cannot be confirmed in NMS (outage device cannot be opened). |
Parameter | Description |
|---|---|
query.type.<query type> | Query type. Valid query types: • device_info - device information • customer - customer information • call - customer call information for an event |
query.<query type>.table | Database table or view to query. Not applicable to the "device_info" query type. |
query.<query type>.where | Additional conditions to be included in the query's WHERE clause. |
query.<query type>.order_by | Query's ORDER BY clause (sorting condition). |
query.<query type>.max_results | Maximum number of rows allowed to be returned for this query type. Default: 100 |
query.<query type>.param.<param_name> | Maps query parameter name to a database column name. The following parameters are defined for different query types: • device_info • deviceAlias - device alias • customer • accountNumber -customer account number • call • eventIdx - NMS event index |
query.<query type>.column.<column_name> | Label for the data retrieved for the specified database column. |
Parameter | Description |
|---|---|
config.auth.timeout | OAuth communication timeout (seconds). Default: 30 seconds |
Parameter | Description |
|---|---|
config.auth.token.url | URL for requesting OAuth token to be used for outgoing requests. If this parameter is not specified then basic HTTP authentication will be used in outgoing requests. |
config.auth.token.scope | The scope value used when requesting OAuth token to be used for outgoing requests. |
config.auth.token.user | Username for requesting OAuth token to be used for outgoing requests. |
config.auth.token.pwd | Password for requesting OAuth token to be used for outgoing requests. This parameter should be encrypted in production environments. |
Parameter | Description |
|---|---|
config.auth.jwk | Either URL for requesting token signing certificate from OAuth server or the certificate itself. If this parameter is not specified, then incoming requests with bearer token authentication will be rejected with error 401 (Unauthorized). In production environments it is recommended to configure certificate itself instead of URL. |
config.auth.allow.scope | The scope value used for validating OAuth tokens in incoming requests. It should match one of the scope values in the received token. |
config.auth.allow.user | The username used for validating OAuth tokens in incoming requests. It should match the principal or (if principal not provided) the subject in the received token. |
Rule | Description |
|---|---|
crewFollowOutageDevice | This rule indicates whether or not crews dispatched to an event are automatically relocated if the device location changes. If this rule is enabled, dispatched crews are automatically relocated to the new device when an event moves to a different device in Oracle Utilities Network Management System. Typically, this rule should be enabled when Oracle Utilities Network Management System is integrated with Oracle Field SErvice system. Default: no (disabled) |
mobilePreassignCrew | Allows Oracle Utilities Network Management System user to assign and release mobile crews. Default: no (disabled) |
repredictionCrewReassignment | This rule enables or disables automatic crew reassignment/redispatch when event reprediction occurs in Oracle Utilities Network Management System. For example: Events A, B, and C exist on laterals off of a feeder backbone. Crew 1 is dispatched to event A, crew 2 is dispatched to event B, and crew 3 is assigned to event C. More calls come in on the feeder, eventually causing the system to repredict and group events A, B, and C to an upstream device. The resulting grouped event is called event A. • If this rule is enabled, crew 1 remains dispatched to event A, crew 2 is undispatched from event B and redispatched to event A, and crew 3 is unassigned from event C and reassigned to event A. • If this rule is disabled, crew 1 remains dispatched to event A, crew 2 is only undispatched from event B, and crew 3 is only unassigned from event C. Default: yes (enabled) |
sendToMobileState | This rule specifies the state(s) at which an event is sent to Oracle Field Service. When an event transitions to one of the states defined in this rule, a "send to mobile" flag is set in the event. The Oracle Utilities Network Management System-Oracle Field Service Adapter uses this flag to determine whether an event should be processed by the interface, triggering field order creation in Oracle Field Service. Default: none |
singleCrewPerEvent | This rule indicates whether or not multiple crews can be assigned or dispatched to an event in Oracle Utilities Network Management System. If this rule is enabled, only one crew can be assigned or dispatched to an event at any given time. The repreditionCrewReassignment rule is implicitly disabled if this rule is enabled. Default: no (disabled) |
useGenericAssign | Allows treating of crews with crew key less 1000 as "generic crews". Default: no (disabled) |
useMdt | This rule enables or disables MDT (Mobile Dispatch Terminal) crew flag functionality. This rule should be enabled when the Oracle Utilities Network Management System-Oracle Field Service Adapter is being used. Default: no (disabled) |
Mapping Table | Description |
|---|---|
OMS_MWM_MAPPING_RULES | This table defines the field to be mapped and, for many-to-many mapping, the value to be written to the mapped field if all conditions are met. |
OMS_MWM_MAPPING_CHECKS | This table defines conditions that may be applied to mapping rules. |
OMS_MWM_MAPPING_RULE_CHECKS | This table associates a rule with a condition. Together, this table and the two previous tables are used to define many-to-many data mapping. |
Field | Description |
|---|---|
rule_id | A unique identifier for this rule. |
mapping | The name of the mapping rule set used to group related mapping rules. For example, the mapping rule set 'mwmOrder' defines rules for mapping Oracle Utilities Network Management System event data to the corresponding field order data in Oracle Field Service for outgoing orders. |
mapped_field | The name of the field where the target value (the result of the mapping) should be written. For example, orderType, priority and alarmType are mapped fields. |
mapped_value | This is the value to be written to the mapped field if all conditions defined for this rule are met. This is also referred to as the target value. |
table_id | This field is not used. |
rule_order | The order in which this rule should be applied when a series of rules is being used. The lowest value is used first. |
Field | Description |
|---|---|
check_id | A unique identifier for this condition. |
field_name | The name of the field to which the condition applies. |
cond_str | The condition to be applied. For a description of the condition format, see the next section. |
negate | Indicates whether or not to negate the condition result. If this is set to Y, the result is negated. This field is optional. |
Condition Type | Condition Format | Description |
|---|---|---|
Exact string compare | <string to compare against> | The condition is true if the field value (converted to a string) exactly matches the comparison string. |
Regular expression | @regex <regular expression> | The condition is the true if the field value (converted to a string) matches the given regular expression. |
Class inheritance | @inheritFrom <class name> | The condition is true if the field contains the class name specified in the condition or the name of any child class. |
Field | Description |
|---|---|
rule_id | The key to the mapping rule in the OMS_MWM_MAPPING_RULES table. |
check_id | The key to the condition in the table OMS_MWM_MAPPING_CHECK table. |