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

25 Design Studio Source Control

This chapter provides information on working with source control systems and Design Studio in Oracle Communications Network Integrity.

Working with Source Control

When developing cartridges with Design Studio for Network Integrity, developers may store their work in various source control systems. The eclipse platform, upon which Design Studio is base, provides support for integrating with source control systems. Plugins are available for most common source control systems. The exact behavior of Design Studio when used in an environment where the files are backed by a source control system depends on the source control system and the source control Team plugin that the developer is using.

This section describes which files must be source controlled and which files must be writable to continue working.

Table 25-1 describes the structure of the directories and the files in a Design Studio for Network Integrity project and recommends how they should be handled with respect to a source control system.

Table 25-1 Source Control Handling for Various Files and Directories

Directory or File Description Source Control Handling

ProjectDir/

Project's top level directory.

Under source control. All files directly under this directory must be source controlled.

ProjectDir/cartridgeBin/

Cartridge bin directory is where the deployable IAR files are located.

This directory should be source controlled but the contents should not.

ProjectDir/cartridgeBuild/

Cartridge build directory contains files which are outputs of the cartridge build process.

This directory should be source controlled but the contents should not.

ProjectDir/dataDictionary/

This directory contains the files where the data dictionary information is stored.

This directory and its contents should be source controlled.

ProjectDir/doc/

This directory contains documentation files.

This directory and its contents should be source controlled.

ProjectDir/generated/

This directory contains generated artifacts of the build process.

This directory should be source controlled. Except for the src sub-directory, the contents of this directory should not be source controlled.

ProjectDir/generated/src/

This directory contains generated artifacts of the build process.

This directory should be source controlled, but it contents should not.

ProjectDir/integrityLib/

This directory contains jars that are part of the Network Integrity server Enterprise Archive (EAR). These jars are in the project's classpath.

This directory should be source controlled. The files in this directory should not be source controlled.

ProjectDir/integrityLib/packaged

This directory contains jars that are created by Design Studio for Network Integrity and which are packaged into the cartridge IAR file. The jars are added to the Network Integrity EAR when the cartridge is deployed. These jars are in the project's classpath.

This directory should be source controlled. The files in this directory should not be source controlled.

ProjectDir/lib/

This directory contains jars and other files that are not part of the Network Integrity server EAR. Some of these files are part of the project classpath.

This directory should be source controlled. The mds.mar file is output to this directory. The mds.mar file should not be source controlled. The user may also want to source control other files in this directory.

ProjectDir/mdsArtifacts/

This directory contains files that are both input and outputs of the UI Hints infrastructure.

This directory should be source controlled. The following files under this directory should also be source controlled:

  • MDSAvailablePagePanels.xml

  • MDSAvailablePagePanels.xsd

  • MDSMetaData.xml

The remaining files in this directory should not be source controlled.

ProjectDir/model/

This directory contains files that are used to persist the information about Cartridges, Actions, Processors, Model Collections and Address Handlers.

This directory and its contents should be source controlled.

ProjectDir/out/

This directory contains output classes.

This directory should not be source controlled.

ProjectDir/resources/

This directory is not used.

This directory does not need to be source controlled.

ProjectDir/src/

This directory contains the user supplied code for the cartridge.

This directory and its contents should be source controlled.


Design Studio for Network Integrity assumes that all files and directories of a cartridge project are writable. Some source control systems and team plug-ins automatically manage the files and directories to make them writable as the software needs to write to them. If this is not the case for your chosen source control/Team plug-in combination, then you should manually ensure that this is the case before working with a source controlled project.