FairCom RTG BTRV User Guide

FairCom RTG Configuration Tool - RTG Config

The FairCom RTG Configuration tool, RTG Config, provides a graphical interface for configuring the FairCom RTG products. This tool helps you to edit the XML file, ctree.conf, which is used to configure these products. It also tests ctree.conf for correctness, so you can use it to find any problems with a ctree.conf you have edited by hand.

The RTG Config tool, RTGConfig.jar, is located in the Tools\guitools.java\ directory.

The ctree.conf file consists of a collection of elements nested in a hierarchy. The <config> element is the root of the hierarchy. It will have one or more <instance> elements below it. Both <config> and <instance> can have other elements beneath them (e.g., <file>). Options (such as data compression) can be applied to elements in the tree. The tool displays descriptions of the selected elements and options. (For more complete definitions of the elements, see Configuration File Elements. For more about the file format see FairCom RTG Configuration File).

The Configuration Tool depicts the XML hierarchy as a tree. The tree is composed of:

Elements (e.g., config, instance, file, etc.) are depicted as folders. These elements define the basic structure you will configure. Each configuration file has a single <config> element with at least one <instance> under it. See Structure Elements.
Attributes (e.g., name) are depicted as red dots (a summary of attributes also appears after the name of each element). They are details that further describe an element (e.g., a file element is specified with a name or directory attribute).
Options (e.g., datacompression) are depicted as blue dots. They are optional settings that can be applied to an element. See Settings Elements.

You can click the + or - buttons next to each branch to expand or collapse it. The tool bar provides Expand Tree and Collapse Tree buttons to quickly hide or show all details. The Show Attributes button allows you to hide or display attributes to simplify viewing the tree.

cobol_conf_compoff

The image above depicts the following XML configuration file, ctree.conf (data compression will be active for all the specified instances but not for the third instance ("FAIRCOM3") which specifies its own datacompress setting):

<?xml version="1.0" standalone="yes"?>	XML header.
<config>	This is the root element; all of the other elements and settings are subordinate to it.
<datacompress>yes</datacompress>	This option element is immediately under the root level, so it applies compression to all elements (unless it is overridden at a lower level).
<instance server="FAIRCOMS@127.0.0.1">	This structure element specifies an instance of a connection to a FairCom RTG server, called FAIRCOMS, specified by the server= attribute.
<file name="CUSTORDR"/>	This structure element uses the name= attribute to specify the CUSTORDR file, which is on the FAIRCOMS FairCom RTG server because this element is a child of that instance.
</instance>	The end of the FAIRCOMS instance.
<instance server="FAIRCOM2@192.168.0.2">	An instance of a connection to a FairCom RTG server called FAIRCOM2.
<file name="ITEMMAST"/>	This structure element specifies the ITEMMAST file on the FAIRCOM2 FairCom RTG server.
</instance>	The end of the FAIRCOM2 instance.
<instance server="FAIRCOM3@10.0.0.4">	This structure element specifies an instance of a connection to a FairCom RTG server called FAIRCOM3.
<datacompress>no</datacompress>	This settings element turns off compression for its parent instance, FAIRCOM3.
<file name="CUSTMAST"/>	This structure element specifies the CUSTMAST file on the FAIRCOM3 FairCom RTG server.
</instance>	The end of the FAIRCOM3 instance.
</config>	The end of this configuration file.

For more about the file format, see FairCom RTG Configuration File.

Configuration Tool Menus

The following menus are provided:

File

New (Basic) - Create a simple configuration file.
New (Advanced) - Create a new configuration file (see below).
Open - Opens a configuration file.
Save - Saves the current configuration file.
Save As - Allows the current configuration file to be saved under a new name.
Exit - Closes the tool and exits.

Actions

Remove Item - Removes the selected item from the configuration file.

Help

About - Displays information about the version of the tool.

Tool Bar

The following controls are provided in the tool bar:

New File (Basic) - See Creating a New File (Basic). Create a basic configuration file. The Basic Configuration window will appear so you can create a new configuration file.
New File (Advanced) - See Creating a New File (Advanced). Create a new configuration file.
Open a File - Opens a configuration file.
Save Current File - Saves the current configuration file.
Expand Tree - Expands the display of the tree to show all branches so that the full contents of the file can be seen. You can click the - buttons next to each branch to collapse it.
Collapse Tree - Collapses the display of the tree to show all branches so that only the top level of the file can be seen. You can click the + buttons next to each branch to expand it.
- Use this button to display or hide the attributes of the elements. Showing attributes depicts attributes as separate items in the tree; hiding them can make it easier to see the entire tree.

Creating/Editing Your Configuration File

The RTG Config tool provides two ways to create your configuration file:

Basic Configuration - This simple, two-step wizard guides you through the configuration process to get started in a hurry. Fill in the fields to create a configuration file that connects to a single FairCom RTG server. If you require a more advanced configuration, you can start with the Basic Configuration wizard and then use the RTG Config to edit the file. See Creating a New File (Basic).
Advanced Configuration - The RTG Config allows you to create and edit a configuration file. Selecting File > New (Advanced) (or clicking on the corresponding hot button), clears any entries shown in the RTG Config tree view (and prompts you to save changes, if any) and starts a new configuration. You can then add the elements required for your environment. See Creating a New File (Advanced).