System administrators can use these utilities to control the behavior of the
application.
add_orchestrate_to_projects.py
Run the add_orchestrate_to_projects.py script to add the Orchestrate integrated application to existing projects.
backup-rb-data.py
The backup-rb-data.py script is used to back up the Review Board application data.
bootstrap-data.sh
The bootstrap-data.sh script prepares application and database data for new installations. Preparing application and database data is referred to as "bootstrapping" the data.
bootstrap-reporting-data.sh
The bootstrap-reporting-data.sh script prepares the datamart data for new installations.
CodeSightMigration.sh
The CodeSightMigration.sh script is used to create Black Duck Code Sight projects for existing TeamForge repositories. After migration, the code search functionality is enabled for migrated repositories.
The collabnet script
Run this script to start or stop TeamForge, or to get the status of the application or a component.
datamart-oracle-setup.sh
This script is used for setting up the Oracle datamart in CTF advanced mode installation.
datamart-pgsql-setup.sh
This script is used for setting up the PostgreSQL datamart in CTF advanced mode installation.
db.py
The db.py script can be used to dump and restore a PostgreSQL database.
domain_change_db.py
The domain_change_db.py script handles all the steps required to change the domain name in the site database. It does not change anything in the file system.
domain_change_fs.pl
The domain_change_fs.pl script handles all the steps required to change the domain name under the file system data directory. It does not change database contents.
domain_change_pt.py
THIS IS A STUB FILE, TO BE REPLACED BY REAL INFORMATION ABOUT DOMAIN_CHANGE_PT.PY
environment_check.sh
The environment_check.sh script verifies whether all environment packages required for installing CollabNetTeamForge are present.
etl-client.py
The etl-client.py script allows you to access the Extract, Transform and Load (ETL) scheduler and check the status of the jobs configured. The script also supports triggering jobs manually.
fix_data_permission.sh
The fix_data_permission.sh script is used to fix the TeamForge filesystem permissions when you backup and restore the TeamForge data in a new box during TeamForge upgrade.
indexupgrade.py
Run the indexupgrade.py script post upgrade to convert existing search indices to Lucene 4.x format.
install.sh
The install.sh script handles all operations related to installing and removing the application.
pbl.py
The pbl.py utility enables you to upload files to the Project Build Library and perform various operations on them.
password_util.sh
The password_util.sh script is used to get the encrypted or decrypted password value for the user scmviewer.
post-install.py
Run the post-install.py script to perform TeamForge post installation/upgrade actions. For example, run this script for setting up CLI reports, integrating Gerrit SCM with TeamForge, integrating SVN and CVS, and so on. This script is intelligent enough to identify the list of post installation actions required based on the TeamForge applications that are configured and running locally.
psql-wrapper
The psql-wrapper script is used to connect to the TeamForge application.
psql-reporting-wrapper
The psql-reporting-wrapper script is used to connect to the datamart.
restore-rb-data.py
The restore-rb-data.py script is used to restore the Review Board application data from the backup directory.
SearchReindex.py
The SearchReindex.py script allows you to reindex the entire TeamForge data.
set_auth_key.py
The set_auth_key.py script sets the authorized key to the scmviewer user profile.
set-reports-readonly-user-permission.py
This script grants read-only access to the datamart for those users specified by the REPORTS_DATABASE_READ_ONLY_USER token.
sync-orchestrate.py
Run the sync-orchestrate.py script to synchronize a TeamForge project with Orchestrate by triggering the world-state message for the given project.
snapshot.py
Use this script as a debugging tool to troubleshoot system errors. It records a snapshot of the current state of the machine.
upgrade-site.sh
With this script, you can perform a cumulative patch upgrade or downgrade on a running instance.
projecttracker.py
The projecttracker.py utility provides a command line interface to control a Project Tracker integration on a TeamForge site.
wmt-wrapper.sh
The wmt-wrapper.sh script is used to invoke wmt.java by using wmt.jar. This script is a wrapper script for the wmt.sh script.