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

20 Building and Packaging Cartridges

Design Studio packages project information into cartridges that can be deployed into Network Integrity.

Cartridges can be developed by customers, systems integrators, Professional Services staff, and third-party vendors.

This chapter describes the cartridge build process, and outlines how to package a cartridge:

Building Cartridges Automatically

It is recommended that the Build Automatically setting is enabled in Design Studio. Building automatically means that an incremental build is carried out in Design Studio when a save action is carried out on any Network Integrity entity.

To enable the Build Automatically setting:

  • From the Project menu in Design Studio, check Build Automatically.

If Build Automatically is not enabled, you have to manually start a build on a Network Integrity cartridge. Design Studio does not automatically perform a build even if there is a change in the project.

To disable Build Automatically setting:

  • From the Project menu, uncheck Build Automatically.

About the Project Build Order

When Design Studio builds a Network Integrity project, the build process takes place in the following order:

  • Generation of Java source code - Generators are invoked to generate Java source codes from Network Integrity models, EJB descriptor files, XML schemas for the SNMP processor, and the Meta Model XML file.

  • Java Source Compilation - Eclipse compiles the Java source (including generated Java source and implemented Java source) into classes.

  • Building - Builders are invoked to build UI hints, the Data Dictionary, and specifications.

  • Validation - Validators are invoked to validate Network Integrity model entities. Validation errors are raised and an error marker displayed on the related entities in Design Studio. If any validation errors are raised, the packaging stage does not take place.

  • Packaging - Packagers are invoked to package the cartridge deployment model XML file, the UI hints Metadata Archive (MAR) file, specification Data Access Object (DAO) files, dependent JAR files, the manifest file for JAR files library for EJB, and the final IAR (Integrity Archive) file for the Network Integrity cartridge.

About Build Artifacts

Design Studio generates various build artifacts for a Network Integrity cartridge after a successful build. The generated directories are listed in the following order in the directory structure:

  • Out: This directory contains all the compiled Java classes.

  • Generated: contains the following build artifacts:

    • Generated Java sources for actions and processors. If the project is sealed without Java source, the JAR file is displayed instead

    • SNMP schema artifacts for the SNMP processor

  • mdsArtifacts: contains the UI hints artifacts generated by the POMS plug-in.

  • cartridgeBuild: contains various build artifacts for the Network Integrity cartridge.

  • cartridgeBin: contains the final packaged Network Integrity cartridge as an IAR file which can be deployed to the Network Integrity server through the Cartridge Management Web Service (CMWS).

The following directories comprise the normal directory structure for a Network Integrity project. Please do not modify these directories:

  • dataDictionary: contains the Data dictionary

  • doc: contains documents

  • integrityLib: contains Network Integrity libraries (JAR files)

  • lib: Copy any third party JAR library into this directory.

    Switch to the Packager Explorer view, and modify the Java class path to include any JAR files that have been added to this directory.

    Select the project, and click F5 to refresh the project in Design Studio to get the modified Java class path affected.

  • model: contains all Network Integrity models

  • out: Output directory for compiled Java classes

  • resources: contains resources related to Network Integrity. This directory is empty by default

  • src: the Java source directory.

Packaging Cartridges

Packaging the cartridge is the last stage in building a Network Integrity cartridge. The Network Integrity cartridge is packaged as an Integrity ARtifact (IAR) file, which can be deployed to the Network Integrity server through the Cartridge Management Web Service (CMWS) either from Design Studio, or through the Oracle Cartridge Deployer.

The IAR file contains the following build artifacts:

IAR root/
                <cartridge-ejb-jar>.jar - This jar contains manifest.mf file to refer to the jars under cartridgeLib/<cartridgeName>.
                oracle.communications.platform.entity.impl.SpecificationDAO
                oracle.communications.platform.entity.impl.CharacteristicSpecUsageDAO
                oracle.communications.platform.entity.impl.CharacteristicSpecificationDAO
                <cartridgeName_A>.mar
                <cartridgeName_B>.mar
                …
                <cartridgeName_N>.mar - Multiple MAR files if this cartridge is reusing Actions from other cartridges.
                <Action_Name_A>_MetaModel.xml 
                <Action_Name_B>_MetaModel.xml
                …
                <Action_Name_N>_MetaModel.xml - Meta Model XML file per Action.
                /META-INF/
                                cartridge.xml
                                manifest.xml
                /cartridgeLib/<cartridgeName>/*.jar (any dependent jar files used by this cartridge, if available) 

If a Network Integrity cartridge contains only abstract actions, no IAR file is generated. See "Working with Actions" for more information about actions.

Viewing and Solving Problems in the Problems View

The Problems view is the primary source you should refer to for identifying problems with your projects.

The Problems view displays warnings, errors, and informational messages that are generated as you work on projects. For example, if one or more of your saved Java source files contains syntax errors, these errors appear in the Problems view. Similarly, if you make configuration errors while working on specifications, you see error messages in the Problems view.

By default, the problems are logged by severity. You can also group the problems by type. The first column of the view displays an icon that denotes the message type (warning, error, or informational) and the description. The remaining columns display the name of the resource that generated the problem, its path, and its directory location.

You can click an item to open an editor of the affected item so that you can resolve the problem. In code files, the line containing the problem is highlighted.

You can filter the Problems view to display only warnings and errors that are associated with a particular resource or group of resources. See Workbench User Guide in the Design Studio Help for information about applying filters to the Problems view.

Reviewing the Error Log

The Error Log view captures all warnings and error messages logged by actions. Reviewing the Error Log view can help you find errors in your project builds. The underlying log file resides in the metadata subdirectory of your workspace directory.

Error messages that contain a plus sign preceding the message contain other errors. To display these error messages, click the plus sign to expand the view.

To view the details of any error, double-click the message to display the Event Details dialog box.