Table of Contents Previous Next Index

Section 20 Editing LISTSERV Maestro INI Files

Section 20 Editing LISTSERV Maestro INI Files
The following rules apply to the lui.ini, hub.ini, tracker.ini, and tomcat.ini INI-files, which are the configuration files for the Maestro User Interface, Administration Hub, and Maestro Tracker components. (The my.ini configuration file of the internal MySQL database follows different rules since it’s a third party product. See the MySQL documentation for details.)
All INI-files are text files and assumed to be encoded in the default encoding for the platform being used. For most English/European installations that would be ISO-8859-1 [Latin 1 – Western European].
In the files, every parameter occupies one line. Each line must be terminated by a line terminator (LF, CR, or CRLF). All lines in the file are processed.
A line that contains only white space or whose first non-white space character is an ASCII “#” or “!” is regarded as a comment, and its content is ignored.
Every line other than a blank line or a comment line describes one parameter (except if a line ends with a backslash “\”, then the following line, if it exists, is treated as a continuation line, as described below).
A parameter always consists of a key and a value. Keys and values are separated by white space or “=” or “:”. Any white space around the separation character is also ignored.
All remaining characters on the line become part of the associated value. Some characters which otherwise have special meanings, need to be escaped with a backslash. The ASCII escape sequences “\t”(TAB), “\n”(LF), “\r”(CR), “\\”(backslash), “\"”(quotation mark), “\'”(apostrophe), “\ “(space), and “\uxxxx” (where “xxxx” is the Unicode-value of the required character, expressed in hexadecimal format) are recognized and converted to single characters.
In the case that the last character on a line is a “\”, then the next line is treated as a continuation of the current line; the “\” and line terminator is simply discarded, and any leading white space characters on the continuation line are also discarded and are not part of the parameter value.
Examples:
Each of the following four lines specifies the key "Truth" and the associated value "Beauty":
Truth = Beauty
Truth:Beauty
Truth :Beauty
Truth Beauty
The following three lines specify a single parameter:
fruits apple, banana, pear, \
cantaloupe, watermelon, \
kiwi, mango
The key is "fruits" and the associated value is:
apple, banana, pear, cantaloupe, watermelon, kiwi, mango
Note that a space appears before each “\” so that a space will appear after each comma in the final result; the “\”, the line terminator and leading white space on the continuation line are discarded and are not replaced by one or more other characters.
As a last example, the line:
cheeses
specifies that the key is "cheeses" and the associated value is the empty string.
20.1 Maestro User Interface INI-File Entries
The following table shows all possible entries of the lui.ini file for the Maestro User Interface component. For any entry that is missing in the INI-file, the corresponding default value is assumed. Changes in INI files require a restart of the component to take effect.
Table 20-1 Maestro User Interface INI-File Entries
Defines if the LISTSERV Maestro job ID should be included in the message ID of all outgoing emails or not. Set to either true or false.
Defines if the user is allowed to change the content charset on a job-by-job basis, or if he has to accept the default charset (see “DefaultMailCharset”).
Defines if the special bi-directional charsets”ISO-8859-6-i” and “ISO-8859-8-i” will be used in outgoing mail instead of their normal Iso-8859 counterparts.
Defines if the Maestro User Interface is allowed to store persistent cookies in the client browser so that the user interface may remember certain user settings between two sessions. If set to “false”, then these settings will be stored as session-cookies only and will be forgotten when the browser is closed.
Specifies whether or not a change log of subscriber activities (for hosted lists and datasets) is to be created.
(Optionally) If a change log file is used, then this defines the time period for each log (i.e. daily, weekly, monthly, or yearly).
Path-part of the click-through tracking URL used for URLs without passing of merged parameters.
Default: /trk/click
Path-part of the click-through tracking URL used for URLs with passing of merged parameters.
Default: /trk/click
Specify whether full personal profiles should be stored in the system database when personal tracking is used.
Default: true
Defines the basis for the calculation of the dashboard report lifetime, in minutes. For efficiency’s sake, a dashboard report is refreshed again only after its lifetime has expired. The lifetime until the next refresh is re-calculated after each refresh as a random value in the range from “baseTime” to “baseTime*1.5”.
Note: Tracking event reports do not use this base-time, as they determine their lifetime based on the event transfer interval instead.
Default: 4 (i.e. by default the actual dashboard lifetime is a random value in the range between 4 and 6 minutes.)
Defines the language that is to be used for the membership area subscriber pages of all datasets that do not have their own membership area language defined. The language must be specified using its corresponding two-letter ISO language code (in lower case), as defined by the alpha-2 code of ISO-639-1 (see http://www.loc.gov/standards/iso639-2/php/English_list.php).
Default: “English (Default)”
Defines the charset that is to be used as the charset of the content for newly created jobs that are not copies of existing jobs. May or may not be changed by user (see “AllowCharsetChoice”).
Default: ISO-8859-1
Defines if distribute chunking will be performed and with which chunk size. A chunk size of zero or less means that no distribute chunking will be performed. A positive non-zero chunk size means that chunking will be performed with chunks of the given size, but with a minimum size of 10000 (i.e. any positive chunk size less than 10000 will be treated as if 10000 had been specified).
Determines how often the system looks for (and cleans out) expired unconfirmed subscriptions to hosted tables and lists (i.e., subscriptions that were not confirmed during the given expiration interval – see INI-file parameter OptInConfirmationExpiration). Specified as a number, which defines the cleanup interval length in “hours” (i.e., every “N” hours the system checks for expired subscriptions and cleans them out).
See the LISTSERV Maestro Data Administrator’s Manual for more information about subscription confirmations.
The host name of the Maestro User Interface server as seen by clients that access the user interface with a web browser. To be used if clients shall access the server with a different host name than the normal internal host name of the server, for example when using a proxy.

Default: The value of the HostName parameter, if present. Otherwise the normal host name (canonical host name) of the server running the Maestro User Interface.
The HTTP (or HTTPS) port of the Maestro User Interface server as seen by clients that access the user interface with a web browser. To be used if the external port of the server is different than the default for the protocol employed (both if the normal HTTP or the secure HTTPS protocol is employed).
Default: 80 (if the protocol is HTTP) or 443 (if the protocol is HTTPS)
Defines if HTTPS is used as the access protocol for the Maestro User Interface web-interface pages. Set to “true” if HTTPS is used, or “false”, if normal HTTP is used.
Default: subfolder “lui” in installation folder
The host name of the local machine that is to be used whenever a name is required to identify the local host (and no other INI-parameter overrides this for a specific purpose).
Default: normal host name (canonical host name) of the server running the Maestro User Interface.
The host name of the Administration Hub server as seen by clients that access the hub interface with a web browser. To be used if clients shall access the hub server with a different host name than the normal internal host name of the server, for example if the server has several names or when using a proxy.
Default: the host name defined by the RegistryHubHost parameter. If that parameter is not present either, the normal host name (canonical host name) of the server running the Maestro User Interface.
The HTTP (or HTTPS) port of the Administration Hub server as seen by clients that access the hub user interface with a web browser. To be used if the external port of the server is different than the default for the protocol employed (both if the normal HTTP or the secure HTTPS protocol is employed).
Default: 80 (if the protocol is HTTP) or 443 (if the protocol is HTTPS)
Defines if HTTPS is used as the access protocol for the Administration Hub web-interface pages. Set to “true” if HTTPS is used, or “false”, if normal HTTP is used.
Internal communication port (RMI-Port) of the Administration Hub server.
Default: 1099
Defines the folder under which the Maestro User Interface component stores the log files.
Default: The "logs" subfolder of the LUI home folder (i.e., by default, the subfolder "lui/logs" of the installation folder).
The expiration time for unconfirmed subscriptions to hosted datasets and lists – i.e., the amount of time after the initial subscription request during which the subscriber may confirm the subscription (“double opt-in”) before the subscription request expires and is removed. Specified as a number, which defines the expiration time in hours.
Default: 48
See the LISTSERV Maestro Data Administrator’s Manual for more information about subscription confirmations.
Password for remote log file access.
Default: none (no remote log file access allowed)
Path name of the folder containing the backup that shall be restored during the next startup. Note: This key will be automatically removed from the INI-file during the next startup.
Define if the “Currently in the system” section of the dashboard is supposed to display the current count of events in the system or not. On systems with a lot of events, the calculation of this count may be slow, thus slowing down the dashboard display. In this case it may be a good idea to disable the display of this count by supplying “false”.
Defines if HTTPS is used as the access protocol for the TRK component (i.e. for the tracking URLs). Set to “true” if HTTPS is used, or “false”, if normal HTTP is used.
Determines how often the system looks for (and cleans out) subscribers of hosted LISTSERV lists that have unsubscribed by email (i.e. not by the LISTSERV Maestro web interface). Specified as a number, which defines the cleanup interval length in “minutes” (i.e., every “N” minutes the system checks for unsubscribed subscribers and cleans out their data.)
See the LISTSERV Maestro Data Administrator’s Manual for more information about subscription confirmations.
20.2 Administration Hub INI-File Entries
The following table shows all possible entries of the hub.ini file for the Administration Hub component. For any entry that is missing in the INI-file, the corresponding default value is assumed. Changes in INI files require a restart of the component to take effect.
Table 20-2 Administration Hub INI-File Entries
Home folder in which work-files are kept.
Default: subfolder “hub” in installation folder
The host name of the local machine that is to be used whenever a name is required to identify the local host (and no other INI-parameter overrides this for a specific purpose).
Default: normal host name (canonical host name) of the server running the Administration Hub.
Defines if LISTSERV Maestro will run in lite-mode or not. Only in lite-mode will LISTSERV Maestro accept lite-LAKs during login to LUI. Set to true for lite-mode or false for full-mode.
Defines the folder under which the Administration Hub component stores the log files.
Default: The "logs" subfolder of the HUB home folder
(i.e., by default, the subfolder "hub/logs" of the installation folder).
The domain name with which the Administration Hub component stores its settings in its own registry.
Default: HUB
Password for remote log file access.
Default: none (no remote log file access allowed)
Internal communication port (RMI-Port) of the Administration Hub server.
Default: 1099
20.3 Maestro Tracker INI-File Entries
The following table shows all possible entries of the tracker.ini file for the Maestro Tracker component. For any entry that is missing in the INI-file, the corresponding default value is assumed. Changes in INI files require a restart of the component to take effect.
Table 20-3 Maestro Tracker INI-File Entries
Set this key to “true” if you want Tracker to check the user-agents table for consistency and to repair it (if there is any file corruption found). Tracker will notice the key during the next startup and perform the check/repair during the startup.
Home folder in which work-files are kept.
Default: subfolder “trk” in installation folder
The host name of the local machine that is to be used whenever a name is required to identify the local host (and no other INI-parameter overrides this for a specific purpose).
Defines the folder under which the Maestro Tracker component stores the log files.
Default: The "logs" subfolder of the TRK home folder (i.e., by default, the subfolder "trk/logs" of the installation folder).
The domain name with which the Maestro Tracker component stores its settings in the Administration Hub registry.
Default: TRK
Password for remote log file access.
Default: none (no remote log file access allowed)
20.4 Tomcat INI-File Entries
The following tables show all possible entries of the tomcat.ini file for Tomcat. For any entry that is missing in the INI-file, the corresponding default value is assumed. Changes in INI files require a restart of the component to take effect.
20.4.1 Basic Tomcat Configuration Parameters
The following table shows the basic entries of the tomcat.ini file for Tomcat.
Table 20-4 Basic Configuration for Tomcat INI-File Entries
The local IP-address that the server shall bind to (i.e. the server will accept connections only if directed to this IP Address).
Default: By default, the server binds to all addresses of the local computer (i.e. accepts connections on all of these addresses).
The maximum size (in bytes) that the server will accept in a POST request (i.e. the maximum size of bytes that be uploaded to the server). The limit can be disabled by setting to a value less than or equal to 0.
Default: 1 (i.e. the limit is disabled by default).
Default: 80 (for HTTP) or 443 (for HTTPS).
Restrict.CONTEXT.N
Restrict access to component specified by “CONTEXT” (HUB, LUI, TRK, and LIST) to certain IP addresses.
Defines if the server is supposed to be secure (true) or not (false). A secure server uses the HTTPS protocol; a non-secure server used the normal HTTP protocol.
Only used if “SecureServer=true”.
The name of the keystore-file that contains the server certificate to be used for the HTTPS protocol. The file must exist and must contain a usable server certificate. The given filename must include the full absolute path to the file (for Windows, include the drive letter).
Default: [install_folder]/conf/keys.keystore
Only used if “SecureServer=true”.
Default: changeit
20.4.2 Advanced Tomcat Configuration Parameters
The following table shows the advanced entries of the tomcat.ini file for Tomcat. Do not change these unless instructed by L-Soft Support.
Table 20-5 Advanced Configuration for Tomcat INI-File Entries
The maximum queue length for incoming connection requests when all possible request processing threads are in use. Any requests received when the queue is full will be refused.
The number of milliseconds during which the sockets used by the server will linger when they are closed. Socket linger can be disabled by setting this entry to “1”.
Default: 1 (disabled by default)
Defines the number of milliseconds the server will wait, after accepting a connection, for the request URI line to be presented.
Default: 60000 (60 seconds)
The maximum number of HTTP requests which can be pipelined until the connection is closed by the server. Setting this entry to “1” will disable HTTP/1.0 keep-alive as well as HTTP/1.1 keep-alive and pipelining. Setting this entry to “-1” will allow an unlimited amount of pipelined or keep-alive HTTP requests.
The maximum number of unused request processing threads that will be allowed to exist until the thread pool starts stopping the unnecessary threads.
The maximum number of request processing threads to be created by this server (i.e. the maximum number of simultaneous requests that can be handled).
The number of request processing threads that will be created when the server is first started. The server will also make sure that it has the specified number of idle processing threads available. This entry should be set to a value smaller than that for the “MaxThreads” entry.
Defines the type of the keystore-file. Possible types are “JKS” or “PKCS12”. Usually you should use keystore files of the “JKS” type.
Defines the version of the SSL protocol to use. Possible versions are “TLS” and “SSL”. It is recommended to always use the “TLS” protocol.