Network Management System Configuration Guide
Audience
Related Documents
Conventions
System Overview
System Overview
User Environments
Isis
Database
Hardware and Third Party Software
Network Architecture
Architecture Guidelines
Overview
Product Dependencies and Locations
Oracle Utilities Network Management System High-Level Conceptual Diagram
Example Hardware/Software Overview
Hardware Sizing
Standard Product Implementation
Overview
Software Release Level
Installation
Interfaces
Modeling and GIS Integration
GIS Model Extractor
Standard Preprocessor
Device Types and Attributes
Software Configuration Dependencies On Device Types
Operations Modules Software Configuration
Overview
Web Workspace
Web Trouble
Web Call Entry
Web Callbacks
Web Switching Management
Power Flow
Fault Location Analysis (FLA)
Fault Location, Isolation, and Service Restoration (FLISR)
Feeder Load Management (FLM)
Suggested Switching
Optimization
Load Shed and Restoration
SCADA Extensions
Service Alert
Storm Management
Isis Configuration
Isis Terminology
Isis Architecture
Isis Directory Structure
run_isis
Isis Configuration Files
sites File
isis.rc Startup File
Isis Environment Variables
ISISPORT and ISISREMOTE
ISIS_PARAMETERS
Isis Standalone Mode
Isis Multi-Environment Considerations
Isis Log Files
isis.[date].[time].log
[Site No.].logdir
The Protos Log
The Incarn Log
Starting Isis
nms-isis
Initializing Isis
Stopping Isis
Starting Isis on Non-Default Ports
The cmd Tool
Exiting cmd
Troubleshooting
Generating an Isis Dump File
Generating an Isis Dump File for All Applications
Reporting a Problem to Customer Support
Information Lifecycle Management
Prerequisite
History Tables
Database Configuration
Oracle Installation Guidelines
Oracle Tablespaces
Oracle Instances
Other Environment Variables
Oracle Users
Security Roles
Users
Starting Oracle
Environment Configuration
CES_PARAMETERS
CES_PARAMETERS Schema
Site-specific Parameters
Environment-Specific Parameters
NMS_PARAMETERS_VIEW
Encrypting Configuration Parameters
Encrypting Passwords with Oracle WebLogic Server Utility
The System Resource File
Modifying Environment Variables
nms-env-config
Environment Variables
Dual-Environment Configuration
Services Configuration
Services Overview
SMService - System Monitor Service
DBService - Database Service
ODService - Object Directory Service
DDService - Dynamic Data Service
MTService - Managed Topology Service
JMService - Job Management Service
TCDBService - Trouble Call Database Service
MBService - Model Build Service
SwService - Switching Service
MBDBService - Model Build Database Service
MQDBService - MQService Gateway DBService
Power Flow Services
CORBA Gateway Service
Service Alert Service
Service Alert Email Administration
How Service Alert Email and Paging Notification Work
Entering Email/Pager Configuration Settings
Email Subject Line Configuration
Service Alert Script Configuration
Services Configuration File
Scripts
Server
Parallel Start
Service
Program
displayName
Instance
Model Build System Data File
Starting and Stopping Services
Starting Services
Stopping Services
Starting and Stopping the WebLogic Managed Server
Building the System Data Model
Model Builder Overview
Patches
Data Directories
OPERATIONS_MODELS Directory
Model Configuration
Define Environment Variables
Configure Isis
Verify Database Connection
Directory Set Up
Define and Organize Classes
Configure Attribute Table
Configure Control Zones
Configure Symbology
Service Configuration File
Verify Licensed Products File
Run Automated Setup
Linking In Customers
Customer Model - Logical Data Model
Residential Model
Commercial and Industrial (C & I) Model
Customer Model Database Schemas
Customer Model Database Tables
Customers Table
Service Locations Table
Meters Table
Account Type Table
Service Points Table
DERs Table
Linkages to Other Tables
Customer Model Views
CES Customers View
Customer Sum View
Model Build Process
Model Build with a Preprocessor
Model Build with a Post-Processor
The Model Build Preprocessor
Model Build Basics
Model Preprocessor
Format for the Explosion Definition File
Example of Cell Definitions
Model Build Workbooks
Model Build Process for Work Orders
Power Flow Engineering Data Workbook
Load Shed and Restoration
Model Manipulation Applications and Scripts
DBCleanup
nms‑delete‑map
nms‑delete‑object
nms‑delete‑patch
AuditLog
Schematics
Model Requirements for Schematics
Schematic Limitations
Configuring Schematics
Schematic-Specific Symbology
Generating Schematics
The Post-Build Process
Creating the Import Files
Processing the Import Files
Aggregate Devices
Model Requirements for Aggregate Devices
In Construction Pending / Device Decommissioning (ICP)
Device Lifecycles
Model Requirements for ICP
Model Builds and Commissioned/Decommissioned Devices
Effect of ICP Devices on Network Topology
ICP Device Symbology
Troubleshooting Issues with ICP Device Symbology
Auto Throw-Over Switch Configuration (ATO)
Model Requirements for ATOs
Summary Object Configuration
Adding Latitude and Longitude Attributes to Objects in the Model Build Process
Coordinate Systems
Geographic Coordinate System
Quasi-Geographic Coordinate System
Internal World Coordinate Systems
Overview Schematic Coordinate Systems
One Line Schematic Coordinate Systems
Latitude and Longitude Coordinate Systems
Symbology
Firm Symbols
Hard Symbols
1D Width Multiplier
Soft Symbol Definitions
Device Symbols
Pixmap Symbols
SVG Symbols
SVG Master Symbol Process
Converting SYM Files to SVG
SVG Performance Tool
Updating Symbology
Symbology Mapping
Consolidating Symbols
DMS Data Model Requirements and Configuration
Data Import and Build Process
kVA Solutions
Modeling Device Data
Sources
Line Impedances
Transformers and Regulators
Distributed Generation
Capacitors and Reactors
Switch Ratings
Modeling Loads
DER and the Weather Zone Forecast
Seasonal and Temperature Limits
Bellwether Meter Voltages
Viewing Power Flow Attributes
Power Flow Services High Level Messages and Command Line Options
Power Flow Services High Level Messages
Power Flow Service Command Line Options
Spatially Enabling the Data Model for Outage Analytics
NMS CIM Import and Export Tools
CIM Import
CIM Export
Preparing the NMS Model for Oracle Utilities Customer Self Service
Materialized Views
Adding Outage Summary Spatial Landbase to the NMS Viewer
Model Build File Export to XML
MB Export to XML
Schematic Data Export to XML
Database Maintenance
Oracle Configuration
Indexes
Generating Statistics
Make Tablespaces Locally Managed
Block Size
Compatibility
Site Guard
Prerequisites
Site Installation and Configuration
Custom Scripts
Custom Scripts for Database Server
Custom Scripts for NMS server
Other Custom Scripts
Configuring Custom Scripts
Operation Plans
Start Operation
Stop Operation
Switchover Operation
Failover Operation
Failover Patching Operation
Additional NMS Configuration
Read Only Mode
Syncing Operations Model
nms-wls-config
nms-update-site
High Availability Configuration
Overview
NMS Agent
NMS Monitor
CESEJB, NMS-WS
WebLogic Server
Database Server
EMCLI
Site Guard
ZooKeeper
Architectural Overview
Components at One NMS Site
Components at Three Sites
Recommended Configuration Order
EM CLI Standard
Download
Installation
Setup
Configuring NMS Monitor
ZooKeeper
Keystore Creation
Export the Certificate
Creating the Truststores
Environment
ZooKeeper Configuration File
Node Id
ZooKeeper Data Directory
Starting and Stopping the Node
NMS Monitor
Overview
Configuration
Setting the Domain Environment
Configuration Tool Main Page
Configure ZooKeeper
Configure Datasource
Configure emcli
Keystore Actions
Truststore Actions
Credentials
Creating the NMS Monitor Server
NMS CESEJB Self-Signed Certificates
NMS Agent
NMS Agent Overview
Configuration
Configuration Tool Main Page
Configure Server
Keystore Actions
Truststore Actions
Generate Service Script
The nmsagent Directory
NMS Monitor Web Application
Launching NMS Monitor and Logging In
NMS Monitor Common Elements
NMS Site Status Screen
Possible Status Values
Status Messages
Initiate Operation Plan
Configuration Page
Monitoring Details
Monitoring Data Sources
Component Details
Site Statuses
Automatic Failover
Troubleshooting and Support
Troubleshooting an Issue
Evaluating System Status
Examining Log Files
Examining Core Files
Identifying Memory Leaks with monitor‑ps‑sizes
Validating the WebLogic Caches with NMS Services
Monitoring EclipseLink Related Database Transactions
Logging Options
Performance Testing
Other Troubleshooting Utilities
Oracle Support Information
Support Knowledgebase
Contacting Oracle Support
NMS Data Quality
Setting Up NMS for Oracle Utilities Analytics
User Authentication
Overview of Authentication
Oracle NMS Configuration Guidelines for Multiple WebLogic Managed Servers
NMS Java End User Authentication
NMS OMA/Flex End User Authentication
Configuring the WebLogic Security Realm
Configuring Authentication Using WebLogic Internal Users/Groups
Configuring Authentication Using an Active Directory Provider
Configuring Authentication Using an OpenLDAP Provider
Two‑Factor Authentication
Fault Location, Isolation, and Service Restoration Administration
Introduction
Fault Location, Isolation, and Service Restoration Timeline
Software Architecture Overview
Configuring Classes and Inheritance
Single Phase FLISR Operation
Restoring Substation Bus on Voltage Loss
Modeling Information
SRS Rules
High Level Messages
Troubleshooting
Distribution Management Application Configuration
Configuring Power Flow
Power Flow Services
Non-Converged Islands
Power Flow Inheritance
Power Flow Rules
Feeder Load Management History and Accuracy
Java Application Configuration
Understanding the NMS Java Application Configuration Process
Understanding NMS Java Application Configuration Files
Understanding the Process for Building and Deploying Custom Configuration
Testing the Java Client Configuration
JBot Application Configuration
JBot Configuration Overview
Understanding the JBot XML Schema and XML Files
GUI Configuration
Advanced Configuration Options
Adding Docking Container to Another Tool
JBot DataStore Reference
NMS JBot Tool Configuration
User Permissions
User Type Configuration
Login Tool Configuration
Client Inactivity Timeouts
Master Window Configuration (Oracle Fusion Client Platform)
Java Web Start Page
Table Export Configuration
Work Agenda Configuration
Alarms and Devices Configuration
Crew Actions Configuration
Event Details Configuration
Update Events Configuration
Trouble Summary Configuration
Viewer Configuration
Trending Graphs Configuration
Feeder Load Management Configuration
Model Management Application Configuration
DMS Summary Tool Configuration Guide
Right-To-Left Language Configuration
Customizing Applications
Customization Examples using the Demo Tool
Creating Custom Functions for Displaying Data
Using Additional Libraries
Invoking Commands from an External System
Invoking Commands Using a Web Service
Communicating with Other Programs Using Named Pipes
Messages Available Using the OSI SCADA Adapter
Messages from SCADA to NMS
Messages from NMS to SCADA
JBotCommand Methods Reference
JMService Configuration
Trouble Code Configuration
SRS_TROUBLE_CODES Schema
Configuration
SRS Clues and Priorities
Understanding Clues
The Total Priority of a Trouble Call
The Priority of a Trouble Call
The Total Priority of an Event
The Condition Status of a Trouble Call
Understanding Priority Calls
Call Quality Configuration
Schema
Set Types
Generic Event Fields
Configure Generic Fields
Modify JOBS Table
Add Columns to Work Agenda
Weighted Customer Count
Introduction
Configuration
Appointments
Appointment Types
Dispatch Groups Configuration
Tables
Damage Assessment Configuration
Schema
DAMAGE_REPAIR_TIMES
Repair Times
Default Work Queue
Examples
Damaged Asset Status Options
Example
Damaged Asset Condition Options
Example
'Road Blocked' Damaged Asset Type
Control Tool Configuration
Overview
Control Tool Configuration
Control Tool Database Table Configuration
The Control.xml File
Project_Control_Actions.inc Include File
Using the Control Config Generator
Configuration Example: Adding an Undo Close Action
Control Tool Options in the Viewer Context Menu
Updating Control Tool Configuration in Production Systems
Adding New Device Classes
Mapping Existing Actions to Existing Device Classes
Adding New Actions
Changing When Actions are Enabled
Aggregate, Secondary, or Associated Devices
Customer Counts Lists in the Look Ahead
Configurable Device Lists in the Look Ahead
Web Switching Management Configuration
Configuring Classes and Inheritance
Database Data Tables
Database Configuration Tables
Configuring Project-Specific Columns
Web Switching/Web Safety Crew Columns
Global Web Switching Parameters
SwmanParameters.properties
Note Concerning Control Action Descriptions
GUI Configuration Overview
Web Switching
Web Safety
Switching Sheets
Automated Emails
Sheet Types
State Transitions
Sheet Data Fields
Open Switching Sheet List
New Switching Sheet List
Search Switching Sheet
Device to Sheet Operation List
Model Verification
Default Crews
Versioning
Overlaps
External Documents
Generate Isolation Steps
Generic Tables
Switching Steps
Manual Step Addition
State Transitions
Control Tool Actions
Step Columns
SCADA Auto-Transitioning
View Areas
Toggling Study Mode
Step Order Execution Rules
Instructed Actions
Configuring the Sensitivity of Step Execution Buttons
Switching Sheet Email Attachment Configuration
Automatic Crew Population Option for Steps
Web Safety
State Transitions
Safety Document Data Fields
Search Safety Document
Configuring Stand Alone Safety Documents
High Level Messages
SwService
Web Switching and Web Safety
Troubleshooting
Summary of Java Action Commands
Flex SCADA
WebLogic Configuration
Creating a JMS Message Queue
Creating a JMS Connection Factory
NMS Services
CES Parameters
SRS Rules
NMS Training Simulator Configuration
Environment Configuration
Power Flow Emulator Configuration
EMService High Level Messages
JBot Configuration
General User Environment
Switching
Control Tool
SRS Rules
NMS Flex Operations Configuration
User Type Configuration
User Permissions Configuration
Overriding Configuration and NLS
Recommended Tools
Overriding Configuration
Diagnostic Features
Converting Product Configuration to JSON Overrides
Functions
Calling functions.js functions from within functions.js:
Knockout Observables
Find and Update or Replace Configuration Items
Basic Configuration Overriding
Merging or Replacing Array/Object Content
Custom Syntax
Overriding NLS
Common Terms/Concepts
Note on Grammar Issues
Layout Configuration
Overriding UI Element Options
Custom Fields
Enabled/Visible Configuration
Other Uses for Expressions
Checking Permissions
Oracle BI Publisher Reports Configuration
CES_PARAMETERS Configuration for BI Publisher Reports
Installing the Oracle BI Publisher Report Packages
Installation
Altering and/or Translating the Reports
Adding XLIFF translation file
Updating the Sub-Template and Template Files
Updating the Report Template File
Changing Date Formats
Contents of the WebSwitching Folder
Contents of the WebSwitchingImpactedCustomers Folder
Contents of the WorkAgenda Folder
Building Custom Applications
Overview
Prerequisites
Compiling C++ Code Using the Software Development Kit
Building Sample AMR and AVL Adapter
Build Instructions
Deployment
OMS for Water
Command Line Options and High Level Messages
Command Line Options
Command-Line Options Valid For All Services
DBService
DDService
JMService
MBService
MTService
ODService
High Level Messages
Action Commands Supported By All Services
DBService
DDService
JMService
MBService
MTService
ODService
Model Edit Configuration
Network Management System Configuration Guide
Oracle Utilities Network Management System Configuration Guide, Release 2.6.0.0.2