Displaying and Customizing StarTeam.Log

The StarTeam.Log file records the operations performed on your client workstation during a session. It helps you troubleshoot and document errors or operations between the server and your workstation that failed during server configuration sessions.

Because the application creates a new file every time you start the client, the log folder can fill up quickly. To control the number of log files in the folder, you may want to periodically delete old log files from the output folder or disable the StarTeam.Log option. To disable the option, clear the Log Errors and the Log Operations check boxes on the Workspace tab of the Personal Options dialog. To display the StarTeam.Log file, select Tools > StarTeam Log File from the menu bar. You can also import and view the data using any application that supports tab-delimited fields. For example, if you save the file with a CSV extension, the file can be opened in Microsoft Excel.

The Workspace tab on the Personal Options dialog enables you to specify the location and the type of data recorded in the StarTeam.Log file.

  1. From a client, select Tools > Personal Options . The Personal Options dialog box appears.
  2. On the Workspace tab, enter or browse for the location of the StarTeam.Log file in the Log Output Path text box. The default is the location in which the application is installed, for example, %PROGRAMDATA%\Borland\StarTeam. The current log file is always named StarTeam.Log. Log files from earlier sessions of the application include the date and time the file was last modified.
    Note: StarTeam.Log contains data about operations sent from your workstation to one or more servers, depending on what project views you have open. This data includes the name of the project so that you can isolate data for a particular server, when necessary.
  3. Select the types of data you want to include in StarTeam.Log.
    Log errors
    Set by default. Records errors that occur while you are using the client. The errors log lists the date and time you started your server configuration and any errors or failed operations between the server and client. The application identifies each failed operation by an internal ID and provides an explanation. For example, you might see:...Operation 40956 failed: TCP/IP Socket Error 10054:...
    Log StarTeamMPX events
    Selecting this option records information about StarTeamMPX events for this client. The log identifies the time and date on which a StarTeamMPX event (an automatic refresh or file status update) took place. The log prefaces a StarTeamMPX event as “Statistics for Events” and uses internal IDs and brief explanations to identify the server event. The following example describes a status change for a file:...Statistics for Events /1b21dd1-e208-51ea-01b2-1dd1e20851ea/Object/File/ Modify You can log StarTeamMPX events only if you check the “Enable StarTeamMPX” checkbox on the StarTeamMPX tab. For StarTeamMPXrelated operations, any changes you make on the Workspace tab do not apply to projects already open. However, the application will log StarTeamMPX events for any projects you open from this point forward.
    Log operations that take at least ___ milliseconds
    Select this option to record operations that take longer than a specific number of milliseconds. (An operation is a command that results from user actions. Operations can be executed on either the Server or the client.) The milliseconds time setting stops the log from filling up with operations of little importance. The default is 10 milliseconds. This option records information on the date, time, and UI Operation number for each command executed by your workstation. You can record either Summary or Detail information.
    Summary
    Records the time spent for the total operation, client execution time, and server execution time. The application identifies each operation by an internal ID, such as Statistics for Operation 40001.
    Detail
    Records a detailed breakdown of all server commands performed for each operation. The log identifies the server address, project, and component (File, Change Request, Requirement, Task, or Topic) for each server command. The application identifies each server command by an internal ID, such as Public Server Command 10.
  4. Click OK.