CHECKPOINT_FLUSH

This keyword sets the maximum number of checkpoints to be written before a buffer (data or index) holding an image for a transaction controlled file will be flushed. A value of zero causes the buffer to be flushed at least by the occurrence of the first checkpoint written after the buffer update. Reducing the value of this system parameter reduces the amount of buffering, slowing system performance, but decreases the amount of work to be performed during recovery.

 

Default: 17

CHECKPOINT_INTERVAL

This keyword can speed up recovery at the expense of performance during updates. The interval between checkpoints is measured in bytes of log entries. It is ordinarily about one-third (1/3) the size of one of the active log files (L000....FCS). Reducing the interval speeds automatic recovery at the expense of performance during updates. The entry is interpreted as bytes if greater than 100 or as megabytes if less than 100. For example, CHECKPOINT_INTERVAL 2 sets an approximate 2MB interval, while CHECKPOINT_INTERVAL 150000 causes checkpoints about every 150,000 bytes of log file.

 

Deafult: 10 MB

COMM_PROTOCOL

Specifies a communications module loaded by the Server.

Possible values:

 

F_TCPIP

F_TCPIPV6

FSHAREMM

DISABLE

 

If no protocol is specified, then the default system communication protocol is used.

 

An application can override the default protocol by specifying the protocol in the connection string with the following syntax:

or

 

The c-tree Server can support TCP/IP and shared memory simultaneously. For example, the server could be communicating with some users locally through shared memory and others using TCP/IP over an Ethernet connection. Each protocol to be loaded by the c-tree Server requires a separate COMM_PROTOCOL line in the configuration script. The following example loads TCP/IP and Shared Memory Model protocols:

COMPATIBILITY TCPIP_CHECK_DEAD_CLIENTS

When this flag is present, the c-tree server recognizes when a connection between the client and the server is lost for any reason.

The c-tree server can automatically remove the connection and release the files and records related to the lost connection. See also DEAD_CLIENT_INTERVAL <seconds>.

COMPATIBILITY TDATA_WRITETHRU

When enabled, the c-tree server writes data files directly to disk, bypassing file system cache.

COMPATIBILITY TINDEX_WRITETHRU

When enabled, the c-tree server writes index files directly to disk, bypassing file system cache.

CONNECTIONS

The maximum number of connections to the c-tree Server. Typically, servers are activated to support up to one of the following values for concurrent user connections: 8, 16, 32, 64, 128, 256, 512, or 1024. However your particular c-tree Server may be customized with a different value for connections.

CONSOLE NO_SHUTDOWN_PROMPT

If present, ctsrvr will not prompt for administrator password when closed (Windows only).

CONSOLE TOOL_TRAY

If present, ctsrvr will start minimized in the system tray (Windows only).

CTSTATUS_MASK DYNAMIC_DUMP_FILES

Suppress the logging of the names of the files backed up by a dynamic dump operation.

CTSTATUS_SIZE

Approximate maximum size in bytes for CTSTATUS.FCS. When this limit is reached, CTSTATUS.FCS is renamed to T0000001.FCS and a new status file is created. The T#.FCS file numbers increase each time the limit is reached, similar to the transaction log files. For example, when the maximum size is reached, CTSTATUS.FCS is renamed to T0000002.FCS.

 

To limit the number of archived status logs, set a negative value for CTSTATUS_SIZE. Only T0000001.FCS will be kept, being replaced each time CTSTATUS.FCS is archived.

 

A value of 0 allows the file to expand to a size limited by the operating system and storage availability.

 

The default value is -32000000.

DAT_MEMORY

The memory allocated to the data cache, in bytes.

 

It’s possible to measure this settings in Kilobytes, Megabytes or Gigabytes by specifying the KB, the MB and the GB suffix respectively.

For example, the following values are equivalent:

 

The default value is 100 MB.

DEAD_CLIENT_INTERVAL <seconds>

The number of seconds of client idle time after which the server checks the connection for that client. The default nsec value is 1800 (30 minutes), with a minimum of 120 (2 minutes).

 

COMPATIBILITY TCPIP_CHECK_DEAD_CLIENTS is required to enable the checking. Otherwise, no check is made.

DELAYED_DURABILITY

When specified with a value greater than 0, the c-tree Server does not sync its log buffer simply because a transaction commits. Instead, it syncs the log buffer if it becomes full, or if a write to the data cache requires the log buffer to be flushed to disk, or if the maximum defer time in seconds specified by this keyword is exhausted.

DIAGNOSTICS SNAPSHOT_SHUTDOWN

Write system snapshots to the human-readable SNAPSHOT.FCS text file. The server writes a system snapshot to SNAPSHOT.FCS at the start of the server shutdown process. However, only the system snapshot is written. Snapshots for activated users and/or files are ignored.

This setting is recommend to establish baseline statistics over time.

FILES

The maximum number of data files and indices where each index counts toward this total. For example, an index file that supports three different keys (i.e., contains them as separate index members) counts as three files toward the total number of FILES.

 

Every time the c-tree server opens a new file, the counter is increased. If the c-tree server opens the same file for different clients, the counter is not increased.

 

The default value is 1000.

FUNCTION_MONITOR <YES | NO | file_name>

If YES, the client number, function number, function name, and file name are displayed in a scrolling fashion on the c-tree Server console screen. Alternatively, the same information, along with the return value and error codes for each function, can be routed to a file by specifying a file name. This keyword should be used primarily for debugging since this feature consumes additional overhead.

 

Default: NO

GUEST_LOGON

When no user ID is sent to the c-tree Server, the client is automatically assigned a user ID of GUEST. This keyword controls whether or not to permit GUEST logons. The keyword takes YES or NO for its arguments.

 

Default value in the installed ctsrvf.cfg: YES

Default value assumed if the entry is not present: NO

IDX_MEMORY

The memory allocated to the index cache, bytes.

 

It’s possible to measure this settings in Kilobytes, Megabytes or Gigabytes by specifying the KB, the MB and the GB suffix respectively.

For example, the following values are equivalent:

 

The default value is 100 MB.

LOCAL_DIRECTORY

Base directory for c-tree files. This directory is used to resolve all relative paths of c-tree files. If LOCAL_DIRECTORY is a relative path, then it‘s appended to c-tree Server’s working directory.

LOG_EVEN

The alternative name for even numbered transaction log files. This name must be in the form of an optional directory path and the single character ‘L’ (e.g., D:\LOG0\L). The c-tree Server appends a seven-digit even number and the extension .FCS to the name given here.

 

If a relative path is specified, it is relative to the defined LOCAL_DIRECTORY path, not the startup directory of the server.

LOG_ODD

The alternative name for odd numbered transaction log files. This name must be in the form of an optional directory path and the single character ‘L’ (e.g., D:\LOG1\L). The c-tree Server appends a seven-digit odd number and the extension .FCS to the name provided.

 

If a relative path is specified, it is relative to the defined LOCAL_DIRECTORY path, not the startup directory of the server.

LOG_SPACE

This is the number of megabytes of disk space allocated to storing active transaction logs, starting with a minimum of 2. The FairCom Server maintains up to 4 active log files, which consume, in the aggregate, up to LOG_SPACE megabytes of disk space. Log files are numbered consecutively starting with 1. The log file names are in the form L0000001.FCS.

LOG_TEMPLATE <n>

Enables transaction log templates. <n> is the number of log templates for the server to maintain. A value of 0 means no use of log templates. A value of two (2) means that two blank logs (L0000002.FCT and L0000003.FCT) would be created at first server startup in addition to the template (L0000000.FCT).

 

Default: 2

MAX_DAT_KEY

Maximum number of indices per data file.

 

The default value is 64.

MAX_FILES_PER_USER

The maximum number of data files and indices (where each index counts toward this total) per client connection.

 

The default value is 2048.

MAX_KEY_SEG

Maximum number of key segments allowed per index.

 

The default value is 16.

NONTRAN_DATA_FLUSH_SEC IMMEDIATE

When enabled, the c-tree server flushes updates for non-tran data files to file system as soon as possible in the background.

NONTRAN_INDEX_FLUSH_SEC IMMEDIATE

When enabled, the c-tree server flushes updates for non-tran index files to file system as soon as possible in the background.

PAGE_SIZE

The number of bytes per buffer page in bytes. Only the following values are accepted (all other values generate an error):

 

A file created with a larger PAGE_SIZE cannot be opened by a server with a smaller PAGE_SIZE.

 

The default value is 32768 in v12 and later (before v12, the default was 8192).

 

Since this setting affects also FCS files and SQL databases, after changing it you should restart the c-tree Server with a clean data folder. Alternatively you can convert the files in the data folder by following the procedure described in Faircom’s documentation at Adjusting PAGE_SIZE.

PLUGIN

Specifies a specially designed plugin module (a DLL or shared library) to be loaded and initialized at startup. The syntax is:

 

 

Where <Label> is the name used when referencing this plugin in CTSTATUS.FCS error messages and <DLL> is the library that will be loaded at server startup, and unloaded prior to shutdown.

 

Multiple PLUGIN entries can be specified.

SERVER_NAME

A name assigned to c-tree Server, instead of the default name.

 

The default value is FAIRCOMS.

SERVER_PORT

A port assigned to c-tree Server, instead of the default port.

 

The default value is 5597.

SETENV

Sets an environment variable within the server process.

 

This keyword is mainly used to configure the Java environment or SQL behavior. E.g.

 

 

Limits JVM memory.

SHMEM_DIRECTORY

On Unix systems, the c-treeRTG shared memory communication protocol creates a file that clients use to find the shared memory identifier for its shared memory logon region, and it creates named pipes for initial communication between client and server.

 

This option sets the directory in which c-tree stores files used for connecting using the Unix shared memory protocol.

 

This configuration option can include an environment variable name that will be substituted with its value when the configuration file is read.

 

Note - If SHMEM_DIRECTORY is set, clients must be able to find this non-default directory.

Client processes will check the environment variable CTREE_SHMEM_DIRECTORY. A client looking in the wrong location for shared memory information may take extra time to connect waiting for the shared memory protocol to timeout before falling back to TCP.

SORT_MEMORY

Specifies the size of sort buffers used by the FairCom Server. To conserve memory, set this value to 8192 or 4096. If large amounts of memory are available, the value can be increased significantly beyond the default.

 

It’s possible to measure this settings in Kilobytes, Megabytes or Gigabytes by specifying the KB, the MB and the GB suffix respectively.

For example, the following values are equivalent:

 

The maximum SORT_MEMORY value is 4 TB on 64-bit servers and 4 GB on 32-bit servers.

 

The default value is 100 MB.

SQL_DATABASE

Name of the database. By default this entry is set to "ctreeSQL". Database files are automatically created during the first startup. This name must be used by ctutil -sql* op-codes and external SQL tools to connect and operate with isCOBOL ISAM Server.

SQL_OPTION DROP_TABLE_DICTIONARY_ONLY

Affects SQL DROP TABLE command operation. This option retains files on disk when tables are dropped from the SQL dictionary. Use this option when you want to undo a DROP TABLE command. You can also use this option when you want files/tables to remain available in ISAM and not in SQL.

This option is particularly useful when using c-tree features, such as ctutil -sqlize, which may bring extra files into the SQL data dictionaries that later need to be dropped from SQL without removing them from disk.

SQL_OPTION HOT_ALTER_TABLE

Turn On Hot Alter Table by default on the SQL tables

SQL_OPTION LOAD_CALLBACK_LIB

Load the data type SDK callback library.

As the callback library is critical for proper data interpretation, when its loading is required by specifying the above configuration keyword, a failed load generates a panic condition and terminates the c-treeSQL Server operation with the following message logged in CTSTATUS.FCS:

SQL_OPTION OWNER_FILE_NAMES

Allow multiple users to create tables with the same name

SQL_PORT

A port assigned to c-tree Server for SQL connections, instead of the default port.

 

The default value is 6597.

START_EVEN

The alternative name for even numbered start file. The start file contains the location at which the automatic recovery routines begin to scan the transaction logs. There are two start files (numbered zero and one) to reduce the risk of losing the starting point for automatic recovery. This name must be in the form of a directory path and the single character ‘S’ (e.g., C:\START\S). The FairCom Server appends a seven-digit even number and the extension .FCS to the name provided.

 

If a relative path is specified, it is relative to the defined LOCAL_DIRECTORY path, not the startup directory of the server.

START_ODD

The alternative name for odd numbered start file. The start file contains the location at which the automatic recovery routines begin to scan the transaction logs. There are two start files (numbered zero and one) to reduce the risk of losing the starting point for automatic recovery. This name must be in the form of a directory path and the single character ‘S’ (e.g., C:\START\S). The FairCom Server appends a seven-digit even number and the extension .FCS to the name provided.

 

If a relative path is specified, it is relative to the defined LOCAL_DIRECTORY path, not the startup directory of the server.

SUBSYSTEM COMM_PROTOCOL SSL

Enables SSL communication. The following entries are required:

SERVER_CERTIFICATE_FILE to specify the path to the pem file

SSL_CONNECTIONS_ONLY to specify if only SSL is accepted or standard connections are accepted as well.

 

Example:

 

SUBSYSTEM EVENT DISK_FULL_ACTION

Allows server administrator to configure an external process to run when a disk-full limit is reached, for example, the process could write information to a log or notify the administrator.

 

The supported syntax is:

 

 

The volume, limit, and run parameters are required. The freq and maxruntime are optional.

 

 

TMPNAME_PATH

If set to a valid directory, this directory becomes the path for temporary files. If no directory is specified (default) then temporary files are created in the path of LOCAL_DIRECTORY.