ÃÛ¶¹ÊÓƵ

DocumentationCampaignCampaign Standard Documentation

Audit trail audit

Last update: Mon May 16 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Admin

The Audit trail gives you access to the complete history of changes made within your instance.

Audit trail captures, in real-time, a comprehensive list of actions and events occurring within your ÃÛ¶¹ÊÓƵ Campaign Standard instance. It includes a self-serve way to access a history of data to help answer questions such as: what happened to your workflows, custom resources and options, who last updated them or what did your users do in the instance.

Audit trail consists of three components:

  • Custom Resources Audit trail: check the activity and last modification done to custom resources.

    For more information on Custom resources, refer to this page.

  • Workflow Audit trail: check the activity and last modification done to workflows, and additionally, the state of your workflows such as:

    • Created
    • Modified
    • Deleted
    • Workflow Start
    • Workflow Pause
    • Workflow Stop
    • Workflow Restart
    • Workflow Cleanup
    • Workflow Simulate
    • Workflow Wakeup
    • Workflow Immediate Stop
    • Workflow Restart with same user
    • Workflow Restart Unknown command

    For more information on Workflows, refer to this page.

  • Option Audit trail: check the activity and last modification done to options.

    For more information on Options, refer to this page.

Note that, by default, retention period is 30 days.

Accessing Audit trail audit-access

To access your instance’s Audit trail:

  1. In ÃÛ¶¹ÊÓƵ Campaign Standard, from the advanced menu, select Administration > Audit trail.

  2. The Audit trail window opens with the list of your entities. ÃÛ¶¹ÊÓƵ Campaign Standard will audit the create, edit and delete actions for workflows, options and custom resources.

    From the Search menu, you can filter your entity on:

    • Start date
    • End date
    • Type: Entity’s type between All, Workflow, Custom Resource and Option.
    • Entity name: ID of your workflow, option or custom resource

  3. Select one of the entities to learn more about the last modifications.

  4. The Audit entity window gives you more detailed information on the chosen entity such as:

    • Entity: ID of your workflow, option or custom resource.
    • Action: Last action performed on this entity.
    • Changed by: Username of the last person who last modified this entity.
    • Changed date: Date of the last action performed on this entity.
    • Content: Code block which gives you more information on what was changed exactly in your entity.

    In this example, we can see that the workflow WKF110 has been started on August 26th by the Business administrator of this instance.

Enable/disable Audit trail enable-disable-audit

NOTE
Only Functional administrators can enable or disable Audit trail. For more on this, refer to this page.

Audit trail can be easily activated or deactivated for a specific activity.

To do so:

  1. In ÃÛ¶¹ÊÓƵ Campaign Standard, from the advanced menu, select Administration > Application settings > Options.

  2. Select one of the following options depending on the entity you want to disable:

    • XtkAudit_Workflows option to manage the Audit trail for Workflows.

    • XtkAudit_Option option to manage the Audit trail for Options.

    • XtkAudit_CusResource option to manage the Audit trail for Custom resources.

    • XtkAudit_Enable_All option to manage the Audit trail for every entity.

      note note
      NOTE
      If the XtkAudit_Enable_All option is set to 0, the Audit trail feature will be completely disabled, regardless of other individual option values.

  3. From your Options page, set the Value (integer) to 0 if you want to disable the Audit trail or to 1 to enable it.

  4. Click Save.

recommendation-more-help
3ef63344-7f3d-48f9-85ed-02bf569c4fff