Toggle menu

Data Retention Audit Log

When data is deleted, an audit log is written to the platform's History service.

Deleted History Records

When a history is deleted by a schedule an audit log is written to the History service.

The labela and labelb of the audit log match the labels of the history that was deleted. Events are added for each of the labelc types that are deleted.

For example, this audit was created after two histories relating to a Case Management case had been deleted. The first history had a labelc of "notes", the second "email". If other histories relating to this case (ie have the same labela and labelb, but different labelc) get deleted, they'll be added to the audit log as additional notes.

{
    "id": "cfcc33b5-9715-437f-9393-2a9d5b15fd8c",
    "labela": "Case Management - Allotment Structures", //The labela of the history that was deleted
    "labelb": "6787-6376-0023-7547", //The labelb of the history that was deleted
    "labelc": "audit",
    "labeld": null,
    "labele": null,
    "created": 1631261110610,
    "sealed": false,
    "subject": {
        "description": "DRM audit"
    },
    "lastupdated": 1631261110813,
    "events": [{
        "pos": [1, 2],
        "event": {
            "private": false,
            "description": "Deleted by daily schedule",
            "event": "SUMMARY",
            "labelc": "notes" //The labelc of the history that was deleted
        },
        "fpos": [1, 2],
        "timestamp": 1631261110610
    }, {
        "pos": [2, 2],
        "event": {
            "private": false,
            "description": "Deleted by daily schedule",
            "event": "SUMMARY",
            "labelc": "email" //The labelc of the history that was deleted
        },
        "fpos": [2, 2],
        "timestamp": 1631261110813
    }]
}

Form Data

Audit histories are written for each form data type that is deleted. New events are added to the history each time data is deleted, detailing each object deleted in that run. In other words, a single audit history exists for each form, and events are added when saved data created by that form is deleted.

Form data audits all have "labela": "retention_formdata" and "labelc": "audit". labelb is a unique ID.

For example, this is an audit record for a single form. The first time the schedule ran two objects (form submissions) were deleted, the second time, three were deleted.

{
    "labela": "retention_formdata",
    "labelb": "9249-3251-3224-8557",
    "labelc": "audit",
    "labeld": null,
    "labele": null,
    "created": 1720447454280,
    "lastupdated": 1721667601147,
    "sealed": false,
    "subject": null,
    "events": [{
        "pos": [1, 2],
        "event": {
            "description": "DRM deleted form data for ObjectID: 16007,16008",
            "formData": [{
                "Type": "FORM_FORMTESTINGDATAINFORMAL",
                "_ItemClass": "CSObject",
                "ObjectID": 16007,
                "Label": "73845C06-68B3-4DBE-8E8A-3BDB6D3AA272"
            }, {
                "Type": "FORM_FORMTESTINGDATAINFORMAL",
                "_ItemClass": "CSObject",
                "ObjectID": 16008,
                "Label": "6FCD1546-9A79-403E-A254-4294F2FF2833"
            }]
        },
        "timestamp": 1720447454280
    }, {
        "pos": [2, 2],
        "event": {
            "description": "DRM deleted form data for ObjectID: 16011,16012,16013",
            "formData": [{
                "Type": "FORM_FORMTESTINGDATAINFORMAL",
                "_ItemClass": "CSObject",
                "ObjectID": 16011,
                "Label": "6BBE797D-586F-463D-B4AB-AEBE19593C16"
            }, {
                "Type": "FORM_FORMTESTINGDATAINFORMAL",
                "_ItemClass": "CSObject",
                "ObjectID": 16012,
                "Label": "2419C590-F2CC-4E61-8790-ED50A3B0030E"
            }, {
                "Type": "FORM_FORMTESTINGDATAINFORMAL",
                "_ItemClass": "CSObject",
                "ObjectID": 16013,
                "Label": "71A61174-4768-4C50-88DC-0415BDF2FC37"
            }]
        },
        "timestamp": 1720447567340
    }]
}

Last modified on August 21, 2024

Share this page

Facebook icon Twitter icon email icon

Print

print icon