Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility

1 Using Design Studio to Extend Network Integrity

• Installing Design Studio
  • Configuring Design Studio for Network Integrity
    • Configuring Network Integrity Preferences
    • Network Integrity Cartridge Dependencies
    • Configuring Data Dictionary Preference Settings
• About Design Studio Perspectives
• About Design Studio Views
  • Studio Design Perspective Views
  • Java Perspective Views

2 Working With Cartridges

• About Cartridges
• About Cartridges and Design Studio
• About the Cartridge Architecture
• Building and Packaging Cartridges
  • About the Project Build Order
  • About Build Artifacts
  • Packaging Cartridges
• Deploying and Undeploying Cartridges
  • Creating a Design Studio Environment Project
    • Creating a Design Studio Environment for Network Integrity
  • Deploying and Undeploying Cartridges
    • Undeploying a Cartridge
    • Redeploying a Cartridge
• Debugging and Testing Cartridges
  • Starting the Web Logic Server in Test Mode
  • Configuring Remote Debugger in Design Studio
• Sealing and Unsealing Cartridges
• Exporting and Importing Cartridges
  • Exporting a Cartridge With Source Code
  • Exporting a Cartridge Without Source Code
    • Modifying the Classpath
    • Exporting the Cartridge

3 Working with Actions

• About Actions
  • Actions and Processors
• About Actions within Actions
• Generated Action MDB and Controller
• About Conditions in Actions
• About Model Collections in Actions
• About For Each Processors

4 Working with Processors

• About Processors
• Creating Processors
  • Modeling Data
• About Context Parameters
  • Specifying Context Parameters before Creating Implementation Class
• About Properties and Property Groups
• About Generated Code
  • About the Location for Generated Code
  • About the Processor Interface
  • About the PropertyGroup and Properties Classes
• About Processor Implementation
• About the Processor Finalizer
  • ProcessorFinalizer
  • About Memory Considerations

5 Working with Discovery Actions and Processors

• About Discovery Actions and Processors
  • About Supported Processors
• About Address Handlers
• About Result Categories
• About the Discovery Action in the Network Integrity UI
• About Discovery Action Scan Parameter Groups
• Implementing a Discovery Processor
• Implementation Code Sample

6 Working with SNMP Processors

• Implementing the SNMP Processor
  • About the Generated Implementation and XML Beans
• Supporting New MIBs

7 Working with Import Actions and Processors

• About Import Actions and Processors
• Implementing an Import Processor

8 Working with Assimilation Actions and Processors

• About Assimilation Actions and Processors
• Implementing Assimilation Processors

9 Introduction to Discrepancies

• About Discrepancies
  • About the Compare and Reference Sides
  • About Discrepancy Types
    • Attribute Value Mismatch
    • Extra Entity and Missing Entity
    • Extra Association and Missing Association
    • Ordering Error and Association Ordering Error
  • About Discrepancy Status
  • About Discrepancy Detail

10 Working with Discrepancy Detection Actions and Processors

• Discrepancy Detection Action
  • About Discrepancy Detection
  • About Result Sources
  • About Result Source and Scan Types
  • Generated Action MDB and Controller
• About Discrepancy Detection Processors
  • Discrepancy Detection Processor Patterns
    • Reusing the Base Detect Discrepancy Action
    • About the Base Detection Cartridge and the Default Comparison Algorithm
    • Adding New Filters and Handlers
    • About Filters
    • About Handlers
    • Filters and CimType
    • Filter and Handler Examples
      • Using Attribute Filter and Handler (Static Attribute)
      • Using Attribute Filter and Handler (Characteristic)
      • Using Relationship Filter and Handler
      • Using Discrepancy Filter and Handler
      • Using Root Entity Filter and Handler
    • Adding Post-Processors

11 Working with Discrepancy Resolution Actions and Processors

• About Discrepancy Resolution Actions and Processors
• About the Resolution Action Label
• About Result Sources
• Generated Action MDB and Controller
• About Discrepancy Resolution Processors
  • Creating a Discrepancy Resolution Processor
  • Implementing a Discrepancy Resolution Processor
    • About the Implementation Interface
    • About Input Parameters for the Invoke() Method
    • Return Type of Invoke()
  • About the General Flow of the Discrepancy Resolution Processor
  • Fetching Discrepancies
  • Grouping Discrepancies
  • Handling Discrepancies
  • Reporting the Resolution Result
  • Handling Discrepancies Asynchronously

12 Working with Address Handlers

• About Address Handlers
• About the Address_Handlers Cartridge
• Implementing Address Handlers
  • About the Address Handler Interface
  • About Dynamic Address Handlers
    • Validating the Address Handler
    • Expanding Address Handlers
    • Testing the Dynamic Address Handler

13 Working with Result Categories

• About Result Categories
  • About Result Categories in Network Integrity

14 Model Extension Using Specifications

• Overview
• Working with Specifications
• Model Collections
• Specification Helpers

15 POMS SDK

• About POMS
• Working with POMS Entities
• Working with POMS Relationships
  • One-to-one Relationships
  • One-to-Many or Many-to-Many Relationships
  • Ordered and Unordered Relationships
  • Bi-directional Relationships
  • Relationship Entities
• Working with Specifications and Characteristics
• Working with the POMS Finder
  • Find by Entity
  • Find by JPQL
  • Find with Paged Results
  • POMS SDK Interfaces
• About Persist Results

16 Working with Scan Parameter Groups

• About Scan Parameter Groups
• Extending the Create Scan Page
• Extending the Scan Details Page

17 Setting Conditions in Network Integrity

• About Conditions
  • About Generated Classes and the Implementation Class
  • Adding Dependent Actions with Conditions as Processors
  • Creating Condition Examples

18 Extensibility SDK

• About Extensibility Scenarios
• Extending MIB II SNMP Discovery for Updated Vendor and Interface Type
• Extending the Existing Cartridge to Discover and Reconcile New Characteristics
• Extending the MIB II SNMP Discovery to Change Interface Name Value
• Multiple Vendor SNMP Discovery
• Multiple Protocol Discoveries

19 Design Studio Source Control

• Working with Source Control

20 Web Service API

• Web Service Overview
• Security
• Model Based
• Concurrency With UI and other Web Service Clients
• All Operations
• Create, Read, Update, Delete Pattern
• Create Operation
  • Entity Type Support
• Get Operation
  • Entity Type Support
• Get All Operation
• Delete Operation
  • Entity Type Support
• Update Operation
  • Entity Type Support
• Find Operation
  • From and To Range
  • Ascending & Descending
  • Attribute Criteria
  • Multiple Attribute Criteria
  • Extended Attribute Criteria
  • Criteria Operators
    • DisConfig
    • DisScanRun
    • DisDiscrepancy
  • Between/Not Between Operator
  • Date Criteria
  • Conjunction Criteria
  • Find Response
• Special Function Operations
  • Start Scan
  • Stop Scan
  • Get Latest Scan Status
  • Submit Discrepancies For Resolution Processing
• High Level Scenarios
  • Creating a Scan
  • Starting, Stopping, and Monitoring a Scan
  • Retrieving Scan Results/Data
  • Working with Discrepancies
• Network Integrity Web Service Samples
  • Contents of the Network Integrity Web Service Samples ZIP File
  • Sample Java Client
  • Sample Soap UI Project
    • Submitting Request to the Server
    • Specifying User Name and Password in Request

21 Working with Scan Run Complete Notification

• About Clients for Monitoring Scan Run Complete Notification Messages

22 Tips and Tricks

• Compile or Build Problems
  • About Java Errors in the Generated Controller Class
  • Renaming or Deleting Actions and Processors
  • Adding External Libraries to a Java Build Path
  • About “Missing Required Library” Errors for External Libraries
  • Error Marker on Cartridge but not on any Entities

23 Network Integrity Plug-in Validation Error Messages

• Error Message Classifications and Conditions
• Design Studio Logging

24 JCA Resource Adapters

• About Resource Adapters
  • Understanding JCA Resource Adapter Connectivity Options
  • Understanding JCA Resource Adapters with Network Integrity
• About Productized SNMP JCA Resource Adapter
  • Installing the SNMP JCA Resource Adapter
    • Extending the SNMP JCA Resource Adapter
    • Record and Playback Mode
    • Invoking the SNMP JCA Resource Adapter in a Network Integrity Cartridge
• About Third Party or Customized JCA Resource Adapters
  • Building a JCA Resource Adapter in WebLogic
  • Invoking a Third Party or Customized JCA Resource Adapter

25 Network Integrity Reports Extensibility

• About BI Publisher
  • About BI Publisher Desktop
• Reports Provided with Network Integrity
  • Scan History Report
  • Discovery Scan Summary Report
  • Device Discrepancy Detection Summary Report
  • Device Discrepancy Detection Detail Report
  • Discrepancy Corrective Action Report
• Network Integrity Report Building Blocks
  • RTF Templates
  • Report Definition Files
    • Data Source Query Tools
    • Parameters
    • List of Values
    • Rendering Options
    • Report Properties
• Developing BI Publisher Reports
  • Report Requirements
    • Configuring a Data Source Tutorial
    • Creating a Report Tutorial
    • Building an RTF Template Tutorial
    • Using Microsoft Word Native Features and XSL
• Using BI Publisher Features
  • Scheduling Reports
    • Enabling BI Publisher Scheduler Tutorial
    • Using BI Publisher to Schedule Reports Tutorial
  • Localizing Reports
    • Localized Template Option
    • XLIFF File Option
• Installing and Integrating BI Publisher with Network Integrity
  • Installing BI Publisher in Standalone Mode
  • Deploying BI Publisher
  • Integrating BI Publisher with Network Integrity using WebLogic Enterprise Manager
  • Integrating BI Publisher with Network Integrity using JConsole
  • Integrating BI Publisher with the Network Integrity Installer
• Uploading and Exporting Reports
  • Exporting a Report
  • Uploading a Report

26 Network Integrity SOA Extensibility

• About SOA Extensibility
  • Purpose of Documentation
• Extensibility Tasks
  • Extensibility Tasks
  • Installing Oracle Weblogic Server 11g R1
  • Installing Oracle JDeveloper 11g R1 PS5
  • Installing Oracle Application Runtime 11g
  • Installing Oracle SOA Suite 11g
  • Creating SOA Metadata Service Schemas
  • Updating JDeveloper for Latest SOA Composite Editor
  • Creating WebLogic Domain with SOA Products
  • Creating and Updating Sample SOA Application Using Network Integrity Web Service
  • Starting and Stopping SOA Servers
  • Building and Deploying the SOA Application
  • Testing Sample SOA application
    • Testing Network Integrity SOA Application Using EM
    • Testing Network Integrity SOA Application Using soa-infra
    • Testing Network Integrity SOA Application Using SOAP UI Tool

27 Localizing Network Integrity

• Software Requirements
• Setting the Language Preference in Internet Explorer
• Determining the Locale ID
• Localizing Network Integrity
  • About the Localization Pack
  • Creating the Localization Pack
  • Deploying the Cartridge Containing the Localized Files
  • Testing the Network Integrity Localization
• Localizing Network Integrity Help
  • About Network Integrity Help
    • About the Help Files
  • Localizing the Network Integrity Help Files
    • Extracting the Help Files
    • Translating the Help Files
    • Regenerating the Search Index File
    • Creating the Localized Help JAR File
    • Configuring the Oracle Help File
  • Deploying the Localized Help System
  • Testing the Network Integrity Help Localization

28 About Models in Network Integrity

• Overview
• About the Network Integrity Model
  • About Scan Entities
  • About Scan Run Entities
  • About Cartridge Entities
  • About Tag Entities
  • Miscellaneous Entities
  • Modeling Considerations for Scan Results
    • Rule: Create Results Only Under Your Own Scan Run/Scan Address
    • Rule: Do Not Reference Entities in Another Result Group
    • Guideline: Use the Same Result Group/Root Entity Partitioning for Network and Inventory Results
• About the Oracle Communications Information Model for Network Integrity
  • Information Model Entities
    • Physical Resource Entities
    • Logical Resource Entities
    • Custom Object Entities
    • Custom Network Address Entities
    • Place Entities
    • Network Entities
    • Connectivity Entities
    • Service Entities
    • Telephone Number Entities
    • Information Model Patterns
    • Authorization Pattern
    • Configuration Pattern
    • Consumer Pattern
    • Inventory Group Pattern
    • Involvement Pattern
    • Trackable Pattern
    • Network Integrity Capabilities
    • DiscrepancyEnabled Capability
    • Groupable Capability
• About the Optical Model for Network Integrity
  • Specifications
  • Optical Topological Link
  • Port Termination Point
  • Cross-Connect
  • Optical Transport Pipe
  • Optical Trail Pipe Reference
  • Optical Circuit
  • Optical Layer Rates
  • Default Result Model
    • Link Result Model
    • Cross-connect Result Model
    • Optical Transport Pipe Result Model
    • Optical Circuit Result Model
  • Information Model Relationship Entities
    • Inventory Group to Pipe
    • Pipe-to-Port Termination Point
    • Trail Path to Optical Trail Pipe
  • Discrepancy Detection Considerations

29 Using Network Integrity Entities

• About Entities and the Database Schema
• DisAddress
• DisAddress Attributes
• DisAddressHandlerHelper
  • DisAddressHandlerHelper Attributes
• DisAssimilationAddress
  • DisAssimilationAddress Attributes
• DisAssimilationPlugin
  • DisAssimilationPlugin Attributes
• DisBlackoutSchedule
  • DisBlackoutSchedule Attributes
• DisCartridgeStatus
  • DisCartridgeStatus Attributes
• DisConfig
  • DisConfig Attributes
• DisConfigurationData
  • DisConfigurationData
• DisDiscoveryPlugin
  • DisDiscoveryPlugin
• DisDiscrepancy
  • DisDiscrepancy Attributes
  • DisDiscrepancyType
  • DisDiscrepancyStatus
  • DisSource
• DisDiscrepancyCounts
  • DisDiscrepancyCounts Attributes
• DisDiscrepancyDetectionPlugin
  • DisDiscrepancyDetectionPlugin Attributes
• DisDiscrepancyResolutionPlugin
  • DisDiscrepancyResolutionPlugin Attributes
• DisHelper
  • DisHelper Attributes
• DisHelperReference
  • DisHelperReference Attributes
• DisInventoryAddress
  • DisInventoryAddress Attributes
• DisInventoryConfig
  • DisInventoryConfig Attributes
• DisInventoryImportPlugin
  • DisInventoryImportPlugin Attributes
• DisNetworkDiscoveryPlugin
  • DisNetworkDiscoveryPlugin Attributes
• DisParameterGroup
  • DisParameterGroup Attributes
• DisParameterGroupSpecification
• DisPlugin
  • DisPlugin Attributes
• DisReconciliationPlugin
  • DisReconciliationPlugin Attributes
• DisRegionalLinks
  • DisRegionalLinks Attributes
• DisResultGroup
  • DisResultGroup Attributes
• DisRootEntityRef
  • DisRootEntityRef Attributes
• DisScanAddress
  • DisScanAddress Attributes
  • DisScanState
• DisScanRun
  • DisScanRun Attributes
  • DisScanRunState
  • DisSource
• DisSchedule
  • DisSchedule Attributes
  • Recurrence Rule Format
• DisScope
  • DisScope Attributes
• DisTag
  • DisTag Attributes
• DisTaggable
  • DisTaggable Attributes