StarTeam proxy utility

This section describes the StarTeam proxy utility.

In this topic:

Understanding the StarTeam proxy utility

Use the offline proxy utility to communicate to StarTeam users that the server is down for maintenance. Previously when StarTeam Server is down due to database issues or maintenance, a user connecting with StarTeam SDK or StarTeam Cross-Platform Client gets a message stating, "Unable to connect to server." Since they do not know what the reason is, they might raise issues with their IT department . When using the offline proxy utility, administrators can better communicate the reason for the disruption in the Server, avoiding unnecessary IT service tickets.

The StarTeam offline proxy utility runs on the same port as the defined configuration, and it responds to any command from clients with an error message to the user.

Back to top

Running the offline proxy utility

To run the proxy utility:

StarteamOffline - start ConfigName

starteamoffline [-help] [-list]
               [-start config]
              [-stop config] [-tcpip endpt]
              [-version]

        -help                   display this help message
        -list                   list all configurations
        -q                      run quietly
        -start name             start offline server with config [name]
        -start -all             start offline server for all configurations
        -stop name              start offline server with config [name]
        -stop -all              stop offline server for all configurations
        -tcpip endpt            TCP/IP sockets endpoint
        -version                display version info

If a Server Message Notification has been defined before the server was shutdown, the users will see that message. Otherwise, they will see a default message, "StarTeam Server is currently offline for maintenance."

Starting a StarTeam Server Configuration will automatically stop the offline proxy.

Back to top