Network Management System Adapters Guide
Audience
Related Documents
Conventions
Generic IVR Adapter
Introduction
Supported Application Data Flows
Understanding IVR Data Flows
Understanding CIS Data Flows
Understanding Callbacks Application Data Flows
Interaction Diagram
Data Flow Details
Overview
Trouble Calls
Callback Requests
Callback Request Notes
Callback Responses
Adapter Installation
Ensure that the Generic IVR Adapter is installed.
Setting Up the Generic IVR Adapter System Variables
Configure Adapter to run as NMS System Service
IVRAdapter Command Line Options
Loading the Generic IVR Adapter Database Tables and Stored Procedures
Software Configuration
Overview
Trouble Call Mapping Configuration
Mapping to Customer-Defined Fields in the INCIDENTS Table
Updating Existing Calls
Trouble Callback Mapping Configuration
Time Zone Configuration
SRS Rules Configuration
Map Customer-Defined Fields in the INCIDENTS Table
callbackInterfaceEnabled SRS Rule
useExternalCause SRS Rule
customerPhoneParentheses SRS Rule
defaultCallbackAgent SRS Rule
callbackFeederTimeout SRS Rule
streetXsectionOffset SRS Rule
Generic IVR Adapter Trouble Call Performance
Generic IVR Adapter Troubleshooting
Understanding the Database Schema
Overview
Database Table Schema
Stored Procedure Parameters
SRSInput Testing Utility Command Line Options
Terminology
Smallworld GIS Adapter Template
ESRI ArcGIS Adapter
Adapter Overview
Adapter Documentation
Intergraph G/Electric Adapter
Adapter Overview
Adapter Documentation
Generic IBM MQ Mobile Adapter
Introduction
Overview Description
Terminology
Functional Description
Functional Requirements
Hardware and Software Requirements
Required Installed Software
Adapter Installation
Overview
Configure Queues for Required Data Flows
Design Overview
Configuration Concepts
Integration with System Services
Aggregation of Objects
Information Flows
Performance
High Level Messages
Information Models
Configuration
DML Files
Configuration Tables
Run Time Errors
DML Examples
DML Reference
Lexical Conventions
Basic Concepts
Order of Document Processing and Other Considerations
Ordering of Incidents in the Incident Object
DML Function Calls
List of Functions
Event Object Fields
Incident Object Fields
Permanent Order Object Fields
Permanent Relationship Object Fields
SCADA Measurements
Introduction to scadapop
Configuration
RDBMS Configuration
Recaching Measurements
Information Model
Database Schema
Generic SCADA Adapter
Introduction
Generic SCADA Adapter Configuration
RDBMS vs. File Mode
Configure Adapter to Run as an NMS System Service
SRS_RULES Configuration for Generic SCADA Adapter
Command Line Options for Generic SCADA Adapter
Scripts Used by the Generic SCADA Adapter
CES_PARAMETERS Configuration
Measurement Configuration
Using SCADAPOP
RDBMS Configuration
Configuration/Execution Sequence
File-Based (RTAdapter)
SCADA Data - File Input
RDBMS Table Polling (RTDBAdapter)
Information Model
Database Schema
External Access Schema
MultiSpeak Integration
Live Energy Connect Integration
Troubleshooting
DataRaker Integration
Use Cases
ICCP Adapter
ICCP Adapter Overview
ICCP Blocks
Live Energy Connect ICCP Adapter Configuration
Configuring the Adapter to Run as a System Service
Populating the NMS Measurements Tables
Information Model - Database Schema
Populating the NMS Measurements Tables
Information Model - Database Schema
Specific SCADA Adapters
OSI SCADA Adapter
General Configuration Parameters
Point List Configuration
Real-Time States/Values
Tags
Controls
Simulation
Navigation
SCADA Calculation Engine
Introduction
SCADA Calculation Engine Database Configuration
Examples
SCADA Calculation Engine SRS Rules Configuration
MultiSpeak Adapter
Introduction
Installation
Installation Overview
Adapter Installation Instructions for Oracle WebLogic Server
JMS Transport Mechanism
Software Configuration
Support for Encrypted Configuration Parameters
AMR Configuration Parameters
Overriding Configuration Parameters
Storing Meter Readings in AMR_RESPONSES Table
AVL Configuration Parameters
Credentials Files
Oracle Utilities Network Management System Configuration Rules
Adapter Interface Communication Overview
Adapter Design
Supported Data Flows
AMR Business Processes
Database Schema
AMR_REQUESTS
AMR_RESPONSES
AMR_CU_METERS
AMR_CU_METERS_HISTORY
AMR_VOLTAGE_HISTORY
SCADA Component
Supported Data Flows
NMS to SCADA
SCADA to NMS
Software Configuration
CES_PARAMETERS
Plugin Support
Methods
Building Custom SCADA Plug-ins
High-Level Messages
SCADA
Troubleshooting
Security Best Practices
Oracle Field Service Adapter
Introduction
Installation
Adapter Installation Instructions for Oracle WebLogic Server
Database Schema
OMS_MWM_EVENTS
OMS_MWM_ACTIVITIES
OMS_MWM_ALARMS
OMS_MWM_CREW_ACTIONS
Supported Data Flows
Outgoing Flows
Incoming Flows
Software Configuration
Support for Encrypted Configuration Parameters
Configuration Parameters
Oracle Utilities Network Management System Configuration Rules
High-Level Messages
Troubleshooting
SOAP Web Services
Authentication
Trouble Management Web Service
Port TroubleServiceSOAP
Switching and Safety Web Service
Port SwmanServiceBeanPort
Port SwmanServiceDocBeanPort
Damage Assessment Web Service
Port DamageServiceSOAP
REST API
Authentication
Resources
POST /dmg‑rest/event‑update/{event}
GET /dmg-rest/reports
POST /dmg-rest/reports
GET /dmg-rest/reports/config/{cfg}
GET /dmg-rest/reports/{id}
POST /dmg-rest/reports/{id}
GET /dmg-rest/reports/{id}/attachments/{att_id}
PUT /dmg-rest/reports/{id}/attachments/{att_id}
DELETE /dmg-rest/reports/{id}/attachments/{att_id}
GET /dmg-rest/reports/required-parts
GET /mobile/application/{name}/{arch}
GET /mobile/application/{name}/{arch}/{version}
GET /mobile/application-version/{name}/{arch}
GET /mobile/application-versions/{name}/{arch}
GET /mobile/attachments/{report-type}/{report-id}/{attachment-id}
PUT /mobile/attachments/{report-type}/{report-id}/{attachment-id}
DELETE /mobile/attachments/{report-type}/{report-id}/{attachment-id}
POST /mobile/condition/{class}
GET /mobile/condition/{class}/{id}
DELETE /mobile/condition/{class}/{id}
PUT /mobile/condition/{class}/{id}/{status}
PUT /mobile/condition/{class}/{id}/text/{text}
GET /mobile/conditions
GET /mobile/conditions/{class}
GET /mobile/conditions/device/{handle}
PUT /mobile/confirm-services
GET /mobile/confirm-services/{handle}
GET /mobile/control-zones
GET /mobile/create-new-account
POST /mobile/crew
GET /mobile/crews
GET /mobile/crews/{id}
GET /mobile/crews/{id}/assignments
POST /mobile/crews/{id}/assignments/{event-id}/assign
POST /mobile/crews/{id}/assignments/{event-id}/dispatch
POST /mobile/crews/{id}/assignments/{event-id}/onsite
POST /mobile/crews/{id}/assignments/{event-id}/unassign
POST /mobile/crews/{id}/assignments/{event-id}/undispatch
POST /mobile/crews/{id}/assignments/{event-id}/undispatch-and-assign
POST /mobile/crews/{id}/assignments/{event-id}/undispatch-and-assign-and-dispatch/{new-event-id}
GET /mobile/crews/{id}/availability
POST /mobile/crews/{id}/availability
GET /mobile/crews/{id}/status
POST /mobile/crews/{id}/status
GET /mobile/crews/user
GET /mobile/crew-types
GET /mobile/damage-device-details
GET /mobile/dataset/{table}
PUT /mobile/dataset/{table}
PUT /mobile/device/assess
POST /mobile/device/{handle}/trace
GET /mobile/device/{id}/info
GET /mobile/device/{handle}/last_known_location
GET /mobile/device/{id}/lookahead/{operation}/{phases}
GET /mobile/device/{id}/operate/{operation}/phases/{phases}/time/{time}
PUT /mobile/device/unassess
GET /mobile/devices
GET /mobile/feeders
GET /mobile/file/:dir_name /:file_name
GET /mobile/get-permissions
GET /mobile/geographic‑partitions
POST /mobile/hlm
GET /mobile/device/{id}/customers
GET /mobile/{id}/customer-summary
GET /mobile/lookup-types/{table}/{keyField}/{valueField}
GET /mobile/maps
GET /mobile/maps/{mapname}
GET /mobile/messages-partition-changes/{sub-id}
POST /mobile/mobile-user-logout
GET /mobile/mobile-user-validation
POST /mobile/partition/statuses
GET /mobile/nms-status
GET /mobile/set-current-crew/{id}
GET /mobile/subscribe-partition-changes
GET /mobile/switch-sheets/assignments/{crew-key}
GET /mobile/switch-sheet/{sheet-cls}/{sheet-idx}
PUT /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/document
GET /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/document/{document-id}
GET /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/report
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/steps/{step-cls}/{step-idx}
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/steps/{step-cls}/{step-idx}/details
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/steps/{step-cls}/{step-idx}/location
POST /mobile/switch-sheets/{sheet-cls}/{sheet-idx}/transition
GET /mobile/unsubscribe-partition-changes/{sub-id}
PUT /mobile/user-profile/{field-name}/{value}
GET /mobile/version
GET /trbl-rest/config/{cfg}
PUT /trbl-rest/event/{id}/confirm-outage
POST /trbl-rest/event/{id}/confirm-pso
POST /trbl-rest/event/{id}/log
POST /trbl-rest/event/{id}/log-once
PUT /trbl-rest/event/{id}/release-all
POST /trbl-rest/event/{id}/state-transition
POST /trbl-rest/events/all-events
GET /trbl-rest/events/{id}
POST /trbl-rest/events/{id}
POST /trbl-rest/events/{id}/associate
GET /trbl-rest/events/{id}/customers
PUT /trbl-rest/events/{id}/trouble-queue
POST /trbl-rest/user-log
POST /trbl-rest/user-log-once
Weather Data Adapter
Adapter Overview
Data Import Formats
Flat CSV Files
External Database Table
NOAA Weather Service
Running the Adapter
Related Runtime and Configuration Tables
DERMS Adapter
Overview
Configuration
PF_DERMS_ADAPTER_CONFIG
Running the Adapter
Database Tables
Log Files
Profile Adapter
Adapter Overview
PV Profile Creation
Load Profile Creation
SRS Rule Configuration
Running the Adapter
Load Profile File Format
Error Handling
Switching Adapter
Introduction
Installation
Installation Overview
Adapter Installation Instructions for Oracle WebLogic Server
Click Finish to complete the installation.
Adapter Software Configuration
Support for Encrypted Configuration Parameters
Configuration Parameters
Related NMS Configuration Rules
SwmanUserText_en_US.properties
JBot Commands
Database Schema
SWMAN_INTERFACE_UPDATES
SWMAN_INTERFACE_DOCUMENTS
Troubleshooting
Web Switching and Web Safety Notifications
Web Switching
Web Safety
Java MDB Implementation
ODIN Adapter
Introduction
Installation
Adapter Installation Instructions for Oracle WebLogic Server
Database Schema
CUSTOMERS_SERVED
CURRENT_AFFECTED_CUSTOMERS
GEOGRAPHIC_OUTAGES
GEOGRAPHIC_OUTAGE_AREAS
Supported Data Flows
Outgoing Flows
Software Configuration
Support for Encrypted Configuration Parameters
Configuration Parameters
Implementation
Common Steps
Steps If Publishing to the ODIN Website
Steps If Publishing to the Oracle Utilities Digital Self Service (DSS) Outage Map
Limitations
Troubleshooting
Network Management System Adapters Guide
Oracle Utilities Network Management System Release 2.5.0.2.5 Adapters Guide