Getting Data Backup

Use

If it is required by your company’s policy to store data locally, BUGtrack allows downloading a complete data snapshot. The procedure of creating a backup copy of the system is very simple - a user can perform it by only one action. A created copy can be opened for viewing right away or stored locally on the computer.

Data backup is done with the help of the BUGtrack backup tool that scans active projects to find modified records since the last backup run and writes modified data in the HTML format. Files attached to records are also downloaded.

The backup tool operates in the context of the user account passed in the command line, thus, to perform full backup, the user should have access to all records. No modification rights are required, as no changes will be performed over the BUGtrack license data during the backup process.

Note: Information about the backup procedure is also available online. To access instructions, go to Admin tab – Administration area – Get data backup link.

Procedure

Before running the BUGtrack backup tool, make sure that Microsoft.NET Framework 2.0 is installed on the machine that will be used to obtain the backup data.

Step one. Download the BUGtrack backup tool at btbackup.zip and extract files from the archive.

Step two. Run the btbackup.exe file from the command line with the following mandatory arguments: license host, user name and password.

It is recomended to run the command prompt and paste the command string with all the necessary parameters, as in this case the command window will not be closed immediately if the command string contains any errors.

An example of a minimal command string is the following:

C:\btbackup\btbackup.exe -l =mycompany.bugtrack.net -u=Administrator -p=mypassword –v

where after the “=” (equal) sign, the following values should be provided: licence host for the –l parameter, administrator’s user name for –u parameter and administrator’s password for –p parameter. The –v (verbose) parameter instructs the BUGtrack backup tool to generate a progress report.

The following parameters may be specified in the command line:

• -license= licens e - license host (required). The parameter may be abbreviated to –l.

• -use r=user - BUGtrack administrator's login (required). The parameter may be abbreviated to –u.

• -password=password - BUGtrack administrator's password (required). The parameter may be abbreviated to –p.

• -folder=folder - full or relative path to the folder to which backup files will be saved (if the parameter is omitted, backup files will be saved to the current folder). You may set the current folder using the "cd" command in the command prompt before the backup process is started. The parameter may be abbreviated to –f.

• -xsl=xsl - full or relative path to the XSL file (if the parameter is omitted, the html.xsl file provided in the downloaded archive is used). The parameter may be abbreviated to –x.

• -project=project – name of a project for which the backup procedure is performed (used if it is required to back up data of a single project). If ommited, data for all projects is backed up.

• -debug=bug# - the number of a record that should be fetched for XSL debugging. If omitted, all records are fetched. The parameter may be abbreviated to –d.

• -verbose - display progress report messages (by default, the progress report is off). The parameter may be abbreviated to –v.

• The following parameters are used to connect via a proxy server (experimental):

• -ps=server - server name to connect.

• -pu=username - credentials for proxies.

• -pp=password – password for proxies that require authentication.
  

The command window will stay open until the backup is completed. You may cancel the process at any time by pressing CTRL+C. The BUGtrack backup tool will continue from the right place next time, as it saves the "last download" info in the index.xml file. If this file is missing, the backup will start from the very beginning.

Next: User Preferences