General Setting

<< Click to Display Table of Contents >>

Navigation:  Administration > INI File >

General Setting

Previous pageReturn to chapter overviewNext page

 

DEBUG_MODE

When set to Y then the output bar contains network and trace tabs.

This setting also activates creation on additional log file (Debug.log) in the log directory.

 

SERVER_MSG_LEVEL

Sets message level of the server.

 

SERVER_TCP_LEVEL

Sets TCP/IP message level of the server.

 

ALLOW_RELOAD

When set to Y then the Reload button is displayed in the caption bar when more records than specified by the limit satisfy your filter criteria.

 

ALLOW_CREATE_LGN

When set to N then it is not possible to create LGN files at Logon dialogs. By default this feature is enabled.

 

SECURITY_INTERFACE

When set to Y then the Logon window offers only the TCP configuration files. The user name and password is provided by the security interface.

When set to N then the Logon window requires to enter the TCP configuration file, user name and password.

When set to OPT then the Logon window offers both methods - you can enter the user name and password and also use the security interface.

 

FREE_SQL

When set to N then the application doesn't allow to execute free SQL commands from the console.

 

APP_WIDTH

Sets the width of the main window in pixels. It is ignored when it is not set.

 

APP_HEIGHT

Sets the height of the main window in pixels. It is ignored when it is not set.

 

APP_TITLE

Sets the new title of the program. If it is not set then SmartIS PC Client is used as the default.

 

CONFIG_DIRECTORY

Specifies a directory where the License Key File, TCP configuration files, admin.xml or administrator's notes are located.
If this option is empty then SmartIS PC Client searches for these files in the directory where it is installed.

You can also use any environment variable defined in the operating system. For example %APPDATA% and others.

 

PROFILE_DIRECTORY

Specifies a directory where the local configuration file (Setting.xml) is stored. This file is created and maintained by the SmartIS PC Client.
If %USERNAME% variable is found in the path then it is replaced with the current Windows user.

You can also use any environment variable defined in the operating system. For example %APPDATA% and others.
Sample:
PROFILE_DIRECTORY=\\192.168.111.3\Profile\%USERNAME%
If this option is empty then the SmartIS PC Client creates Setting.xml file in the standard path in the user's home directory.

 

ARCHIVE_LOG_FILES

Specifies how log files are archived. If the value equals zero or when it is not specified then log files are not archived but are overwritten when the program starts.

If a non zero integer value is specified then the log files are kept for the requested number of hours. Older logs are deleted automatically on the program's startup.

In this case the log file names contain also the creation timestamp.

Sample:

ARCHIVE_LOG_FILES=24     keeps logs for one day

ARCHIVE_LOG_FILES=168   keeps logs for one week

ARCHIVE_LOG_FILES=       disables the archiving
 

INACTIVITY_TIMEOUT

When it is not empty then it sets the time in minutes in which the client automatically disconnects from the server in case of network inactivity.

 

RCV_TIMEOUT

When it is not empty then it sets the timeout of Receive function in seconds. The default value is 10 seconds, which should be sufficient in most cases.

 

PRINTER

Sets the default printer. The value set by this option has higher priority than the system default printer.

 

EXPIRATION_WARNING

Sets how many days before the license expiration a warning should be displayed. Default value is 30 (when nothing is explicitly specified).

 

USERISSTEPNAME

When set to Y then the user name is used as a stepname in the task started on the host.

 

HELP_FORMAT

When it equals CHM (the default) then the help displayed after pressing F1 is in CHM format. This can cause sometimes troubles when the program runs from a remote drive, because Windows block the content for security reasons. If this happens, you can try to set PDF help format (HELP_FORMAT=PDF) or HTML format (HELP_FORMAT=HTML). In this case the help is opened with Adobe Reader or with your default web browser.

 

TCPCOMMONNAME

The XINFO client evaluates the Common Name (CN) of the subject attribute of the server certificate to validate the server hostname during server authentication at connection start. The TCPCOMMONNAME parameter of the client controls the evaluation of the Common Name of the presented server certificate. TCPCOMMONNAME=* disables the Common Name check and the client accepts all presented certificates. Any other value of TCPCOMMONNAME must match with the Common Name of the presented certificate to accept it. The Subject Alternative Name certificate extension is ignored and not used for server hostname validation.

 

TCPCRYPT

Sets the crypt mode. Allowed values are:

TCPCRPYT=1: Strong password encryption. Passwords on the host can have up to 8 or 14 - 100 characters. No TLS.

TCPCRYPT=2: (reserved)

TCPCRYPT=3: Strong password and data encryption with TLS. Passwords (1-8) and passphrases (14-100) are supported. It requires ROTISHB module on the host for XINFO 4.1 and HORILST module from XINFO 4.2 and all newer releases.

TCPCRYPT=4: Authentication via smart cards. Data encryption with TLS. It requires ROTISHB module on the host.

 

TCPTLSSECLEVEL

Sets the internal OpenSSL security level (default is 1). Security level 1 requires a minium of 80 bits of security therefore older TLS versions 1.0 or 1.1 no longer work. Please specify security level 0 to support it.

 

TCPPEMCA

Specifies the file containing the trusted certificates to use during server authentication. The certificates can be concatenated and need to be in PEM format.

If the value is empty the Windows Certificate Store (Trusted Root Certification Authorities) is used instead.

Please make sure the root certificate of the server certificate can be found either in the file specified or the Windows Certificate Store.

Sample:

TCPPEMCA=hor-ca.pem.crt

In case the value contains a relative path and CURRENT_DIRECTORY option is set then it is relative to this directory.
When CURRENT_DIRECTORY is not set then it is relative to the program directory.

 

CRYPTKEY

Specifies a path of the key used by the encrypting algorithm. This file must be securely stored on the file system so that only users who are really allowed to view/edit it have access to it. The key is used for encryption and decryption of logon files used by scripts. If the key is not set then libchdk-1.dll library is used for encryption. If even this library is not present (it is included only in AES package) then logon files can't be used and scripts can't connect to the server. The key can be created by Generate key command available on Home ribbon bar.

 

PKI_INTERFACE

Sets the PKI interface type. Allowed values are:

PKI_INTERFACE=capi

PKI_INTERFACE=capi_store

PKI_INTERFACE=pkcs11

PKI_DEFAULT_KEY_NAME

PKI_DEFAULT_KEY_TYPE

Sets the default key name and key type. If these values are set and the key is found on the card, it is selected automatically.

 

PKI_CAPI_CSP_NAME

Sets the provider name. For example:

PKI_CAPI_CSP_NAME=Microsoft Base Smart Card Crypto Provider

 

PKI_PKCS11_MODULE_DLL

Sets the name of DLL library in case pf PKCS interface type. For example:

PKI_PKCS11_MODULE_DLL=itp11.dll

 

PKI_REMEMBER_KEY

When this option equals Y then the program remembers the selected key and reuses it if a new connection is established.
Otherwise, when there are more keys on the smart card, you have to select the key whenever you connect.

 

PKI_KEY_USAGE_FILTER_TYPE

Defines the filter type for the certificate key usage extension. It can be used to limit the number of keys displayed. Only keys corresponding to certificates matching the following filter values are displayed.

Allowed values:

oall: All certificates regardless of the key usage extension are accepted and the value of the PKI_KEY_USAGE_FILTER is ignored (this value provides the same results than with older versions).

oexact: Only certificates that match the key usage value specified by the PKI_KEY_USAGE_FILTER setting are accepted.

oexact_none: Only certificates that match the key usage value specified by the PKI_KEY_USAGE_FILTER setting and in addition certificates that have no key usage extension are accepted.

 

PKI_KEY_USAGE_FILTER

Defines the allowed value of a certificate key usage. The value can be a (bit) mask which means that all (bit) values have to be present in the certificate key usage. If the value is prefixed with 0x than it is interpreted as hex value otherwise it is interpreted as decimal. The pre-defined value of 0x80 for example means that only certificates intended for digital signatures are allowed.

 

PKI_EXT_KEY_USAGE_FILTER_TYPE

Defines the filter type for the certificate extended key usage extension. It can be used to limit the number of keys displayed. Only keys corresponding to certificates matching the following filter values are displayed.

Allowed values:

oall: All certificates regardless of the extended key usage extension are accepted and the value of the PKI_EXT_KEY_USAGE_FILTER is ignored (this value provides the same results than with older versions).

oexact: Only certificates that match the extended key usage value specified by the PKI_EXT_KEY_USAGE_FILTER setting are accepted.

oexact_none: Only certificates that match the extended key usage value specified by the PKI_EXT_KEY_USAGE_FILTER setting and in addition certificates that have no extended key usage extension are accepted.

 

PKI_EXT_KEY_USAGE_FILTER

Defines the allowed value of a certificate extended key usage. The value is of type numerical identifier (NID). The pre-defined value of 1.3.6.1.5.5.7.3.2 for example means that only certificates intended for Client Authentication are allowed.

 

 

To enable PKI you have to set TCPCRYPT=4. Even when PKI options are defined in the INI file the PKI is disabled until the crypt mode is set to 4.

It is also possible to set the crypt mode in TCP file.

 

 

The complete sample:

DEBUG_MODE=Y

FREE_SQL=Y

ALLOW_RELOAD=Y

SECURITY_INTERFACE=N

SERVER_MSG_LEVEL=0

SERVER_TCP_LEVEL=0

APP_WIDTH=

APP_HEIGHT=

APP_TITLE="PC Client by HORIZONT"

CONFIG_DIRECTORY=

PROFILE_DIRECTORY=

ARCHIVE_LOG_FILES=

INACTIVITY_TIMEOUT=

PRINTER=

EXPIRATION_WARNING=

HELP_FORMAT=CHM

TCPCOMMONNAME=dummy

TCPCRYPT=4

TCPPEMCA=hor-ca.pem

PKI_INTERFACE=capi

PKI_DEFAULT_KEY_NAME=

PKI_DEFAULT_KEY_TYPE=

PKI_CAPI_CSP_NAME=Microsoft Base Smart Card Crypto Provider

PKI_PKCS11_MODULE_DLL=itp11.dll

PKI_REMEMBER_KEY=N