Skip to main content

Retention and reset

In operation, Xchange collects data about itself: which events came in, which jobs ran, what went wrong. This amount grows as long as the system is working. Its growth has a limit — Xchange cleans it up after periods that you set.

This page says what disappears on its own, what stays and what Reset system deletes.

Two things are called Cleanup

This page is about the Automatic cleanup — Xchange deletes its own old records. The run type Cleanup is something else: it reports records to the target system that no longer match a route's data filter. The two are on different screens and are independent of each other.

What disappears on its own​

Five periods cover everything that operation produces: Settled events, Completed operations, Resolved clarification cases, Usage records and System log. Each period is a number in days, and you enter it on Settings — which is also where it says what an empty field means.

Only what is finished is deleted — settled, completed, resolved. A job that has been waiting in clarification for weeks is kept, no matter how old it is. You can therefore set the periods short, and open work still stays complete.

What stays​

Your configuration is exempt from the periods. Routes, connections, mappings, value tables stay until someone deletes them.

The configuration snapshots themselves stay as well: every activated version is kept as a snapshot, no matter how old it is.

What you set up stays; what operation produced has a period.

When it should go faster​

A shorter period applies immediately to everything, including the existing data. If you set Completed operations from 90 to 30 days, everything older than 30 days goes on the next run.

Until that run you can take the change back by raising the number again. When you shorten a period, the screen therefore shows a warning.

Two things hold up a run. If the amount is large, it continues on the next run where it left off. And when the system stands still, deleting rests as well. Which halt locks what is described under System status and license.

Reset system​

Reset system also deletes what no period covers. The button appears only in two states that Xchange detects at startup: Database Change Detected, when it is attached to a different database than before — for example after a system was copied — and Binding Interrupted, when a binding between Xchange and its database that was started was not completed. The button is then on System Status.

As long as your system is working, it stays hidden; cleaning up happens through the periods. What resetting deletes and what it keeps:

DeletedStays
All processing dataThe entire configuration
The credentials of all connectionsAll configuration snapshots, including the old ones
The activation — the active snapshot becomes a draft againYour retention periods

Have the credentials of all connections ready before you click. Resetting deletes them, and only with them does Xchange process again afterwards. For OAuth access they are often issued by the operator of the external system — ask there in good time.

This step cannot be undone, and the system says so before it runs. A draft that is currently being worked on is kept — it is parked and can be brought back afterwards.

Afterwards two things must be done, and only then does Xchange process again: re-enter the credentials of the connections and activate the configuration snapshot again. The system tells you both once more after the reset.

See also​