Setup Guide

Prerequisites

There are no specific prerequisites for this module.

Installation

There are two approaches for installing the desired module components in the OSGi environment: automated and manual installation.

Automated Installation

All major ConfigTree bundles can be conveniently installed by calling the install script configtree.txt placed in the bin/pscripts directory. configtree.txt installs the main ConfigTree bundles through the Kit Manager, running on the OSGi service platform.

In general, the Kit Manager can be used from a text console to the runtime - from the OSGi Runtime local console, from a Telnet client and from a Web Admin Console.

To execute an install script (i.e. in terms of the Kit Manager to "install a kit"), go to the kitman command group and use the install command.

Install the ConfigTree module core components - Use the configtree.txt file, seen as a "ConfigTree" kit in the Kit Manager. Type the following command in the console to install the kit:
kitman.install "ConfigTree"
Install the ConfigTree remote handler for access over JSON-RPC - Use the configtree.remote.txt file, seen as a "ConfigTree Remote Servlet" kit in the Kit Manager. Type the following command in the console to install the kit:
kitman.install "ConfigTree Remote Servlet"
Install the Web Admin plugin for working with configurations through the Web Admin Console - Use the configtree.web.txt file, seen as a "ConfigTree Web Console Plugin" kit in the Kit Manager. Type the following command in the console to install the kit:
kitman.install "ConfigTree Web Console Plugin"

For more information on the Kit Manager, refer to the user documentation of the OSGi Framework.

Manual Installation

You can install only the needed bundles from the module taking into account their dependencies both from this module and also from other modules:

Install and start the following bundles:
1. com.prosyst.mbs.configtree.api.jar
2. com.prosyst.mbs.configtree.core.jar
3. com.prosyst.mbs.configtree.commands.jar
4. com.prosyst.mbs.configtree.resman.jar
If you want to use JSON-RPC commands for remote management of configurations, install:
1. The JSON-RPC module.
2. com.prosyst.mbs.configtree.servlet.jar

The ConfigTree JSON-RPC service is different than the other pure JSON-RPC services: it is HTTP servlet that returns JSON object but accepts HTTP GET parameters rather than JSON object. Please see the examples below.

If you want to use the ConfigTree functionality through a web interface:
1. Install the Working with web console
2. Install and start the bundles supporting JSON-RPC access from the list above
3. Install and start com.prosyst.mbs.configtree.webconsole.jar

System Properties

For more information on how to use system properties, please read "System Properties & Configurations".

Property	Type	Default Value	Description
mbs.configtree.servlet.print	boolean	false	If "true" enables printing debug information to the framework runtime console.
mbs.configtree.servlet.debug	boolean	false	If "true" turns on generation of debug information in the OSGi Log Service.

Configuration Properties

For more information on how to set up configuration properties, please refer to the "System Properties & Configurations" document.

Name	PID	Property	Type	Default Value	Description
Debug Level	com.prosyst.services.configtree.debug	CONFIG_LEVEL	boolean	false	If set to "true", debug messages of the configurable built on top of BaseConfigurable will be generated.
Debug Manager Level	com.prosyst.services.configtree.debug	CONFIG_MANAGER_LEVEL	boolean	false	If set to "true", debug messages of management operations through the ConfigTree Admin service will be generated.
Debug All	com.prosyst.services.configtree.debug	DEBUG_ALL	boolean	false	If set to "true", it logs all types of the debug messages.
Debug Print	com.prosyst.services.configtree.debug	PRINT_ON_CONSOLE	boolean	false	If set to "true", it prints out all debug messages in the console output.
CM Debug Level	com.prosyst.services.configtree.cm.debug	DEFAULT_LEVEL	boolean	false	If set to "true", it allows for all debug messages of the DEFAULT_LEVEL to be accessible.
CM Debug All	com.prosyst.services.configtree.cm.debug	DEBUG_ALL	boolean	false	If set to "true", it logs all of the debug messages.
CM Debug Print	com.prosyst.services.configtree.cm.debug	PRINT_ON_CONSOLE	boolean	false	If set to "true", it prints out all debug messages in the console output.
Resources Manager Debug All	com.prosyst.services.configtree.resman.log	DEBUG	boolean	false	If set to "true", it logs all of the debug and info messages.
Resources Manager Debug Print	com.prosyst.services.configtree.resman.log	PRINT_ON_CONSOLE	boolean	false	If set to "true", it prints out all debug and info messages in the console output.
Resources Manager Import Debug	com.prosyst.services.configtree.resman.log	resources.manager	boolean	false	If set to "true", it debugs messages on importing configuration resources.
Resources Manager Database Debug	com.prosyst.services.configtree.resman.log	resources.db.management	boolean	false	If set to "true", it debugs messages for database load/store of configuration resources.

Troubleshooting

No troubleshooting information is available for this module.