Managing Configurations via XML

Overview

For each configuration type you can provide an XML file following the required structure of the Config nodes and property elements defined by the configurable provider. The importing process can be manual (using the web or the text console) or automatic (using the ConfigTree manifest header).

To access a configuration, make sure you have the relevant configuration type exported in the Config Tree. For example, if your application is not the one exporting the type, use the cft.list command in the runtime console to see the available configurable objects.

Editing Configurations

If there is already some configuration data saved, follow the steps below:

Export an XML file to your local file system, by using the Config Tree page of the Web Admin Console (see "Management via Web Console").
Modify the file.
Import the updated file.

Creating new Configurations

You can create an XML file from scratch following the structure required by the mapped functionality and import it in the runtime.

Defining Custom Property Types

The ConfigTreeConstants interface (see Java API) defines the supported ConfigTree property types. See also Supported Property Data Types topic from the System Architecture.

To define a custom property type:

Crate a file using the XML scheme format.
Put the new custom property types in the following syntax:
<property type="int[]" value="1,2,3" key=" ExampleMode"/>

For more information on the properties refer to Components for ConfigTree Content chapter.

The syntax for all available property types is available below.

Managing Several Configurations

You can modify several configurable objects at one time by using a ZIP file with XML files according to the structure defined in "System Architecture -> Import/Export Format s". Similarly to single XML files, you can export a ZIP file, modify the configuration XML files and then import it.

Check the ConfigTree Demo's config.zip file for illustration.

</config> </config> <config name=" root.child.2">

</config>

cft>$cn DEMO1

DEMO1:/

cft>$tree

DEMO1:/ -----------------------------------------------

DEMO1

| +--(barray = 0x01, 0x02, 0x03) {byte[]}

| +--(booleanKey = true) {boolean}

| +--(byteKey = 1) {byte}

| +--(doubleKey = 1.0) {double}

| +--(floatKey = 1.0) {float}

| +--(intKey = 1) {int}

| +--(longKey = 1) {long}

| +--(stringKey = text) {string} +--root.child.1

| +--(key11 = value11) {string}

| +--root.child.1.child.1

| +--(key111 = value111) {string}

+--root.child.2 +--(key12 = value12) {string}

+--root.child.2.child.1

+--(key121 = value121) {string} cft>$

Automatically Importing Configurations

A bundle can provide configurations in XML format within its JAR file, which to be automatically loaded on its start-up. For this purpose, a record with the header ConfigTree should be added in its manifest file with the following syntax:

ConfigTree: xml=<source_path>[; type=<type_name>][; version=<verison>], where:

<source_path> is the path and the filename of the configurations source. Example: "/Rule.xml"
<type_name> is the name of the configurable type. This parameter can be skipped if the type name matches the name of the source file.
<verison> - the version of the source file. If skipped, "0.0.0" is used.

If the source content has been updated, in order to be reloaded on the next bundle start-up, change the version number to a higher value.

The order of the parameters is not mandatory.

For importing more than one configuration file, a comma-separated list can be used. Example:

Bundle-ManifestVersion: 2

Bundle-SymbolicName: test.resman.ctr_2

ConfigTree: xml=/TEST-A.xml;

type=TEST-A;

version=1.0.0,

type=TEST-B;

xml=/config2_2.xml;

version=1.0.0

If the configurable type is not registered yet, the imported configurations are stored in the database and will be loaded once the relevant configurable service has been implemented and registered.