The SYSGEN configuration utility/More INI Details

From CometWiki

< The SYSGEN configuration utility(Difference between revisions)
Jump to: navigation, search
(→Documenting the INI file with comments)
 
(10 intermediate revisions not shown)
Line 1: Line 1:
The INI file is a text file that contains configuration information for an entire Comet enterprise. It contains the following major sections:
The INI file is a text file that contains configuration information for an entire Comet enterprise. It contains the following major sections:
-
<code>
 
<pre>
<pre>
-
[[ENTERPRISE]]
+
[ENTERPRISE]
-
[[SITE]]
+
[SITE]
[NODE]
[NODE]
[COMET SYSTEM OPTIONS]
[COMET SYSTEM OPTIONS]
Line 15: Line 14:
[END]
[END]
</pre>
</pre>
-
</code>
 
Refer to the [[minimal INI file]] to see the minimum requirements to configure Comet.
Refer to the [[minimal INI file]] to see the minimum requirements to configure Comet.
Line 28: Line 26:
Here is an example of the [COMET SYSTEM OPTIONS] group:
Here is an example of the [COMET SYSTEM OPTIONS] group:
-
<code>
+
<pre>
[COMET SYSTEM OPTIONS]
[COMET SYSTEM OPTIONS]
First Partition = P00;
First Partition = P00;
Line 34: Line 32:
First Terminal = T00;
First Terminal = T00;
# of Terminals = 3;
# of Terminals = 3;
-
<code>
+
</pre>
In this example, the four lines following the major keyword define the partition and terminal range for a particular Comet node.
In this example, the four lines following the major keyword define the partition and terminal range for a particular Comet node.
-
Each segment title line ends with a semicolon (;), which provides one way to add comments to the INI file, as all text following a semicolon is ignored by SYSGEN. (See below for more information about adding comments to an INI file.)
+
Each segment title line ends with a semicolon (;). All text following a semicolon is ignored by SYSGEN and can be used to comment lines. (See below for more information about adding other comments to an INI file.)
-
+
'''Note:''' there is no line continuation allowed in an INI file. Each segment title must fit on its own line.
-
 
+
-
Please note that there is no line continuation allowed in an INI file. Each segment title must fit on its own line.
+
-
 
+
-
+
Do not mix segment titles of one section with another. For example, it makes no sense to declare a directory name under the [COMET SYSTEM OPTIONS] groups, since it belongs to the [DIRECTORIES] group.
Do not mix segment titles of one section with another. For example, it makes no sense to declare a directory name under the [COMET SYSTEM OPTIONS] groups, since it belongs to the [DIRECTORIES] group.
-
+
==Global -vs- Local==
-
   
+
The INI file can contain global and local entries. Global entries apply to the entire enterprise, while local ones apply to a specific node.  
-
Global and Local
+
Local entries are unique to a given workstation. Typical examples of this include declarations of local directories, partition/terminal/session information, individual printers, gateways that are used on one node only.
-
+
Global statements are default entries for all nodes, and local statements supplement these default entries.
-
In order to accommodate all possible configuration options, the INI file can contain global and local entries. Global entries apply to the entire enterprise, while local ones apply to a specific node. Since the main goal is to develop an INI file specification that would declare Comet configuration information for an entire enterprise, the concept of global verses local entries must be further clarified.
+
Here’s an example. Comet directories would typically be the same for most nodes in a network and these would be defined as global entries in the INI file. However, you could still make local directory entries for a specific node, and these entries would take precedence. Local entries are coded in the [NODE] section for each workstation that requires access to directories that are not defined in the global settings section.  
-
 
+
-
+
-
 
+
-
Global entries refer to those entries that are common to multiple nodes within a networked system. Typical examples of this are:
+
-
 
+
-
+
-
 
+
-
[DIRECTORIES]
+
-
 
+
-
[COMET SYSTEM OPTIONS]
+
-
 
+
-
[INVALID CHARACTER TRANSLATION]
+
-
 
+
-
+
-
 
+
-
Local entries refer to those entries that are unique to a given workstation. Typical examples of this include declarations of local directories, partition/terminal/session information, individual printers, gateways that are used on one node only (for example, XAP, ODBC, Winsock, and the fax gateway).
+
-
 
+
-
+
-
 
+
-
The blend of global and local entries within an INI file is left up to to the system administrator. During the compilation of the INI file, global statements are recorded as default entries for all subsequent nodes, and local statements overriding the default entries.
+
-
 
+
-
+
-
 
+
-
Here’s an example that demonstrates this point. Comet directories may be the same for most nodes in a network. Logically, these would be global entries in the INI file. However, you could still make local directory entries for a specific node, and these entries would take pcedence. Local entries are made by including a new [NODE] section for each node that requires settings that are different from the global settings.
+
-
 
+
-
+
In this example, let assume that the node named MANAGER wants to configure an extra directory named SECURITY.
In this example, let assume that the node named MANAGER wants to configure an extra directory named SECURITY.
-
+
The global section of the INI contains the following directory definitions:
-
 
+
-
The global section might contain the following directory definitions:
+
-
 
+
-
+
 +
<pre>
[DIRECTORIES]
[DIRECTORIES]
-
 
00 = S ,\\FS1\SYS\COMET\REL\;          REL directory
00 = S ,\\FS1\SYS\COMET\REL\;          REL directory
-
 
01 = S ,\\FS1\SYS\COMET\SYS\;          SYS directory
01 = S ,\\FS1\SYS\COMET\SYS\;          SYS directory
-
 
02 = S ,\\FS1\SYS\COMET\NET\;          NET directory
02 = S ,\\FS1\SYS\COMET\NET\;          NET directory
-
 
03 = L ,D:\TEMP\;                              TMP directory
03 = L ,D:\TEMP\;                              TMP directory
-
 
04 = S ,\\FS1\SYS\COMET\SPOOL\; SPL directory
04 = S ,\\FS1\SYS\COMET\SPOOL\; SPL directory
-
 
05 = S ,\\FS1\SYS\COMET\UTL\;          UTL directory
05 = S ,\\FS1\SYS\COMET\UTL\;          UTL directory
-
 
06 = S ,\\FS1\SYS\COMET\UTR\;          UTR directory
06 = S ,\\FS1\SYS\COMET\UTR\;          UTR directory
-
 
07 = S ,\\FS1\SYS\COMET\MISC\;  MSC directory
07 = S ,\\FS1\SYS\COMET\MISC\;  MSC directory
 +
</pre>
-
+
The local section for the MANAGER node would contain the following definition for the eighth directory in the configuration:
-
 
+
<pre>
-
The local section for the MANAGER node would contain the following:
+
-
 
+
-
+
-
 
+
[NODE]
[NODE]
-
 
Name = MANAGER;                        Node name is MANAGER
Name = MANAGER;                        Node name is MANAGER
-
 
Server = N01,FS;                        Get files and security from N01
Server = N01,FS;                        Get files and security from N01
-
 
-
 
-
 
[DIRECTORIES]
[DIRECTORIES]
-
 
08 = S ,\\FS1\SYS\COMET\SECURITY;      Add directory for this node
08 = S ,\\FS1\SYS\COMET\SECURITY;      Add directory for this node
-
 
+
</pre>
-
+
The local section can also take away entries that were made in the global section. For example, suppose that the MANAGER node wants to (1) add the SECURITY directory, and (2) remove the TEMP and QSPOOL directories. The local section would then look like this:
The local section can also take away entries that were made in the global section. For example, suppose that the MANAGER node wants to (1) add the SECURITY directory, and (2) remove the TEMP and QSPOOL directories. The local section would then look like this:
-
+
<pre>
-
 
+
[NODE]
[NODE]
-
 
Name = MANAGER;                        Node name is MANAGER
Name = MANAGER;                        Node name is MANAGER
-
 
Server = N01,FS;                        Get files and security from N01
Server = N01,FS;                        Get files and security from N01
-
 
-
 
-
 
[DIRECTORIES]
[DIRECTORIES]
-
 
03 = ;                                  Don’t configure this directory on this node
03 = ;                                  Don’t configure this directory on this node
-
 
04 = ;                                  Don’t configure this directory on this node
04 = ;                                  Don’t configure this directory on this node
-
 
08 = S ,\\FS1\SYS\COMET\SECURITY;      Add directory for this node
08 = S ,\\FS1\SYS\COMET\SECURITY;      Add directory for this node
 +
</pre>
-
+
==Documenting the INI file with comments==
-
Here’s a good strategy to follow when editing the INI file for global and local settings:
+
It's always a good idea to document your work. There are two ways to include documentation within your Comet INI file, they are:
 +
* Using the asterisk character (*) in the 1st position of any INI line.
-
+
For example:
-
Complete     the segment entries for each of the sections except [NODE]. The segment      entries here are the global entries for the enterprise. Entries should be      the settings that are most common for all the nodes in the enterprise.
+
***************************************************************
-
Place      the [NODE] section(s) after the [INVALID TRANSLATION TABLE] section and      before the [END] section. The local entries for each node are specified in      this area.
+
* COMET.INI                                                  *
 +
* Last Date Modified: 04/16/01     # of NODES = 60          *
 +
***************************************************************
-
+
* Each segment title must end with a semicolon. Any text beyond the semicolon is considered a comment and is ignored by SYSGEN.
-
 
+
-
In order to satisfy, in the broadest terms, all configuration options that are possible, no limitations exist between what can be declared global or local. For some installations, a specific global declaration may make sense whereas for another, it would make no sense.
+
-
 
+
-
+
-
 
+
-
+
-
 
+
-
Documenting the INI file with comments
+
-
 
+
-
+
-
 
+
-
It's always a great idea to document your INI file, if for no other reason but to clarify configuration entries. There are two ways to include documentation within your Comet INI file, they are:
+
-
 
+
-
+
-
 
+
-
1.        Using the asterisk character (*) in the 1st position of any INI line.
+
-
 
+
-
+
For example:
For example:
-
   
+
  [NODE]
-
 
+
Name = MANAGER;          Node name is MANAGER
-
***************************************************************
+
Server = N01,FS;        Get files and security from N01
-
 
+
-
* COMET.INI                                                  *
+
-
 
+
-
* Last Date Modified: 04/16/01      # of NODES = 60          *
+
-
 
+
-
***************************************************************
+
-
 
+
-
+
-
 
+
-
2.                  Each segment title must end with a semicolon. Any text to the right of the semicolon is considered a comment and is ignored by SYSGEN.
+
-
 
+
-
+
-
 
+
-
For example:
+
-
 
+
-
+
-
 
+
-
[NODE]
+
-
 
+
-
Name = MANAGER;          Node name is MANAGER
+
-
 
+
-
Server = N01,FS;        Get files and security from N01
+

Latest revision as of 19:24, 21 August 2008

The INI file is a text file that contains configuration information for an entire Comet enterprise. It contains the following major sections: 

[ENTERPRISE]
[SITE]
[NODE]
[COMET SYSTEM OPTIONS]
[CONSOLE SESSION OPTIONS]
[DIRECTORIES]
[PRINTERS]
[SPOOLERS]
[GATEWAYS]
[INVALID CHARACTER TRANSLATION]
[END]

Refer to the minimal INI file to see the minimum requirements to configure Comet.

Groups

An INI file contains 11 groups. The keyword that starts each group is enclosed in square brackets. For example:

[COMET SYSTEM OPTIONS]

Each group contains detailed information about a portion of your Comet configuration. The details are defined by one or more segment titles within each group. A segment title contains a keyword, and equal sign (=), and one or more parameters.

Here is an example of the [COMET SYSTEM OPTIONS] group: 

[COMET SYSTEM OPTIONS]
First Partition = P00;
# of Partitions = 10;
First Terminal = T00;
# of Terminals = 3;

In this example, the four lines following the major keyword define the partition and terminal range for a particular Comet node.

Each segment title line ends with a semicolon (;). All text following a semicolon is ignored by SYSGEN and can be used to comment lines. (See below for more information about adding other comments to an INI file.)

Note: there is no line continuation allowed in an INI file. Each segment title must fit on its own line.

Do not mix segment titles of one section with another. For example, it makes no sense to declare a directory name under the [COMET SYSTEM OPTIONS] groups, since it belongs to the [DIRECTORIES] group.

Global -vs- Local

The INI file can contain global and local entries. Global entries apply to the entire enterprise, while local ones apply to a specific node.

Local entries are unique to a given workstation. Typical examples of this include declarations of local directories, partition/terminal/session information, individual printers, gateways that are used on one node only.

Global statements are default entries for all nodes, and local statements supplement these default entries.

Here’s an example. Comet directories would typically be the same for most nodes in a network and these would be defined as global entries in the INI file. However, you could still make local directory entries for a specific node, and these entries would take precedence. Local entries are coded in the [NODE] section for each workstation that requires access to directories that are not defined in the global settings section.

In this example, let assume that the node named MANAGER wants to configure an extra directory named SECURITY.

The global section of the INI contains the following directory definitions: 

[DIRECTORIES]
00 = S ,\\FS1\SYS\COMET\REL\;           REL directory
01 = S ,\\FS1\SYS\COMET\SYS\;           SYS directory
02 = S ,\\FS1\SYS\COMET\NET\;           NET directory
03 = L ,D:\TEMP\;                              TMP directory
04 = S ,\\FS1\SYS\COMET\SPOOL\; SPL directory
05 = S ,\\FS1\SYS\COMET\UTL\;           UTL directory
06 = S ,\\FS1\SYS\COMET\UTR\;           UTR directory
07 = S ,\\FS1\SYS\COMET\MISC\;  MSC directory

The local section for the MANAGER node would contain the following definition for the eighth directory in the configuration: 

[NODE]
Name = MANAGER;                         Node name is MANAGER
Server = N01,FS;                        Get files and security from N01
[DIRECTORIES]
08 = S ,\\FS1\SYS\COMET\SECURITY;       Add directory for this node

The local section can also take away entries that were made in the global section. For example, suppose that the MANAGER node wants to (1) add the SECURITY directory, and (2) remove the TEMP and QSPOOL directories. The local section would then look like this: 

[NODE]
Name = MANAGER;                         Node name is MANAGER
Server = N01,FS;                        Get files and security from N01
[DIRECTORIES]
03 = ;                                  Don’t configure this directory on this node
04 = ;                                  Don’t configure this directory on this node
08 = S ,\\FS1\SYS\COMET\SECURITY;       Add directory for this node

Documenting the INI file with comments

It's always a good idea to document your work. There are two ways to include documentation within your Comet INI file, they are:

  • Using the asterisk character (*) in the 1st position of any INI line.

For example: 

***************************************************************
* COMET.INI                                                   *
* Last Date Modified: 04/16/01      # of NODES = 60           *
***************************************************************
  • Each segment title must end with a semicolon. Any text beyond the semicolon is considered a comment and is ignored by SYSGEN.

For example: 

[NODE]
Name = MANAGER;          Node name is MANAGER
Server = N01,FS;         Get files and security from N01
Retrieved from "http://wiki.signature.net/index.php/The_SYSGEN_configuration_utility/More_INI_Details"
Personal tools