Server Administration Tool

Server Administration Tool UI

When you need to administer your server configurations, you use the Server Administration tool. The Server Administration tool is a Java application that enables administrators to create and manage StarTeam Server configurations and the repositories they access. It is automatically installed with the StarTeam Server and can be run only from a computer on which StarTeam Server resides. From the StarTeam Server, this tool can administer both local and remote configurations, as it can access the starteam-server-configs.xml file.

If you choose a custom installation, you can also install this tool with the StarTeam Cross-Platform Client. However, from the client installation, the StarTeam Server can administer remote StarTeam Server configurations only. With the Server Administration tool, an administrator can perform all operations on either remote or local server configurations, including the following:

  • Create, enable, disable, or delete a server configuration.
  • Display or modify the session options for a server configuration.
  • Start or shut down a server configuration.
  • Set or remove a server configuration as a Windows service.
  • Review the status and execution mode of all server configurations running on this computer.
  • Access the Hive Manager.

You can also perform the following tasks on remote server configurations from clients on which you have installed the Server Administration tool:

  • Log onto a server as a different user.
  • Add and manage user accounts.
  • Set the security policy for a server configuration.
  • Assign access rights to users and groups for a server configuration.
  • Add, modify, or delete connections to a server configuration.
  • Set or modify the configuration options for a server configuration.
  • Display the server log file (Server.locale.Log).
  • Lock or unlock a server configuration.

The rest of this topic describes the numbered components in the above diagram.

Main Menu

The main menu consists of the Server, Actions, Tools, and Help menus. The Tools menu provides a cascading menu separating administrative and user account commands.

The Server Administration tool enables or disables menu commands depending on the status of your server configuration. For example, when you are not running a server configuration the Server Administration tool does not enable the Actions > Logon As Shutdown Server main menu commands.

Toolbar

Frequently used main menu commands corresponding to the Server and Actions menus have corresponding buttons on the toolbar. Fly-over text displays when you hover your mouse over the toolbar buttons. The Server Administration tool enables or disables toolbar buttons depending on the status of your server configuration.

Server Pane

The Server pane lists the servers that are present in the starteam-servers.xml file. Choosing Server > Add Server and proceeding through the Add Server dialog box updates this file.

Shortcut Pane

The shortcut pane displays quick access buttons corresponding to the cascading menus provided under the Tools menu for the administrative and user account commands. The shortcut pane is divided into the Administration and Accounts areas enabling you to access frequently used main menu commands.

Display Pane

When accessing commands from the Tools menu or from the shortcut pane quick access buttons, the Server Administration tool displays the dialog boxes for these commands in the display pane.

Tip: Expand the Server Administration tool window to enlarge the dialog boxes presented in the display pane.