SERVICE

Yes

SERVICE specifies the name of the service in Site.Service format.

SITE.APPS

SVC_PORT

Yes

The SVC_PORT keyword specifies the UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.

6011

REDUNDANT

No

REDUNDANT indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services.

• Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment.
• Set to FALSE or commented out to disable Redundancy for this service.

See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor.

The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.

FALSE

ACS

Yes

The Site and Service name of the service’s ACS, in Site.Service format.

SITE.ACS

AUD

No

The Site and Service name of the service’s AUD, in Site.Service format.

SITE.AUD

TRS

Yes

The Site and Service name of the service’s TRS, in Site.Service format.

SITE.TRS

ELS

Yes

The Site and Service name of the service’s ELS, in Site.Service format.

SITE.ELS

MSS

Yes

The Site and Service name of the MSS from which commands will be accepted, in Site.Service format.

SITE.MSS

LOGMASK_ELS

Yes

Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values. The LOGMASK_ELS (LMask ELS) info item will report the value of this keyword.

See LOGMASK_ELS in the Logging section for more information.

CONTROL EXCEPTIONS

LOGMASK_FILE

Yes

Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values. The LOGMASK_FILE (LMask File) info item will report the value of this keyword.

See LOGMASK_FILE in the Logging section for more information.

CONTROL EXCEPTIONS WARNING

LOGFILE_FILE_COUNT

Yes

Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100. The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.

See LOGFILE_FILE_COUNT in the Logging section for more information.

2

LOGFILE_LINE_COUNT

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000. The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.

See LOGFILE_LINE_COUNT in the Logging section for more information.

1000000

LOGFILE_MODE

Yes

Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY. The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.

See LOGFILE_MODE in the Logging section for more information.

LEGACY

LOGFILE_LIMIT_MODE

Yes

Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword). The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.

The default value is LINE.

See LOGFILE_LIMIT_MODE in the Logging section for more information.

LINE

LOGFILE_FILE_SIZE

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file. The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.

See LOGFILE_FILE_SIZE in the Logging section for more information.

100

DBS_MAIN_SEC_EVENT

Yes

The main security event for this application. The value must be all uppercase, with a maximum of 8 characters.

ACCESS

ACS_ID

Yes

The User ID of the service. This keyword is required for performing security events.

APPS

ACS_APPLICATION

Yes

The service’s application name for security.

APPS

DBS_SEC_EVENT_1

No

Secondary security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_2

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_3

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_4

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_5

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

CHANGE_QUEUE_SIZE

No

CHANGE_QUEUE_SIZE sets the size of the service change queue that contains the incremental changes to the data in the source service. This is the number of changes the service will store to answer replication requests before expiring the oldest changes.

The CHANGE_QUEUE_SIZE (Change Update Queue Size) info item will report configured size of the service change queue.

50000

REPL_SOURCE

No

The REPL_SOURCE keyword specifies the Domain and Site.Service name for the source service to be replicated in the format [DDDD]SITE.SERVICE. The REPL_SOURCE value requires the same service name, with a different domain prefix. If not specified, replication is disabled. Applies to all services except ARS, FMS, and RSM.

The REPL_SOURCE (Repl Source Service) info item will report the source service name from which the replicated service is requesting changes.

None

REPL_CHECK_INTERVAL

No

REPL_CHECK_INTERVAL indicates the interval (in seconds) to check before performing the next replication synchronization. This value determines the replication synchronization frequency.

After performing a sync, a replicating service will subtract the amount of time the sync took from the check interval time to determine how long to wait until the next sync. For example, if the check interval is 60 seconds and the sync takes 40 seconds, the service will only wait 20 seconds before starting the next sync. If the whole sync time exceeds the frequency, then the replicating service will wait for half the sync interval (30 seconds in this case) before starting the next sync.

The REPL_CHECK_INTERVAL (Repl Poll Secs) info item will report the interval that a replicated service will check the source change queue for new updates. If the service is not replicating REPL_CHECK_INTERVAL will respond with an empty string.

60

REPL_DELAY_MAX

No

REPL_DELAY_MAX indicates the number of seconds a service is allowed to be behind in replication before it is considered to be behind. If this keyword is disabled, the value defaults to double the REPL_CHECK_INTERVAL time. Best practice recommends enabling and setting a meaningful value for REPL_DELAY_MAX for all replicating services. A recommended value would be a longer time interval than you would expect any sync interval to take.

The REPL_DELAY_MAX (Allowed repl delay) info item will report the time elapsed since the service was last fully in sync. Time is calculated as the delta between "now" and the end of the last full sync that has completed. If the time since the last successful sync exceeds the REPL_DELAY_MAX value, and the REPL_INT_VAL_STATE (Int repl val state) info item is currently "Normal", then the REPL_INT_VAL_STATE info item is set to "Delayed." The state can only be set back to "Normal" when the time between two syncs is less than the REPL_DELAY_MAX time.

120

REPL_RETRY_SECS

No

REPL_RETRY_SECS specifies the interval (in seconds) for retrying a replication update that failed.

5

REPL_ERR_QUEUE_MAX

No

REPL_ERR_QUEUE_MAX specifies how many error entries are allowed in temporary storage. When this number is exceeded, replication processing will only process the error queue, nothing else. No new notifications will be accepted, and if a resynchronization is in progress, it will be suspended.

100

AUDIT_LEVEL

No

AUDIT_LEVEL sets auditing level of messages written to the AUD service. When set to 0, auditing is off. The AUDIT_LEVEL info item reports the value of this keyword.

1

BACKUP_PATH

No

BACKUP_PATH specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist.

None

BACKUP_TIME

No

BACKUP_TIME specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS.

None

COPY_BACKUP_TO

No

COPY_BACKUP_TO enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine.

None

DBS_DATADICT_FILE

No

The name of the Data Dictionary Language (.ddl) file. This keyword is required if the service name is different from the .ddl file name prefix.

BSS.DDL

DBS_DATABASE_FILE

No

The file name of the primary database, including the extension .dat. The service will add the extension .edb.

ServName.dat

DBS_INDEX_FILE

No

The file name of the primary database index, including the extension of .inx. The service will add the extension .edb.

ServName.inx

DBS_TEMPSTOR_FILE

No

The file name for temporary storage, including the extension .ts. The temporary storage file contains uncommitted edits. The service will add the extension .edb.

ServName.ts

DBS_LOCK_TIMEOUT

No

DBS_LOCK_TIMEOUT specifies how long (in seconds) the time locks are valid. The default value is 1800 seconds, which is 30 minutes.

1800

MAX_CONCURRENT_MSGS

No

MAX_CONCURRENT_MSGS sets the maximum number of concurrent messages allowed between the client and server.

To determine the value to set for this keyword, you can assess real-time active message counts by viewing the Act Msgs value (SRVNET_ACT_MSGS (Act Msgs) info item, displayed on the Network and Service Generic pages of the CygNet Service Information dialog box), and trend the count values over time using the SVMAMSG point (SVCMON UDC, analog input type). See Trending Point Data for more information.

See CygNet Client Monitor for more information about usage of this value when updating CygNet client applications.

20

DBS_DISK_CACHE_IN_MEGS

Yes

DBS_DISK_CACHE_IN_MEGS specifies the maximum amount of memory that the system will allocate for the disk cache in megabytes. See Buffer Cache Management for more information.

The DBS_FILE_CACHE_MAX (DBS file cache max) info item will report the value of this keyword.

100

DBS_MIN_DISK_CACHE_IN_MEGS

No

DBS_MIN_DISK_CACHE_IN_MEGS specifies the minimum amount of memory that the system will allocate for the disk cache in megabytes. Controls how eager the DBS’s data cache will be to consume memory in the absence of other memory pressure in the system.

1

DBS_FILESYSTEM_CACHE_USAGE

No

DBS_FILESYSTEM_CACHE_USAGE allows a DBS to configure its database engine with a small dedicated cache and allows Windows to donate spare memory to further improve the caching of database data. See Buffer Cache Management for more information about Windows File System Cache usage.

• Set to ON to enable the usage of the Windows File System Cache.
• Set to OFF to disable the feature entirely.
• Set to HEURISTIC to follow the 10% model used by the DBS_DISK_CACHE_IN_MEGS keyword, described here.

HEURISTIC

DBS_TRANSACTION_LOG_SIZE

Yes

DBS_TRANSACTION_LOG_SIZE specifies the size (in megabytes) of each log file in the txlogs directory. CygNet recommends using the DbsTxLogManagement utility to change the keyword. Run a backup soon after changing the size value.

5

DBS_TRANSACTION_LOG_DIR

No

DBS_TRANSACTION_LOG_DIR sets the directory where the transaction log files are stored. You cannot specify the main service directory, but it can be a subdirectory or another location. You can specify a different (faster or smaller) drive, or another location if the txlogs directory is being used for something else.

The DBS_TRANSACTION_LDIR (TxLogs Folder) info item can be used to retrieve the fully qualified path.

txlogs