Wiki source code of Déploiement du module d'audit (DDAudit)
Last modified by Aurelie Bertrand on 2025/12/19 11:11
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
1.1 | 1 | {{ddtoc/}} |
| 2 | |||
| 3 | |||
| 4 | ---- | ||
| 5 | |||
| 6 | (% class="wikigeneratedid" %) | ||
| |
85.1 | 7 | This document describes the installation of the audit module integrated into DigDash Enterprise. This module enables a system administrator to view the list of data cubes and Flows as well as the history of user sessions. |
| |
1.1 | 8 | |
| |
85.1 | 9 | = Installing the module = |
| |
1.1 | 10 | |
| |
85.1 | 11 | You can deploy the audit module from the**Digdash Metadata Service//~://** |
| |
1.1 | 12 | |
| |
85.1 | 13 | 1. Launch the **Studio**. |
| 14 | 1. Click on the **Managers** button in the left-hand sidebar. | ||
| 15 | 1. In the box that appears, click on **DigDash Metadata Service**. | ||
| 16 | [[image:Managers_EN.png||alt="Managers" height="445" width="767"]] | ||
| 17 | ➡ The **DigDash Metadata Service **box appears. | ||
| 18 | [[image:DigDashMetadata_service_EN.png||alt="DigDash Metadata Service"]] | ||
| 19 | 1. Select the **New Audit Module** component and click **Install Now**. | ||
| 20 | When the installation is complete, a success message is displayed | ||
| 21 | 1. Click **OK** and then **Close**. | ||
| |
8.2 | 22 | |
| |
85.1 | 23 | == (% style="color:inherit; font-family:inherit; font-size:max(20px, min(24px, 12.8889px + 0.925926vw))" %)Items created during installation(%%) == |
| |
32.4 | 24 | |
| |
85.1 | 25 | A new **DDAudit** role containing the following elements is created: |
| |
22.1 | 26 | |
| |
85.1 | 27 | * Pre-defined data models for creating visualisations of audit data |
| 28 | * Pre-defined flows: list of cubes, lists of flows and lists of user sessions | ||
| 29 | * A dashboard displaying audit data | ||
| |
25.2 | 30 | |
| |
85.1 | 31 | = Configuring the DDAudit database = |
| |
38.1 | 32 | |
| |
85.1 | 33 | You need to configure a DDAudit database to store audit data. We recommend using a MariaDB database. MySQL and PostgreSQL databases are also supported. |
| |
25.2 | 34 | |
| |
85.1 | 35 | To do this |
| |
17.1 | 36 | |
| |
85.1 | 37 | 1. From the home page, go to **Configuration -> Server settings -> Database -> [[Audit data>>doc:Digdash.deployment.configuration.configuration_guide.audit_data.WebHome]]**. |
| 38 | 1. Enter : | ||
| 39 | 1*. The **URL of the database** | ||
| 40 | 1*. The **User** and **Database password.** | ||
| 41 | [[image:Audit_data_EN.png||alt="Configurer base de données"]] | ||
| 42 | |||
| |
71.4 | 43 | 1. ((( |
| |
85.1 | 44 | You can also : |
| |
17.1 | 45 | |
| |
85.1 | 46 | * delete old data: enter a date until which to delete the data in the **Delete audit events until** field. |
| 47 | * set the data retention period: enter the period in numbers of days in the **Data retention period** field. | ||
| |
71.4 | 48 | ))) |
| 49 | |||
| |
71.3 | 50 | (% class="box warningmessage" %) |
| 51 | ((( | ||
| |
85.1 | 52 | ❗If you change this connection information, don't forget to change the named connection to the DDAudit database. |
| |
71.3 | 53 | ))) |
| 54 | |||
| |
85.1 | 55 | = Creating the named connection to the database = |
| |
17.1 | 56 | |
| |
85.1 | 57 | Once the database has been configured, you need to create the database connection. To do this: |
| |
66.2 | 58 | |
| |
85.1 | 59 | 1. Display the Studio **Managers** tab. |
| 60 | 1. Click **Databases**. | ||
| 61 | 1. Click the **+** button to create a new database connection. | ||
| 62 | ➡ The **Edit Database Connection** box appears. | ||
| 63 | 1. Select the **SQL** type. | ||
| 64 | 1. Enter the name of the connection: **DDAudit**. | ||
| 65 | 1. Then enter your database configuration information. | ||
| 66 | 1. Leave the database restricted to the **DDAudit** role. | ||
| 67 | [[image:DBConnection_Audit_EN.png||alt="DDAudit connection"]] | ||
| 68 | 1. Check that the connection works by clicking on the **Test connection** button. | ||
| 69 | 1. Click** OK**. | ||
| |
66.2 | 70 | |
| |
85.1 | 71 | We will now select the database connection in the data models. |
| |
71.8 | 72 | |
| |
85.1 | 73 | = Selecting the database in the data models = |
| |
72.2 | 74 | |
| |
85.1 | 75 | To link the audit data templates to the database connection : |
| |
72.2 | 76 | |
| |
85.1 | 77 | 1. In the Studio data templates panel, go to the **DDAudit** role tab. |
| 78 | 1. Edit the data models and select **DDAudit** from the **Connection** drop-down list.[[image:1766134088880-278.png||alt="Connection"]] | ||
| 79 | 1. Click **Reload **to refresh the preview. | ||
| 80 | 1. Click **Finish**. | ||
| |
72.2 | 81 | |
| |
85.1 | 82 | = Accessing DigDash Enterprise audit data = |
| |
1.1 | 83 | |
| |
85.1 | 84 | In order to view this information you need to add the **DDAudit** role to your DigDash Enterprise administrator or any other user you wish for this task. |
| |
1.1 | 85 | |
| |
85.1 | 86 | From the **Configuration -> Server Status** page, start the audit services you wish to use (session audit service, cubes and flows, etc).[[image:Audit_services_EN.png||alt="Audit services"]] |
| |
1.1 | 87 | |
| |
85.1 | 88 | Predefined dashboards can be accessed directly from the** **Dashboard, in the DDAudit role. |
| |
1.1 | 89 | |
| |
85.1 | 90 | [[image:1766136875249-788.png||alt="Dashboard"]] |
| |
37.1 | 91 | |
| |
85.1 | 92 | You can also create your own flows based on data models, or even new data models on the audit database. |
| |
25.2 | 93 | |
| |
85.1 | 94 | = Location of DDAudit database files = |
| |
1.1 | 95 | |
| |
85.1 | 96 | In some cases, you may need to change the location of DDAudit database files. |
| 97 | See the page [[Modifying the location of DDAudit database files>>doc:.DDAudit_location.WebHome]] for more information |