Skip Headers
Oracle® Communications Network Integrity Developer's Guide
Release 7.1

E23701-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

3 Working With Cartridges

This chapter provides an overview of Oracle Communications Network Integrity cartridge concepts and procedures.

About Cartridges

Network Integrity cartridges are packaged extensions to the core application. They represent the necessary components needed for the following:

  • Discovering network elements, either from a Network Management System (NMS) or through direct contact with the Network Element (NE)

  • Importing network elements from an inventory system

  • Assimilating network data using business logic

  • Detecting discrepancies between the network and the inventory system

  • Resolving discrepancies, either within the network, or in the inventory system

Cartridges provide the ability to support new functionality as business cases arise, such as:

  • New protocols; for example: Command Line Interface (CLI), Transport Layer Security (TLS), and so on

  • New standards; for example: a new RFC

  • New vendor devices; for example: Juniper, Huawei, and so on

  • New operational or business support systems

Cartridges are made up of one or more of the following components:

About Cartridges and Design Studio

Cartridges contain Network Integrity entities, such as Actions and Processors. Design Studio is the tool used by customers, systems integrators, and third-party vendors to develop cartridges that meet their business needs.

When extending Network Integrity, you can create one or many cartridges, depending on how you choose to organize the extensions.

Everything you create in Design Studio resides in a cartridge. The name you choose for the cartridge becomes the name of the IAR (Integrity Archive) file, and everything you create within that cartridge is automatically placed in the IAR file.

About the Cartridge Architecture

Figure 3-1 shows the cartridge architecture.

Figure 3-1 Network Integrity Cartridge Architecture

Illustrates cartridge architecture

In the context of a cartridge, address handlers and actions cannot coexist. Therefore, address handlers must be defined in their own cartridge. This allows for a clear segregation of responsibility. So, for example, cartridge developers create a cartridge called AddressHandlers where different address handler types exist (for example: IP Address, URL, and so on) and simply reference those from within their discovery and import cartridges.Cartridges can also reuse actions from other cartridges to extend behavior. For example, a Juniper-specific SNMP cartridge (that is, containing Juniper MIBs) could extend a generic SNMP Cartridge (MIB II only).After all components are defined, cartridges are packaged into an IAR (Integrity Archive) file and can be deployed to a running Network Integrity system using the Cartridge Deployer. Use the Cartridge Deployer to deploy cartridges to production environments. Alternatively, cartridges can be deployed through Design Studio on non-production environments.

See "Building and Packaging Cartridges" and "Deploying and Undeploying Cartridges" for more information.

After a cartridge is deployed, it is available to Network Integrity.

To determine whether a cartridge is deployed in Network Integrity:

  1. From the Network Integrity main menu, click Help, and then select About.

    The Network Integrity components dialog appears.

    Figure 3-2 shows the Network Integrity components dialog.

    Figure 3-2 Network Integrity Components Dialog

    Shows components dialog box
  2. Select the Components tab.

    The Network Integrity product version is displayed with the versions of all cartridges deployed in Network Integrity.

Creating a Cartridge

To create a Network Integrity Cartridge using Design Studio:

  1. From within Design Studio, switch to the Design perspective.

  2. Right-click in a blank area inside the Cartridge View pane, and select New and then select Integrity Project.

    The New Studio Product Cartridge Project dialog box appears.

  3. In the Project name field, enter a project name.

  4. Click Finish to create the cartridge.

    You can now create actions or address handlers.

    Figure 3-3 shows an example of a cartridge as it appears in the Studio Design Cartridge Editor.

    Figure 3-3 Network Integrity Sample Cartridge

    Shows sample cartridge

Working with the Network Integrity Cartridge Editor

This section details the contents of the Network Integrity Cartridge Editor, as shown in Figure 3-3.

The Network Integrity Cartridge Editor consists of the following tabs:

Properties Tab

The Properties tab contains general information about the cartridge, such as a description, versioning, state (that is, sealed or unsealed) and a default package to use when auto-generating code.

Copyright Tab

The Copyright tab contains text boxes where copyright and license information can be added.

Model Variables Tab

The Model Variables tab contains a list of property value pairs.

Note:

Network Integrity does not currently use Model Variables.

Cartridge Management Variables Tab

The Cartridge Management Variables tab contains a list of properties used when deploying or undeploying cartridges from Design Studio. These include:

  • wladmin.host.name — the host name of the server where the WebLogic Server resides

  • wladmin.host.port — the WebLogic Server port number

  • wladmin.server.name — the WebLogic Server Admin Server name (for example, AdminServer)

UI Hints Tab

The UI Hints tab contains the set of UI Hints associated to this cartridge. See "Working with UI Parameters" for more information.