1.1 Installing and Running ConsoleOne

For general information on ConsoleOne system requirements and setup procedures, see the ConsoleOne readme file. The system requirements documented in this document supplement those specified in the readme file.

ConsoleOne System Requirements

ConsoleOne Dependencies

ConsoleOne SDK Components

ConsoleOne Command-Line Switches

1.1.1 ConsoleOne System Requirements

A 200 MHz or faster processor and 128MB of RAM is recommended. For reporting with large trees, at least 256MB of RAM is recommended.

1.1.2 ConsoleOne Dependencies

To develop snap-ins for ConsoleOne you must have the following:

  • The latest ConsoleOne software.
  • Sun Microsystems Java Developer Kit (JDK)* version 1.1.8 or later.
  • Sun Microsystems Java Runtime Environment (JRE) *version 1.3 or later.
  • The latest Novell Client™, for NDS Administration.

1.1.3 ConsoleOne SDK Components

The ConsoleOne SDK includes three components:

  • ConsoleOne software
  • Documentation
  • Sample code

NOTE:You can download the ConsoleOne SDK components from the Novell Developer Kit ConsoleOne page.

ConsoleOne Software

This component contains the program files for ConsoleOne and its snap-ins. It is installed by default in one of the following locations:

  • Locally on a client: C:\Novell\ConsoleOne
  • On a server: Sys:Java\ConsoleOne

The ConsoleOne software includes the following items:

Item

Description

ConsoleOne.jar

Contains the ConsoleOne shell and snap-in interfaces.

ConsoleOneResources.jar

Contains the ConsoleOne shell’s resources.

help\[locale]\novell_consoleone

ConsoleOne help area. Snap-ins can add their own help directories in this area.

snapins\

Directory for Novell and third-party snap-ins. Snap-ins can add their own directories in this area.

resources\

Directory for resource JAR files used by snap-ins (automatically added to the snap-in class path).

lib\

Directory for supplemental JAR and class files used by Novell and third-party snap-ins (automatically added to the snap-in class path).

Documentation

The documentation is installed by default in C:\Novell\ndk\doc\nco\con1_enu\. This directory contains the index.html file that provides access to all of the ConsoleOne documentation.

The documentation area includes the following components:

Component

Description

api\

Contains the HTML files for the ConsoleOne Reference Guide.

data\

Contains the HTML files for this document.

graphics\

Contains the graphics (GIF) files used by this document.

helptmpl\

Contains the ConsoleOne HTML templates for authoring online help. For more information, see Section 2.5, ConsoleOne Online Help Guidelines.

helpxmpl\

Contains sample ConsoleOne snap-in online help files. For more information, see Section 2.5, ConsoleOne Online Help Guidelines.

Sample Code

The ConsoleOne SDK includes a sample ConsoleOne snap-in complete with source code. It is installed by default in one of the following locations:

  • Locally on a client: C:\Novell\ndk\samples\nco_sample
  • On a server: Sys:Java\Samples\ConsoleOne

1.1.4 ConsoleOne Command-Line Switches

When you start up ConsoleOne at the command prompt, you can use the following command-line switches:

-windowout — This switch traps all output to a window, including exceptions, system outs, and so forth.

-snapinpath <path> — This switch adds those directories specified in <path> to the directories searched for snap-ins. These directories are treated just like the snapin directory, which is the default directory in ConsoleOne. For example, you might specify the <path> as: mysnapins; C:\engineering\snapins.

-libpath <path> — This switch adds JARs in those directories to all snap-ins class path. The default <path> for ConsoleOne is the lib and resources directories. For example, you might specify the <path> as: mylibs; c:\test\lib.

-prefdir <directory name> — This switch is used to save user preferences within the directory named in the <directory name> argument. When the directory is not specified, the shell.properties file is stored in the current working directory. If the directory name argument is specified as "user.home", the user.home environment variable, as defined in Java’s system properties, will be used as the directory in which to store the user preferences. The user.home environment variable points to the user’s home directory.

-systemout — This switch does not hide the output for exceptions, system outs, and so forth. Normally, ConsoleOne traps all output to the system console, including system outs. By using this command line switch, output is not trapped to the system console.

-debug — This switch is used to output debug and error statements in ConsoleOne that are useful for developer debugging problems.

-fileout <filename> — This switch traps all output to the file specified, including exceptions, system outs, and so forth.

-forceSnapinLoad — This switch indicates that ConsoleOne will read snapin registration information by parsing the appropriate directories rather than reading registration information from the serialized file.