Edit

Sample: Audit table data changes

  • Article

This sample shows how to enable and disable auditing on a table and its columns, retrieve the data change history of the audited table, and delete the audit records. You can view the sample here.

How to run this sample

  1. Download or clone the Samples repo so that you have a local copy.
  2. (Optional) Edit the dataverse/App.config file to define a connection string specifying the Microsoft Dataverse instance you want to connect to.
  3. Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in dataverse/App.config, any sample you run will use that connection information.

If you do not specify a connection string in dataverse/App.config file, a dialog will open each time you run the sample and you will need to enter information about which Dataverse instance you want to connect to and which credentials you want to use. This dialog will cache previous connections so that you can choose a previously used connection.

Those samples in this repo that require a connection to a Dataverse instance to run will include a linked reference to the dataverse/App.config file.

What this sample does

This sample does the following:

  1. Enable auditing for the organization and the account table if not already enabled.
  2. Create an account record.
  3. Use the RetrieveRecordChangeHistory message via the RetrieveRecordChangeHistoryRequest Class to retrieve the history of the account record created in step 2.
  4. Display some of the details information in each audit record.
  5. Update the account record, updating a specific column.
  6. Retrieve the change history of the changed column using the RetrieveAttributeChangeHistory message with the RetrieveAttributeChangeHistoryRequest Class.
  7. Display the attribute change history.
  8. Use the RetrieveAuditDetails message via the RetrieveAuditDetailsRequest Class to display some of the audit details.
  9. Return the environent auditing to the original state and delete the account record created.

How this sample works

In order to simulate the scenario described in What this sample does, the sample will do the following:

Setup

  1. Checks for the current version of the org.
  2. Enables auditing for the organization and account table if necessary.
  3. Creates an sample account record.

Demonstrate

Use of the RetrieveRecordChangeHistory, RetrieveAttributeChangeHistory, and RetrieveAuditDetails messages to show the kinds of data available through these auditing apis.

Clean up

Display an option to delete the sample data that is created in Setup. The deletion is optional in case you want to examine the tables and data created by the sample. You can manually delete the records to achieve the same result.