Knowledgebase

Search:     Advanced search

Helix ALM Linux Configuration File Variable Values

Article ID: 354  |  Last updated: 26 Apr, 2017

This article includes definitions of all variables used with Helix ALM on Linux. The ttstudio.conf file is installed in the /etc directory. The install.pl script initially sets the required variable values. These definitions will help if you are manually installing or configuring Helix ALM.

Required variables are used by the Helix ALM Server and CGIs. These variables must exist in the .conf file. Optional variables can be used to define custom web installations, apply security, and allow optional project paths. All variables and values are case sensitive.

The ttcgi.exe and ttadmcgi.exe scripts can be renamed if your web server cannot run .exe programs. If you rename a file, make sure you update the .conf file with the new name. Also, make sure the login pages are updated with the new name and path.

Required variables

The following variables are required by the Helix ALM Server and the Helix ALM Web CGI.

Variable Description
admin-cgi-bin ttadmcgi.exe script name and location
AdminFormsPath Helix ALM Web Server Admin Utility location
ApplicationDirectory Helix ALM Server and project directory and files location
cgi-bin ttcgi.exe script name and location
FormsPath Helix ALM Web directory location
LogDirectory Startup.log file location
ServerAddress Helix ALM Server address
ServerDBType Format the server database is stored in. Valid values: 0 - Unknown (do not use); 1 - CodeBase; 2 - ODBC; 3 - Oracle Native; 4 - SQL Native; 5 - PostgreSQL Native; 6 - SQLite.
ServerName Default Helix ALM Server name configured in the registry utility CGI options
ServerPort Helix ALM Server port number
ServerRefID Numeric value incremented each time a server with the same universally unique identifier (UUID) accesses the server database. Helps avoid database corruption.
ShortDateFormat Helix ALM Web short date format

Required variable examples

admin-cgi-bin:/cgi-bin/ttadmcgi.exe
AdminFormsPath:/usr/local/apache/htdocs/ttweb/ttadmin
ApplicationDirectory:/usr/bin
cgi-bin:/cgi-bin/ttcgi.exe
FormsPath:/usr/local/apache/htdocs/ttweb/
LogDirectory:/var/log/Startup.log
ServerAddress:127.0.0.1
ServerDBType:6
ServerName:default
ServerPort:1566
ServerRefID:4
ShortDateFormat:%m%d%y

Optional variables

Variable Description
AdminHTMLPath Physical path to the alias location of Helix ALM Web Server Admin Utility HTML files. Use the following format: alias/sub-alias/sub-sub-alias. Do not start or end with /.
AllowPathForDB Indicates if full directory paths are used to create and add projects. Set to 1 to use full paths or 0 to use the default path.
AlwaysCreateNewUserIfEmailAddrDoesNotMatch Indicates if Helix ALM should match issue submitters to existing users or customers based on email address when importing issues from email, SoloSubmit, or SoloBug. Set to 1 to use the email address to find a match. If a matching email address is not found, Helix ALM creates a new local customer for the submitter. Set to 0 to use the first and last names to find a match.
ClientSessionIPCheck Indicates if multiple requests from the Helix ALM Client on the same computer with different IP addresses are rejected. Set to 1 to reject multiple requests and require users to disconnect from the initial session before reconnecting or 0 to allow multiple requests.
DefaultProjectsPath Physical path to the directory where the Helix ALM Server creates and stores new project directories. Use the following format: alias/sub-alias/sub-sub-alias. Do not start or end with /.
DestroyRDBMSProj Indicates if inactive projects are deleted from the RDBMS database when they are removed from the server. Set to 1 to permanently delete projects or 0 to leave projects in the database so they can be added again later. 
DisableExternProviderAccessAfterAttempts Number of attempts allowed before access to attach source control files from external providers is disabled. Helps prevent hackers from decrypting provider keys used to access Helix ALM data. EnableExternalProviderAccess must be set to 1.
DiskSpaceCritical Minimum disk space available on drives hosting theserver database and projects before a severe error is written to the server log. Disk space is checked every 24 hours.
DiskSpaceWarning Minimum disk space available on drives hosting the server database and projects before a warning is written to the server log. Disk space is checked every 24 hours.
EnableExternalProviderAccess Indicates if users are allowed to attach source control files to Helix ALM items from external providers, such as Git and Microsoft Team Foundation Server. Set to 1 to enable external provider access or 0 to disable access.
EscalationMaxExes Maximum number of processes that can run from escalation rules at the same time per project on the server
EscalationTimeOut How often the server should time out executables running from escalation rules
ExAuth Indicates if users can connect to the server from web clients using external authentication. Set to 1 to enable external authentication or 0 to disable it.
FontPaths Physical path to the font directory for reports and diagrams. Use the following format: alias/sub-alias/sub-sub-alias. Do not start or end with /.
HTMLPath Physical path to the alias location of Helix ALM Web HTML files. Use the following format: alias/sub-alias/sub-sub-alias. Do not start or end with /.
JavaProcessTimeoutSeconds How long the server should wait before timing out a Microsoft Word export.
JavaVMMaxSize Maximum amount of memory the Java Virtual Machine (JVM) can use during a Microsoft Word export.
LicenseServerAddress IP address or domain name of the computer the license server is installed on
LicenseServerPort Port number that clients use to connect to the license server
MaxListWindowItems Maximum number of items to display in a Helix ALM desktop client list window at a time. Increasing this value may impact server memory usage.
MaxReportSize Maximum size for generated reports. Generating large reports can cause performance issues. Do not change the value if you need to conserve server space.
MaxXMLExportFileSize Maximum size for exported XML files
PostSaveMaxExes Maximum number of processes that can run from triggers at the same time per project on the server
PostSaveTimeOut How often the server should time out executables running from triggers that run after items are saved to the database
PreSaveTimeOut How often the server should time out executables running from triggers that run before items are saved to the database
ReattemptRDBMSConnectionMinutes How long the Helix ALM Server should wait before attempting to connect to an RDBMS server if the initial connection is unsuccessful. There is a 20 second delay between each attempt.
RebootLicenseServerAddress License server IP address or domain name the Helix ALM Server should use next time it starts. This value is copied to the LicenseServerAddress variable when the Helix ALM Server starts. Change this value if you are moving the license server and do not want the Helix ALM Server to use the license server until it is restarted.
RebootLicenseServerPort License server port number the Helix ALM Server should use should use next time it starts. This value is copied to the LicenseServerPort variable when the Helix ALM Server starts.
RebootServerPort Used by the Helix ALM Server to determine the port to use at startup. Value is automatically added during installation.
RestoreExternProviderAccessMinutes Number of minutes to wait before restoring access to attach source control files from external providers if disabled after failed attempts
ServerPublicKey Key used when connecting to Helix ALM from web clients if RSA key exchange is enabled for the server. Copy the key from the file exported from the admin utility.
SkipWebConnectIPCheck Indicates if Helix ALM should skip a security check to ensure consistent IP address during web sessions. Set to 1 to skip the check or 0 to perform the check and drop connections if the IP address changes from the original login. Only applies if project options allow users to log in multiple times.
SMTPSendMailReplyWaitTime Number of seconds the Helix ALM Server waits for the SMTP mail server to respond when sending email
SOAPSecurityOverBackCompat Indicates if communication between the SOAP CGI and Helix ALM Server is encrypted using Diffie-Hellman key exchange (only supported in Helix ALM and TestTrack 2014.1 - 2016.1). Set to 1 to use Diffie-Hellman key exchange or 0 to use the encryption method used in earlier versions.
SOAPTempPath Physical path to the temporary directory used when attaching files to items using the Helix ALM SDK. Use the following format: alias/sub-alias/sub-sub-alias. Do not start or end with /.
SOAPUse64BitCookie Indicates if 64-bit cookies are used when SOAP applications communicate with the SOAP CGI to help prevent session hijacking attacks. Set to 1 to use 64-bit cookies or 0 to use 32-bit cookies.
TimeOutPooledConnectionMinutes Number of minutes of inactivity before the server times out pooled connections
tturlServerOverride Fully qualified domain name for the server computer to use in ttstudio hyperlinks. By default, the server computer name is used in the URLs, but you can change the value to give access to users outside your domain or to use a different computer name.
ValidatePooledConnectionMinutes How often the server maintenance thread should validate pooled connections
WebReloginIPCheck Indicates if users cannot log in to multiple web client sessions from different IP addresses. Set to 1 to reject login attempts by the same user from a different IP address than the original login or 0 to allow users to log in multiple times even if the IP address changes. Only applies if project options allow users to log in multiple times.

Optional variable defaults

AdminHTMLPath:ttweb/ttadmin
AllowPathForDB:0
AlwaysCreateNewUserIfEmailAddrDoesNotMatch:0
ClientSessionIPCheck:1
DefaultProjectsPath:TTServerDb/TTDbs
DestroyRDBMSProj:0
DisableExternProviderAccessAfterAttempts:2
DiskSpaceCritical:0
DiskSpaceWarning:0

EnableExternProviderAccess:1
EscalationMaxExes:40
EscalationTimeOut:60
ExAuth:0
FontPaths:/usr/lib/X11/fonts;/usr/share/fonts
HTMLPath:ttweb
JavaProcessTimeoutSeconds:300
JavaVMMaxSize:4096

LicenseServerAddress:127.0.0.1
LicenseServerPort:5100
MaxListWindowItems:100000
MaxReportSize:23
MaxXMLExportFileSize:2048
PostSaveMaxExes:20
PostSaveTimeOut:60
PreSaveTimeOut:30
ReattemptRDBMSConnectionMinutes:2
RebootLicenseServerAddress:127.0.0.1
RebootLicenseServerPort:5100
RebootServerPort:1566
RestoreExternProviderAccessMinutes:0
ServerPublicKey:publicKeyFingerprintFromServerAdmin
SkipWebConnectIPCheck:0
SMTPSendMailReplyWaitTime:20
SOAPSecurityOverBackCompat:0
SOAPTempPath:/tmp
SOAPUser64BitCookie:0
TimeOutPoolConnectionMinutes:30
tturlServerOverride:example.yourserver.com
ValidatePooledConnectionMinutes:5
WebReloginIPCheck:0

Article ID: 354  |   Last updated: 26 Apr, 2017
Tags
conf Linux variable CGI

Prev   Next
Helix ALM (formerly TestTrack)     User Notifications Not Sent for Unassigned Items