Configuring Usage Audit

Open iT Usage Audit allows you to generate a periodic report that displays the number of distinct users per month, per module, for the past 12 months.

Activating Usage Audit

Usage Audit is active by default; make sure it is activated before activating other data collection sources. If it is inactive, follow these instructions to activate:

Windows

1. Open a command prompt with Administrator level privileges.

2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

   Command Syntax

   cd <bin_dir>

   Example

   cd C:\Program Files\OpeniT\Core\bin

3. Once in the directory, activate the task for auditing distinct application users of Open iT, run the command:

   Command Syntax

   openit_yamlinit coreserver update asset core_audit.yaml:general.active=true

4. Open the Task Manager.

5. Under Services, restart the OpeniTCoreServerPipeline service.

Unix

1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

   Command Syntax

   cd <bin_dir>

   Example

   cd /opt/openit/bin

2. Once in the directory, activate the task for auditing distinct application users of Open iT, run the command:

   Command Syntax

   ./openit_yamlinit coreserver update asset core_audit.yaml:general.active=true

3. Restart the Open iT Core Server Pipeline service, run the command:

   Command Syntax

   systemctl restart openit-coreserverpipeline

Verify Report Generation

Windows

1. Open a command prompt with Administrator level privileges.

2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

   Command Syntax

   cd C:\Program Files\OpeniT\Core\bin

3. Run the command to generate distinct usage report:

   Command Syntax

   openit_audit.exe <args>

   Name	Description
   --from	Use this to specify the start date for data parsing (YYYY-MM, YYYY/MM, YYYY)
   --to	Use this to specify the end date for data parsing (YYYY-MM, YYYY/MM, YYYY)
   --debug	Use this to activate debugging mode
   --verbose	Use this activate verbose logging mode. This will not work without --debug.

   Arguments for executing openit_audit
   
   
   Example

   openit_audit.exe --from 2020-01 --to 2020-05 --debug --verbose

4. Verify that C:\ProgramData\OpeniT\Data\database\audit contains the following files.

   • audit.db
   • audit.sign
   • audit_trail

Unix

1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

   Command Syntax

   cd /opt/openit/bin

2. Run the command to generate distinct usage report:

   Command Syntax

   ./openit_audit <args>

   Name	Description
   --from	Use this to specify the start date for data parsing (YYYY-MM, YYYY/MM, YYYY)
   --to	Use this to specify the end date for data parsing (YYYY-MM, YYYY/MM, YYYY)
   --debug	Use this to activate debugging mode
   --verbose	Use this activate verbose logging mode. This will not work without --debug.

   Arguments for executing openit_audit
   
   
   Example

   ./openit_audit --from 2020-01 --to 2020-05 --debug --verbose

3. Verify that /data/database/audit contains the following files. The directory may vary depending on the declared database value upon installation.

   • audit.db
   • audit.sign
   • audit_trail

Next Steps?

After configuring Usage Audit, you may proceed with its user interface.

Usage Audit Reporting Interface