Last modified by Aurelie Bertrand on 2026/07/22 11:36
Show last authors
1 {{ddtoc/}}
2
3
4 ----
5
6 (% class="wikigeneratedid" %)
7 This document describes the installation and configuration of the DigDash BI audit module. In particular, this module enables administrators to view audit information, such as the list of data cubes and Flows, and the history of user sessions.
8
9 = Installing the module =
10
11 You can deploy the audit module from the** DigDash Metadata Service//~://**
12
13 1. Launch **Studio**.
14 1. Click the **‘Managers’ **button in the left-hand sidebar.
15 1. In the box that appears, click on **DigDash Metadata Service**.
16 [[image:Managers_page_FR.png||height="491" width="960"]]
17 \\➡ The **DigDash Metadata Service **box **appears **.
18 1. Search for and select the **Audit Module **component **corresponding **to your version of DigDash BI. In this example, version **2025R2** is used.
19 **[[image:DDMS_audit_en.png]]**
20 1. Click **Install Now**.
21 1. When the installation is complete, the following message appears:
22 [[image:DdAudit_install_succed_en.png]]
23 1. Click **OK**, then **Close**.
24 ➡ A message stating that the interface has to be refreshed appears.
25 1. Click **Yes**.
26
27 == (% style="color:inherit; font-family:inherit; font-size:max(20px, min(24px, 12.8889px + 0.925926vw))" %)Items created during installation(%%) ==
28
29 The following items are created during installation:
30
31 * A connection named **Ddaudit**.
32 * A **DDAudit** role containing:
33 ** predefined data models for creating visualisations from audit data;
34 ** predefined flows (list of cubes, flows and user sessions);
35 ** a dashboard for viewing audit data.
36
37 = Configuring the DDAudit database =
38
39 You must configure a DDAudit database to store the audit data. We recommend using a MariaDB database. MySQL and PostgreSQL databases are also supported.
40
41 To do this:
42
43 1. From the home page, go to **Configuration > Server Settings > Database > [[Audit Data>>path:/xwiki/wiki/dev/view/Digdash/deployment/configuration/configuration_guide/audit_data/]].**
44 1. Enter:
45 1*. **The database URL**
46 1*. **The databaseusername** and **password.**
47 [[image:Audit_data_EN.png||alt="Configurer base de données"]]
48 1. (((
49 You can also carry out the following operations:
50
51 * delete old data: enter a date up to which you wish to delete data in the **‘Delete audit events up to’** field.
52 * set the data retention period: enter a number of days in the **‘Data retention’** field.
53 )))
54
55 (% class="box warningmessage" %)
56 (((
57 ⚠ If you subsequently change the database connection settings, please also remember to update the connection named **DDAudit**.
58 )))
59
60 = Updating the named database connection =
61
62 Once the database has been configured, update the named connection **‘DDAudit’** created during the module installation.
63
64 1. Open the **Managers** tab in Studio.
65 1. Click **Databases to **open the **Database Connection Manager.**
66 1. Select and edit the **Ddaudit** database.
67 1. Enter your database connection details.
68 1. Restrict access to the database to the **DDAudit** role.
69 [[image:Connexion_ddaudit_en.png]]
70 1. Check that the connection is working by clicking the **Test Connection** button.
71 1. Click**OK**.
72
73 The database connection is updated in all audit data models.
74
75 = Accessing DigDash BI audit data =
76
77 To access audit data, assign the **DDAudit** role to the DigDash BI administrator or any other authorised user.
78
79 From the **Configuration > Server Status** page, start the audit services you wish to use (session, cube and {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} audit services, etc.).
80 [[image:Audit_services_EN.png||alt="Services d'audit"]]
81
82 The predefined dashboards are accessible from the Dashboard, within the **DDAudit** role.
83
84 [[image:DDaudit_dashboard_en.png]]
85
86 You can also create your own flows based on data models, or even new data models based on the audit database.
87
88 = Location of DDAudit database files =
89
90 In some cases, you may need to change the location of the DDAudit database files.
91 See the page [[Changing the location of DDAudit database files>>doc:Digdash.deployment.configuration.DDAudit.ddaudit_module_install.DDAudit_location.WebHome]] for further information