Auditing : Enabling/disabling the functionality
  

Enabling/disabling the functionality

Installation - Orchestra Central

If you run the Installation Wizard, Auditing will be installed automatically, just like all other modules.
However, if auditing is enabled or not depends on if the Auditing module is included in your license, or not.
The auditing database, qp_auditing is created by default during a fresh installation of Orchestra.
If the license is removed or disabled, existing auditing data is kept.
In the install.properties file, which should be used when running the installation in silent mode, you can find the application called application.auditing, which by default is set to true. The properties for the qp_auditing database can also be found in the install.properties file.

Upgrade

If the Auditing module is not included in your license, auditing is disabled.
If auditing is not installed on the system, auditing will be disabled, regardless of if the Auditing module is licensed, or not.
The auditing database, qp_auditing, is not automatically created during upgrade. Enabling auditing in an upgrade requires setting up the required user and table, as well as modifying the install.properties file.
To enable auditing, follow the steps described in Configuration - Database, below.

Configuration - Database

Prepare your database by running the scripts corresponding to your database (Oracle Database / Microsoft SQL / PostgreSQL).
1. Open a database tool that allows you to run a database script (e.g. SQL Developer for Oracle Database, or SQL Server Management Studio for Microsoft SQL). For PostgreSQL, see special instructions below.
2. Run the script corresponding to your database in a tool that can execute the script:
Microsoft SQL Server:
<tmp_dir>/db/auditing-mssql.sql
 
Oracle Database:
<tmp_dir>/db/auditing-oracle.sql
 
PostgreSQL:
1. Make sure that the PostgreSQL bin folder is added to environment variables.
2. Open the command prompt in the <tmp_dir>/db/ directory.
3. Run the command:
psql -U postgres -f auditing-postgres.sql
 

Configuration - install.properties file

Set application.auditing = true.
Modify the audit db settings for the database picked in the previous step to match those of your db.
Example for PostgreSQL:
auditing.db = postgres
 
auditing.postgres.db.host = localhost
auditing.postgres.db.user = qp_auditing_insert
auditing.postgres.db.password = qp_auditing_insert
auditing.postgres.db.port = 5432
auditing.postgres.db.name = qp_auditing
 
Run the upgrade in silent mode, using the command install.bat -s for Windows, or install.sh -s for Linux.