Share this page
Initialization files
This topic describes the initialization files for the StarTeam client and server.
Overview of initialization files
Initialization files are stored at different locations on different Microsoft Windows platforms. On Microsoft Windows 2008+, the pathPrefix is C:\Documents and Settings\.
| ClientLicenses.st | Located at %PROGRAMDATA%\Borland\StarTeam\ClientLicenses.st. This file is installed by StarTeam Runtime and the application clients. If the ClientLicenses.st file is missing, you are asked to register the product. |
| ConnectionManager.ini |
Used for starting the application and is located at %PROGRAMDATA%\Borland\StarTeam\ConnectionManager.ini. This file contains information that the client must be able to locate in order to run. It is created at the time that the application is installed. In actual ConnectionManager.ini files, the x’s are replaced by hexadecimal numbers. If the ConnectionManager.ini file is missing or corrupted, the application asks if you want it recreated. Reinstallation can also recreate the missing ConnectionManager.ini file. For example: [ConnectionManager] WorkstationID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| starteam-client-options.xml | Located at %APPDATA%\Borland\StarTeam\starteam-client-options.xml. |
| starteam-server-configs.xml | Used for server session information, is located at Server Installation Folder\starteam-server-configs.xml. |
| starteam-servers.xml | lists the server configurations for which you have created (or will create) server descriptions. These descriptions are used while opening or creating projects. This file is located at %PROGRAMDATA%\Borland\StarTeam\ServerList and is installed by StarTeam Runtime and the application clients. |
starteam-client-options.xml
This file is installed by StarTeam Runtime and the application clients. The starteam-client-options.xml file lists personal option settings and any alternate working folders you have set with the application (accessed by selecting ). You may want to back up this file or put it under version control. If the starteam-client-options.xml file is missing, the application automatically recreates it. However, the recreated file contains only the default settings for the personal options and no alternate working folder information. If the starteam-client-options.xml file is corrupted, you can delete it, but you may be able to edit it. You can tell that the starteam-client-options.xml file is missing or corrupted when your personal options are no longer correct, changes you made to personal options disappear when you restart the application, files do not change even though you have checked them out (because they have been copied to the wrong working folders), or the application reports that old files are missing and does not see new files, because it is looking for them in the wrong place.
The options that are check boxes in the dialog are set equal to 1 for selected or 0 for cleared. Intervals are set to a number of minutes or seconds depending on the option. Paths are in text. No quotation marks are used with the text.
For example, the Project Component information provides the paths to alternate working folders for projects accessed from your workstation. The entry for this component in the starteam-client-options.xml file includes the following parts.
- The phrase Project Component.
- ViewWorkingFolderOverrides (if the alternate working folder is for an entire view) or WorkingFolderOverrides (if the alternate working folder is for an individual folder).
- A hex identification of the project view and folder.
- The alternate working folder’s path.
starteam-server-configs.xml
The starteam-server-configs.xml file contains session options for one or more server configurations. StarTeam Server session options specify the core information that the Server requires to start a server configuration. One starteam-server-configs.xml file exists per computer and is located in the same folder as the StarTeam Server application. On Microsoft Windows, this file is usually located in C:\Program Files\Micro Focus\StarTeam Server <version #>.
The session option information for each server configuration begins with the name of the configuration in brackets and is followed by a set of options and their settings. The StarTeam Server creates and maintains this file, which is created when the first server configuration is created. The file is updated whenever a server configuration is created, modified, deleted, started, or stopped. Do not edit this file directly. We recommend that you back up the starteam-server-configs.xml file or put it under version control.
Information in this file includes:
Server-managed settings
Note: Options in this section should only be modified using the Admin tool, if at all.
Configuration creation settings
| ServerGuid | Value supplied by the server. This option is set by the server. Do not edit it. |
| ComputerName | Identifies the computer on which Microsoft Windows resides. This option is set by the server. Do not edit it. |
| CreatedByBuild | Indicates that a server configuration cannot have any Native-I archive files. |
| DBCreated | Indicates whether the database tables used by the application are already created. Do not edit this option. |
| UserName | The domain user name for the user who created the server configuration. This option is set by the server. Do not edit it. |
| Initialized | Indicates whether this server configuration was initialized. This option is maintained by the server. Do not edit it. |
Application settings
| RepositoryPath | The complete path to the repository folders. This information is set using the -r option with starteamserver command. The repository path can only be specified when creating a new server configuration. This information cannot be modified for existing server configurations. |
| ListenIP | Binds a server configuration to a specific TCP/IP (sockets) address. For example, if the StarTeam Server has more than one IP address (more than one NIC card), you can configure it to listen to one specific port. When this option is set to empty(default) the server configuration listens to all IP addresses on the specified port. The port is specified on the Protocol tab of the Configure Server tool in the Server Administration Tool. This entry applies to both TLS and TCP/IP protocols. |
| LogPath | Specifies the location of the server log file. |
| EndPoint | Server endpoint. |
| MessageBrokerType | This information is set using the
-mb option with
starteamserver command. The message broker type can be specified when creating a new server configuration. Message broker options available
include:
|
Database settings
| DBPort | The port used by the database server. |
| DBServerName | Name of the database server. |
| DBServiceName | (Oracle only). The name of the service on the Oracle server. Either -dbservicename or -dbsid is required when creating an Oracle configuration from the Microsoft Windows command line. |
| DBSID | (Oracle only). This is the SID on the Oracle server. Either the -dbsid or the -dbservername parameter is required when creating an Oracle configuration from the Microsoft Windows command line. |
| DBType | This information is set using the
-t option with
starteamserver command. The database type can only be specified when creating a new server configuration. This information cannot be modified
for existing server configurations. You can review the database type using the
-view option from the command line or in the application on the
Database tab of the dialog.
|
| DBUserName | Name by which the application accesses the server configuration database. This information is set using the -u option with the starteamserver command. |
| DBPassword | Password for DBUserName by which the application accesses the server configuration database. This information is set using the -p option with the starteamserver command. |
Process execution settings
| PID | The Process ID for the instance of the server configuration that is currently running. Otherwise, this option is set to 0. This option is maintained by the StarTeam Server. Do not edit it. When this option is missing, starteamserver creates it. |
| Sample | Indicates the sample server configuration. For internal use only. Do not edit this option. |
| ServiceMode | For use on Windows NT systems only. Use 1 to run the server configuration as an NT Service. Use 0 to run the server configuration as an application. |
| Status | Indicates whether the server configuration is Ready, Starting, Running, or Stopping. This option is maintained by the server. Do not edit it. When this option is missing, starteamserver creates it. |
Performance tuning
| DBMinimumConnections | Number of connections created at server startup. Default: 25. Valid range: 10-100. | ||||||||
| DBMaximumConnections | Maximum number of database connections that the server is allowed to have, connections added as needed. If max limit is reached,
you receive a message:
"Failed to acquire a database connection. Please contact an administrator to increase number of database connections."
Default:
25. Valid range:
10-65,535.
|
||||||||
| MinCommandThreads | Not used. | ||||||||
| MaxCommandThreads | Specifies the maximum number of command threads that the server configuration can create. A setting of 0 for this option causes the server configuration to use the default value. Default value: 25. Valid range: 16-120. | ||||||||
| ItemCachePriority_File | Defines the relative preference of file data in the server data cache. Each component will occupy no more than it's percent share, which is calculated as shown in the following example: FileShare% = (100 * ItemCachePriority_File ) / (ItemCachePriority_File + ItemCachePriority_Change + ItemCachePriority_Requirement + ItemCachePriority_Task + ItemCachePriority_Topic + ItemCachePriority_Folder ). Default value: 100. Valid range: 0-100. | ||||||||
| ItemCachePriority_Folder | Defines the relative preference of component data in the server data cache. Default value: 0. Valid range: 0-100. | ||||||||
| ItemCachePriority_Changes | Defines the relative preference of component data in the server data cache. Default value: 0. Valid range: 0-100. | ||||||||
| ItemCachePriority_Topic | Defines the relative preference of component data in the server data cache. Default value: 0. Valid range: 0-100. | ||||||||
| ItemCachePriority_Task | Defines the relative preference of component data in the server data cache. Default value: 0. Valid range: 0-100. | ||||||||
| ItemCacheOnStartup_%s | Cache on startup setting by class name (File, Changes, Topic, etc). Default value: 64-bit = 1, 32-bit =0. Valid values: 0 (disabled) or 1 (enabled). | ||||||||
| ItemCachePriority_Requirement | Defines the relative preference of component data in the server data cache. Default value: 100. Valid range: 0-100. | ||||||||
| ItemCacheLogRecovery | Enables logging of item cache cleanup. Default value: 0. Valid values: 0 (disabled) and 1 (enabled). | ||||||||
| ItemCacheMemoryLimit | Defines the maximum amount of memory that can be used for caching item data, in MB. The default value is -1, which means no limit is set and the server will use up to the maximum amount of memory available to the server process for caching the data. Example: Adding <option name="ItemCacheMemoryLimit" value="100"/> to the configuration file will set the cache limit to 100 MB. Valid range: 1000-7000. | ||||||||
| ItemCacheProcessMemoryLimit |
Maximum allowed process memory size, used as cap for Item Data Cache size. Default values:
|
||||||||
| SocketTimeoutMinutes | Socket connection timeout. Default value: 0. Valid range: 0-10. | ||||||||
| ObjectQueryChunkSize | Data Cache queries tuning. Default value: 10000. | ||||||||
| MaxWorkstationConnections | Limits the maximum number of connections per workstation. Default value: 25. Valid range: 25-100. | ||||||||
| LinkValueCache | Used to enable/disable LinkValue caching. Default value: 1. Valid values: 0 (disabled) or 1 (enabled). | ||||||||
| MinimumClientCommandAPI | Minimum command API accepted by the server. Default value: 1.25. Valid range: 1.25-1.xxx. | ||||||||
| LinuxThreadStackSize | Used to set stack size in MB during thread creation on Linux. Use to override the default system size of 1 MB. |
Functional settings
| InfoStreamCRStatus | Association of status between completed user stories (created using Info Streams) and Original Change Request. When enabled, a Story is marked complete in agile and triggers the corresponding Change Request to be marked fixed. Default value: 1 . Valid values: 0 (disabled) or 1 (enabled). |
| DisableAdvancedViews | Disables creation of certain type of views. Default value: 1. Valid values: 0 (enabled) or 1 (disabled). |
| NotificationLocale | Override the locale for notification messages. Default value: empty, using server locale. Valid values: En, fr, de, pt, zh-cn, or ja. |
| VaultCompressionCutOffThreshold | File content is compressed in the archives directory only if the compressed file is smaller than the threshold value (in percent). Default value: 10. Valid range: 0-100. |
| WorkspaceModifiedTimeFeature | Enable/disable View Workspace Modified Time feature. Default value: 1. Valid values: 0 (disabled) or 1 (enabled). |
| AtomicBehavior | Enable/disable Atomic transactions for VCM. Default value: 0. Valid values: 0 (enabled) and 1 (disabled). |
| VerboseLevel | Level of logging detail. Default value: 0. Valid range: 0-6. |
| MixedEOLAsBinary | Treat files containing a mix of EOF characters as binary. Default value: 0. Valid values: 0 (no) or 1 (yes). |
| UpgradeMissingAttachments | Upgrade attachments even if upgrade form 12.0 was previously run. Used to force re-migration of attachments. Default value: 0 0. Valid values: 0 (disabled) or 1 (enabled). |
| ViewsCachedAtServerStartup | IDs of views to be cached on startup. Example: 22, 57, 1547. |
| CheckinChangePackages | Create checkin change packages during file checkin. Default value: 1. Valid values: 0 (disabled) or 1 (enabled). |
| ForceCustomTools | Enable/Disable custom tools. Default value: 0. Valid values: 0 (disabled) or 1 (enabled). |
| CheckoutUseRevisionFileName | Checkout files using revision's file name. Default value: 0. Valid values: 0 (disabled) or 1 (enabled). |
| AllowExternalTraces | Enable/disable external traces. Default value: 1. Valid values: 0 (disabled) or 1 (enabled). |
| DefaultBinaryExtensions | You can specify a semi-colon separated list of extensions which will automatically be treated as binary files on check-in.
For example:
DefaultBinaryExtensions=”.pdf;.bin;.s19;.doc” |
| InfoStreamCRStatus | Association of status between completed user stories (created using Info Streams) and Original Change Request. When enabled,
a Story is marked complete in agile triggers the corresponding CR to be marked fixed.
Default value: 0. Valid values: 0 (disabled) or 1 (enabled). |
| SDKWorkflow | Used to enable/disable workflow in the command line SDK.
Default value: 0. Valid values: 0 (disabled) or 1 (enabled). |
| DefaultBinaryExtensions | List of file extensions to treat always as binary. Use quotes ("") to denote the extensions. For example, "pdf;.doc;.xls;". |
URL settings
| StarTeamAgileWebAddress | Web address of StarTeam Agile used by the Cross-Platform Client to access StarTeam Agile. Default value: "". Example: http://agile:8080/topaz-web/login.jsp? |
| ALMServiceURL | URL of REST service, used to generate notification URL. Default value: <ServerHostnameUrl>:80. Example: "hostname:portnumber". |
| RESTServicePort | Rest service port over-ride. This value must match the Apache Tomcat Port Number. Default value: 9090. Valid range: 0-10000. |
Purge settings
| OnlinePurgeThreadPriority | Online purge thread priority. Default value: Background. Valid values: Background or Foreground. |
| OnlinePurgeExecTime | Online purge execution time, in seconds. Default value: 60. Valid range: 10-400. |
| OnlinePurgeLoggingType | Online purge log type. Default value: 0. Valid values: 0 (normal) or 1 (verbose). |
Recommended configuration options
StarTeam supports small development environments with a few developers to large enterprises with tens of thousands of concurrent users. Therefore it is difficult to have a one size fits all for hardware recommendations and configuration options.
There are no hard rules about what makes a configuration small, medium, or large. However, for our purposes, we'll use these definitions based on concurrent users:
| Small configuration | Supports no more than 50 concurrent users. |
| medium configuration | Supports no more than 100 concurrent users. |
| large configuration | Supports 100+ concurrent users. |
This does not factor data volume or the type of users: on-line users or bulk applications. This is because, in our experience, the amount of data managed by a configuration (particularly items) tends to grow proportionally with the number of projects and views, which grows in proportion to the team size. Moreover, the ratio of on-line users to bulk applications tends to be roughly the same across organization sizes. The concurrent user count seems to be the best metric for judging configuration size for purposes of deployment planning.
So how big can a configuration get? To date, we've seen single instances with over 500 concurrent users, over 10,000 total define" users, over 4,000 views, tens of millions of items, and up to a terabyte of vault data. With continuous hardware advances and software improvements, these limits get pushed every year.
| Setting Name | Small | Medium | Large |
|---|---|---|---|
| DBMinimumConnections | 10 | 10 | 70 |
| DBMaximumConnections | 25 | 50 | 80 |
| MinCommandThreads | 16 | 40 | 80 |
| MaxCommandThreads | 25 | 50 | 80 |
| ItemCachePriority_File* | 100 | 100 | 100 |
| ItemCachePriority_Folder | 0 | 0 | 0 |
| ItemCachePriority_Changes* | 100 | 100 | 100 |
| ItemCachePriority_Topic | 0 | 0 | 0 |
| ItemCachePriority_Task | 25 | 25 | 25 |
| ItemCachePriority_Requirement | 0 | 0 | 0 |
| ItemCacheLogRecovery | 1 | 1 | 1 |
| ItemCacheMemoryLimit
This setting depends on the physical memory. These values assume that the machine is exclusively used for StarTeam Server. When the physical memory is not constrained on 64-bit machines , this can be set to -1. -1 for 64-bit translates to 8GB of IDS cache. |
|
|
|
*The recommended values for CachePriority for all the artifacts depends on the specific use case. For customers who have Change-Request only configurations, it would be desirable to set ItemCachePriority_Changes to 100 and reset all the others to 0. For files-only configurations, it is recommended to set ItemCachePriority_File to 100 and reset the other options to 0.
