The SYSGEN configuration utility

From CometWiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
This documentation describes the Comet SYSGEN program.
+
The term ''SYSGEN'' refers to a method for creating and maintaining the system configuration file used by Comet Workstations. The SYSGEN process consists of three separate parts:
 +
* Creating a text file containing the configuration specifications.
 +
* "Compiling" this text file and creating configuration files; one file for each workstation.
 +
* Starting the Comet Workstation program using the configuration file.
-
SYSGEN is a utility program that configures Comet. The process begins with you placing the configuration information for your entire Comet enterprise in a text file called an INI file. You can name this file anything you choose, but we recommend using the name COMET.INI
+
==The INI file==
-
The SYSGEN program processes your INI file and creates individual Comet configuration files, one for each node in your Comet enterprise.
+
The text file containing the configuration information is referred to as the  [http://en.wikipedia.org/wiki/INI_file | INI] file (pronounced "eye en eye" or "in ee"). This text file is not a [[Comet file types |Comet file]]. Typically this file is stored in the Comet Startup Folder, but it can be stored in another folder. As it is not a Comet File the file name should not be limited to 8 bytes, but it is not known what the limitations are on the length of the filename. Typically short names are used and often the name is simply COMET.INI.  The file extension is typically INI, but again this is not a requrement. The file name must have an extension and that extension must be associated in Windows with a text editing program.
-
For example, suppose that your INI file contains configuration information for 4 nodes. SYSGEN reads the entire INI file and builds 4 configuration files, one for each node. The configuration files in this example are named:
 
-
::node1.cfg
 
-
::node2.cfg
 
-
::node3.cfg
 
-
::node4.cfg
 
==What's in the INI file?==
==What's in the INI file?==
-
The INI file contains all of the configuration information for your entire Comet enterprise. It includes groups of commands that specify the configuration for various parts of your Comet system. Here are the major keywords contained in an INI file:  
+
The INI file contains all of the configuration information for your entire Comet enterprise. It includes groups of commands that specify the configuration for various parts of your Comet system. Here are the groups in an INI file:  
   <nowiki>[ENTERPRISE]</nowiki>
   <nowiki>[ENTERPRISE]</nowiki>
Line 30: Line 28:
'''Note:''' Two keywords that were supported in previous versions of Comet (MULTI-USER BOARDS and TERMINALS) are no longer supported.
'''Note:''' Two keywords that were supported in previous versions of Comet (MULTI-USER BOARDS and TERMINALS) are no longer supported.
-
Based on the information contained in the INI file, the SYSGEN program creates one configuration file for each node. If multiple nodes are defined, SYSGEN creates multiple configuration files. The node configuration files are named xxx.CFG where "xxx" is the name of the node.
+
Based on the information contained in the INI file, the SYSGEN program creates one configuration file for each node. If multiple nodes are defined, SYSGEN creates multiple configuration files. The node configuration files have .CFG extensions and the file name is the NAME coded in the NODE seqment.
-
To start Comet using a specific configuration file, you must include the node name in the shortcut that starts Comet. This is done with the /PN= startup option (where “PN” stands for “profile name,” a term that is equivalent to “node name”). For example, suppose you have defined a node named SALES, and that SYSGEN has created a configuration file named SALES.CFG. Your startup shortcut will consist of the program name and the /PN= startup option:
+
It's important to note and understand that individual workstation configurations can contain different information. Thus some workstations can be prevented from accessing specific directories, or printers.
-
  C:\comet\cosw.exe /PN=SALES
+
-
The .CFG extension is not necessary when specifying the shortcut.
+
-
The .CFG files are typically stored in the Comet startup directory on the server. When Comet is started, it checks the startup directory to see if there’s a "nodename.CFG" file present, and then reads that file and establishes the configuration for the node.  
+
==Starting Comet==
 +
To start Comet using a specific configuration file, you include the node name in the [[Comet command line options | shortcut]] that starts Comet. The /PN= startup option, “profile name,” specifies the CFG file to be loaded. For example, suppose you have defined a node named SALES, and that SYSGEN has created a configuration file named SALES.CFG. Your startup shortcut will consist of:
 +
  C:\comet\comet.exe /PN=SALES
 +
The .CFG extension is not required when specifying the shortcut.
 +
 
 +
The .CFG files must be stored in the Comet start up directory.  
==Migration From Legacy CFIG Files==
==Migration From Legacy CFIG Files==
The SYSGEN program contains a very useful feature for Comet users who want to migrate from the legacy format configuration files. SYSGEN can read a legacy CFIG file and create an INI file. This feature is not limited to a single CFIG file either. SYSGEN can read multiple CFIG files (from different nodes in a network, for example) and create a composite INI file that represents the master configuration for the entire Comet enterprise.
The SYSGEN program contains a very useful feature for Comet users who want to migrate from the legacy format configuration files. SYSGEN can read a legacy CFIG file and create an INI file. This feature is not limited to a single CFIG file either. SYSGEN can read multiple CFIG files (from different nodes in a network, for example) and create a composite INI file that represents the master configuration for the entire Comet enterprise.

Revision as of 17:29, 21 August 2008

The term SYSGEN refers to a method for creating and maintaining the system configuration file used by Comet Workstations. The SYSGEN process consists of three separate parts:

  • Creating a text file containing the configuration specifications.
  • "Compiling" this text file and creating configuration files; one file for each workstation.
  • Starting the Comet Workstation program using the configuration file.

Contents

The INI file

The text file containing the configuration information is referred to as the | INI file (pronounced "eye en eye" or "in ee"). This text file is not a Comet file. Typically this file is stored in the Comet Startup Folder, but it can be stored in another folder. As it is not a Comet File the file name should not be limited to 8 bytes, but it is not known what the limitations are on the length of the filename. Typically short names are used and often the name is simply COMET.INI. The file extension is typically INI, but again this is not a requrement. The file name must have an extension and that extension must be associated in Windows with a text editing program.

What's in the INI file?

The INI file contains all of the configuration information for your entire Comet enterprise. It includes groups of commands that specify the configuration for various parts of your Comet system. Here are the groups in an INI file: 

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

Each of these keywords represents the beginning of a group of additional keywords that specify the details of the Comet configuration. For example, the [DIRECTORIES] keyword is the beginning of a group of keywords that define the Comet directories that will be used in the configuration. See The INI file documentation for more information about these keywords.

Some of the major keywords are optional. Refer to the minimal INI file to see the minimum requirements to configure Comet.

Note: Two keywords that were supported in previous versions of Comet (MULTI-USER BOARDS and TERMINALS) are no longer supported.

Based on the information contained in the INI file, the SYSGEN program creates one configuration file for each node. If multiple nodes are defined, SYSGEN creates multiple configuration files. The node configuration files have .CFG extensions and the file name is the NAME coded in the NODE seqment.

It's important to note and understand that individual workstation configurations can contain different information. Thus some workstations can be prevented from accessing specific directories, or printers.

Starting Comet

To start Comet using a specific configuration file, you include the node name in the shortcut that starts Comet. The /PN= startup option, “profile name,” specifies the CFG file to be loaded. For example, suppose you have defined a node named SALES, and that SYSGEN has created a configuration file named SALES.CFG. Your startup shortcut will consist of: 

  C:\comet\comet.exe /PN=SALES

The .CFG extension is not required when specifying the shortcut.

The .CFG files must be stored in the Comet start up directory.

Migration From Legacy CFIG Files

The SYSGEN program contains a very useful feature for Comet users who want to migrate from the legacy format configuration files. SYSGEN can read a legacy CFIG file and create an INI file. This feature is not limited to a single CFIG file either. SYSGEN can read multiple CFIG files (from different nodes in a network, for example) and create a composite INI file that represents the master configuration for the entire Comet enterprise.

Retrieved from "http://wiki.signature.net/index.php/The_SYSGEN_configuration_utility"
Personal tools