Breadcrumbs

Handling Datamart Table Structure Changes (Agents)

This article outlines how Datamart table structure changes caused by agent configuration updates impact existing data. It highlights the differences between draft and approved agents and the user actions required to safely handle data retention and table recreation.

When Datamart Structure Changes

A Datamart structure change occurs when an implementation requires a new or updated Datamart column, for example:

  • Agent-preserved column configuration changes

  • New column added to the Datamart table

  • Datamart table configuration changes (e.g., column name, label)

Any of the above will cause the underlying Datamart table definition to be considered changed.

Agent Behavior

Non‑approved (Draft) Agents

For agents that are not yet submitted and approved (treated as draft agents):

  • The Datamart table changes are automatically applied.

  • The affected Datamart Tables are recreated.

  • As part of recreation, all existing data in the changed Datamart table is cleared.

No manual action is required unless the user wants to preserve the existing data.

Approved Agents

For approved agents:

  • The system does not automatically recreate the Datamart table.

  • The user must manually remove the Datamart table so the system can recreate it based on the new structure.

  • When the Datamart table is removed and recreated, all existing data in that Datamart table is cleared as a result of the removal.

Data Impact and User Responsibilities

Users must be aware of the following:

  • When a Datamart table structure changes and the Datamart table is recreated, all existing data in that Datamart table is cleared.

  • If users need the existing data for future reference, they must back up the data before the Datamart table is recreated or removed.

For Non‑approved (Draft) Agents

  • Draft agents are assumed to be in a design / test phase.

  • No action is required from the user for structural Datamart Table changes, unless they want to keep the current data.

  • If data retention is needed, users should export / backup the Datamart Table data before the change is applied.

For Approved Agents

To safely handle Datamart Table structure changes for an approved agent:

  1. Disable Automatic Execution

    • Remove any schedules from the agent so it does not run automatically via the scheduler during the transition.

  2. Archive the Existing Agent

    • Duplicate the existing approved agent.

    • Use the duplicated agent as the new main agent going forward.

    • Keep the original agent as an archived agent (for reference or audit, as needed).

  3. Handle Datamart Table Recreation

    • On the archived agent, manually remove the affected Datamart tables so that the system can recreate them with the updated structure.

    • Ensure that any required data backup has been performed before removal, as this process will clear all existing data in the Datamart table.

Summary

  • Any Datamart table structure change (columns or config) results in Datamart table recreation and data clearing.

  • Draft agents

    • Changes are applied automatically.

    • Data is cleared on recreation.

  • Approved agents

    • User must manually remove Datamart tables.

    • Data is cleared on removal.

    • Users are responsible for backing up data they want to retain before Datamart Table removal or recreation.