Creating, running, and managing server configurations

This topic describes how to create, run, and manage server configurations.

Creating server configurations

Before creating a new server configuration, you need to decide upon a unique name for the configuration. This name is case insensitive and cannot contain : \ / but can contain blanks or apostrophes '. You must also set up the database to be used with the server configuration. A database can contain only one server configuration. However, other applications can share a database with StarTeam.

Tip: You can also create a server configuration from the command line.

  1. Open the Server Administration tool.

    Note: You must access the Server Administration tool on the computer where StarTeam Server is installed.

  2. Click Server > New Configuration. The Create a New Configuration wizard opens.
  3. To set the General options for the new server configuration:

    1. Type a unique name in the Configuration name field.
    2. In the Repository path field, enter or click Browse for the location in which the StarTeam Server will create the server configuration files.
    3. Select a Database type from the list. You cannot change the database type once the server configuration has been created.
    4. Select the Message Broker type. Choose None or ActiveMQ MPX.
    5. Check or clear Create new StarTeam database. The wizard selects this option by default.
    6. If you want your clients to use the search functionality, verify that Enable search for StarTeam Server is checked.

  4. Select the Default or Custom hive option for the Initial Hive Settings. If you select Custom, you can override the default hive settings by modifying any of the following fields:

    Note: If you select the Default, changing the repository path changes the default hive settings. Changing the repository path does not have this effect if you select Custom.

    Name Unique name for the hive. DefaultHive is the default.
    Archive path Path to the Archives folder for the new hive. The default path is <repository path>\DefaultHive\Archives.
    Cache path Path to the Cache folder for the new hive. The default path is <repository path>\DefaultHive\Cache.
    Maximum cache size Maximum number of MB of hard disk space that the cache can use. The default is 20% of the disk space available when the option is set.
    Cache cleanup interval Seconds between cache cleanup/refresh operations. The default value is 600. The range is 60 (1 minute) to 3153600 (1 year).
    Storage limit threshold Percentage of total disk space allowed for hive. When this percentage has been reached, StarTeam does not add any more archives to the hive. The default is 95% of total disk space.
  5. Click Next when the information is complete. The second page of the wizard opens. The information that you must enter for this page of wizard varies according to the database selected.
  6. For Microsoft SQL Server/Microsoft SQL Server Express and PostgreSQL databases:

    1. In Database Server Name, type or browse for the names of the computer and the database on your network that should be used.
    2. If the database is running on an alternate port, check the Edit Database Port field to enable the Port field. Type the port number in the field.
    3. Type the password for the system administrator in the Sys Admin (sa) password field. If this is a Microsoft SQL Server Express instance installed with StarTeam Server, the initial default system administrator password is StarTeam123 or blank.
    4. Click Verify Connection to make sure that you can properly connect to the database.
    5. To keep the name of the server configuration, the database name, and the database login name the same, all of the New database name and the New database login name fields default to the name you provided for the server configuration in the first page of the wizard. Change these values if you prefer to have different names.
    6. Type and confirm a database password.
  7. For Oracle databases:

    1. Type the Oracle database server name in the Database server name field.
    2. Type either the service name or the SID. Select the option to specify one or the other.
    3. If the database is in a different port than the default port, check the Edit Database Port checkbox and type the new port number in the field.
    4. Type the database system password in the System password field.
    5. Click Verify Connection to make sure that you can properly connect to the database.
    6. To keep the name of the server configuration and the schema user the same, the New schema user name field defaults to the name you provided for the server configuration in the first page of the wizard. Change these values if you prefer to have different names.
    7. Type and confirm a password for the schema user name.
  8. Click Next. The final page of the wizard, Create Data Files and Transaction Logs opens. Again, the information that you can enter for this page of wizard varies according to the database selected.
  9. For Microsoft SQL Server/Microsoft SQL Server Express databases:

    1. Review the information in the dialog box.
    2. If you have fewer than 15 users and expect to store 1 GB or less data, the default settings are appropriate for your use. If you are very familiar with Microsoft SQL Server and Microsoft SQL Server Express databases, you may choose to make some changes by first clearing the Use default configuration check box and then altering sizes and locations for data files and log files. To avoid fragmentation, make the data files as large as possible, based on the maximum amount of data expected in the database. Use at least 3 data files and at least 3 transaction log files when creating a database, because Microsoft SQL Server and Microsoft SQL Server databases use a proportional fill strategy. This way all the files tend to become full at about the same time.
    3. When you are satisfied with your configuration settings, click Finish. A message requests: Please make sure the required disk space (x MB total for both data files and transaction log files) is available on the database host machine.
    4. Click OK. After a Please wait message disappears, the Server Administration tool displays, showing your new server configuration as a child of the Local node.

      Note: Microsoft limits the size of a Microsoft SQL Server Express database, by license, to 2048 MB. If you require a larger database, you must purchase a license for Microsoft SQL Server.

  10. For Oracle databases:

    1. Review the information in the dialog box. The tablespace name defaults to the name of your server configuration, but it is editable.
    2. If you have fewer than 15 users and expect to store 1 GB or less of data, the default settings are appropriate for your use. If you are very familiar with Oracle schema users, you may choose to alter the names, sizes, and locations of the data files. To avoid fragmentation, make the data files as large as possible, based on the maximum amount of data expected in the database. Use at least three data files when creating a tablespace because there is a size limit of 2GB per data file, and fewer files can result in slow response times when insert activity is heavy.
    3. Click Finish. The Server Administration tool displays, showing your new server configuration as a child of the Local node.

      Tip: If you are creating a custom component, do not start the server until you've completed all steps for creating components and their layouts.

  11. Select the configuration in the server pane.
  12. Click GUID-6156DC55-6EE7-478B-A704-414E4C454164-low.gif (Start Server).
    StarTeam Server then initializes the database and creates the files and folders for the server configuration. The initialization process may take a few minutes. When the server finishes this activity, the status icon to the left of the server configuration name changes from STARTEAM-5D8BD25E-SERVERNEWENABLED-low.gif (New) to STARTEAM-AAF64241-SERVERSTARTED-low.gif (Running).

In addition to creating the server configuration, StarTeam Server adds information about the new server configuration to your starteam-server-configs.xml file.

After the server configuration has been created, you can modify the default server configuration options, which enable you to fine-tune server configuration performance.

Note: On a double-byte operating system (such as Japanese or Chinese), see your database administrator to manually set the collation sequence to Latin1_General_CI_AS.

Back to top

Loading server configuration sample data

You can download sample data from within the Server Administration tool.

  1. Create a new server configuration and select it.
  2. Click GUID-6156DC55-6EE7-478B-A704-414E4C454164-low.gif (Start Server).

    Tip: The server configuration must be empty (no existing projects) before you can load the samples.

  3. After the server has started and is running, click Actions > Load Samples.
  4. Click Yes to load the sample data. You may be prompted to log on to the server. A Loading Samples dialog box displays showing the progress of the download. The download may take several minutes.
  5. Users can now connect to this new server configuration and access the sample data.

The sample data is installed in C:\Program Files\Micro Focus\StarTeam Server <version>\Samples.

Back to top

Enabling and disabling server configurations

You can enable or disable a server configuration from the Server Administration tool. Disabling a server configuration enables you to take a server configuration “out of service” and ensure that it is not started by accident. For example, if you migrate a server configuration, you should disable the prior server configuration. After you are sure that the new server configuration and database are working properly, you can delete the prior server configuration. You can also reactivate a disabled server configuration.

  1. Open the Server Administration tool and select the server configuration.

    Note: You must access the Server Administration tool on the computer where the StarTeam Server is installed.

  2. If the server configuration is running, click GUID-6156DC55-6EE7-478B-A704-414E4C454164-low.gif (Shut Down Server).
  3. Once the server has shut down, click GUID-6156DC55-6EE7-478B-A704-414E4C454164-low.gif (Disable Server).

    • If the server configuration is currently enabled, it becomes disabled.
    • If the server configuration is currently disabled, it becomes enabled.

Tip: The icon to the left of the server configuration indicates its status.

Back to top

Locking and unlocking server configurations

Locking a server configuration enables you to limit access to that configuration while you perform backup procedures or database maintenance. When a server configuration is locked, only server administration commands are accepted. For any other command, such as checking out files, the StarTeam Server sends an exception message stating that the server configuration is unavailable.

To unlock your server configuration is locked, click Unlock ServerGUID-6156DC55-6EE7-478B-A704-414E4C454164-low.gif.

  1. Open the Server Administration tool and select the server configuration.

    Note: You must access the Server Administration tool on the computer where the StarTeam Server is installed.

  2. Click GUID-6156DC55-6EE7-478B-A704-414E4C454164-low.gif (Lock Server).
  3. On the resulting dialog, indicate whether you want to: A dialog box opens indicating that the server configuration is locked.

    Lock server This option allows minimal administrative options, primarily, start, shutdown, lock and unlock operations. It is usually done for backup operations in environments where server activity is not 24/7.
    Lock the server for exclusive use by <user name> This option, which displays the login name for the user, allows a user to lock the server for their use only.
  4. Click OK.

Note: If a locked server configuration is restarted, it will become unlocked.

Back to top

See also: