Parameter reference
File: /usr/local/stcpren/configs/config.json. Another file can be given with -config. See Configuration.
General
| Parameter | Type | Description |
|---|---|---|
applDir | text | Installation directory. Package default: /usr/local/stcpren. |
applLockDir | text | Directory of the lock control files, when lockType = filesystem. |
applLogDir | text | Text log directory. Used only in the local file mode (stcpgeminifile). |
applPidFile | text | PID file (optional). The -pid option takes precedence. |
applConfigPassPhrase | text | Key used to encrypt passwords. Sensitive data. Must be the same in the other products of the environment. See Password encryption key. |
applUser | text | Operating system user for the run. Package default: stcp. |
applGroup | text | Operating system group for the run. Package default: stcp. |
applUmask | text | Umask of the created files. Default: 0022. |
applDebug | integer | Highest level of the messages shown on standard error (stderr). 0 shows errors only; higher values show more detail. |
License | text | Path to the Riversoft STCP Gemini Rename license file. Sensitive data. |
cfgProvider
| Parameter | Type | Description |
|---|---|---|
cfgProviderType | text | Configuration mode: stcpgeminidb (database) or stcpgeminifile (local file). See Configuration modes. |
cfgInstanceName | text | Name of the associated instance. It is the same name used by Riversoft STCP Gemini Server (ApplName) or by Riversoft STCP DirectLink. |
cfgDbName | text | Configuration database name. Database mode only. |
cfgDbHost | text | Database server address. |
cfgDbPort | integer | Database port. |
cfgDbUser | text | Database user. |
cfgDbPswd | text | Database password. Sensitive data. |
cfgDbType | text | Database type, for example mysql or mssql. |
cfgDbOptions | text | Additional connection options, appended to the database name. |
In the database mode, messages are written to the log database configured in the instance.
lockProvider
| Parameter | Type | Description |
|---|---|---|
lockEnable | boolean | Enables lock control, which prevents concurrent runs on the same resources. |
lockType | text | in-memory keeps the lock in memory during the run; filesystem records the lock in a file in the applLockDir directory. |
cfgInstance
Local file mode (stcpgeminifile) only. Holds the instance parameters that, in the database mode, are read from the configuration database.
| Parameter | Type | Description |
|---|---|---|
Entity.Version | integer | Structure version. Use 2. |
Entity.Name | text | Instance name. |
Log.Verbose | integer | Highest level of the messages written to the log. |
Log.Console | integer | Highest level of the messages shown on the console. |
Log.External | integer | Highest level of the messages sent to the external log command (Log.ExecProg). 0 disables it. |
Log.ExecProg | text | External command that receives the log messages. |
Log.FilterRegEx, Log.FilterRegExNeg | text | Regular expressions that include or exclude messages from the external log command. |
Startup.SerialNumber | text | Instance serial number. |
Startup.ExternalLockEnable | integer | 1 enables lock control between processes. |
Startup.ExternalLockTimeout | integer | Maximum wait for the lock, in milliseconds. |
Startup.ExternalLockWait | integer | Interval between attempts to obtain the lock, in milliseconds. |
Startup.ExternalLockRetries | integer | Number of attempts to obtain the lock. |
Message levels
Each message has a numeric level; the lower the number, the more important the message. A message is recorded when its level is lower than or equal to the configured limit (Log.Verbose, Log.Console or applDebug).
| Level | Messages |
|---|---|
0 | Startup errors and conversion and export results. |
1 | Rule errors (LogLevelOnError default). |
6 | Rule successes (LogLevelOnSuccess default). |
7 | Rule warnings and information (LogLevelOnWarning and LogLevelOnInfo defaults). |
8 | Start and end of the run. |
128 | Tracing for diagnosis. |
The levels of the rule messages are set in the routing. See Rule reference.
kmsProvider
The kmsProvider section appears in the configuration templates, but it is not read in this version. Enter the values directly in config.json and protect the file. See Security.