# User backup configure & restore (backup addon)

## Description

<p class="callout success">On the **User backup configure &amp; restore page**, you could search, check and restore the user's snapshots.</p>

<p class="callout info">Also on this screen, you can also configure the frequency and number of backups to be performed.</p>

## Screen overview

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/p2GaFi2Z8k9colt2-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/p2GaFi2Z8k9colt2-image.png)

## Related objects

- [Users](https://bookstack.soffid.com/books/adv/page/users): new Backups tab in the Users page, user object has backups
- [Groups](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/groups "Groups"): user assignments to groups have backup
- [Accounts](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/accounts "Accounts"): user's accounts have backup
- [Roles](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/roles "Roles"): user's roles (grants) have backup
- [Mail lists](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/mail-lists "Mail Lists"): user's mail lists have backup

## Standard attributes

- **User Name**: userName of a user
- **Valid since**: date and time when this backup started
- **Valid until**: if it is not the last backup, date and time when this backup finished
- **Download**: XML file with the user snapshot info.

## Actions

#### Table actions

<table border="1" id="bkmrk-add-or-remove-column" style="width: 100%; height: 338.722px;"><tbody><tr style="height: 35.4688px;"><td style="width: 18.7152%; height: 35.4688px;">**Query**

</td><td style="width: 81.298%; height: 35.4688px;">Allows you to query users through different search systems, [Basic and Advanced](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/search-types "Search Types").

</td></tr><tr style="height: 142.014px;"><td style="width: 18.7152%; height: 142.014px;">**Restore**

</td><td style="width: 81.298%; height: 142.014px;">Allows you to restore one or more user's snapshots.

First of all, you need select one or more snapshots.

Second, you need to click the "Restore" button.

Then Soffid will run the restore process.

<details><summary>Image</summary>

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/ZkbLRnc7wkbrP4jM-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/ZkbLRnc7wkbrP4jM-image.png)

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/NqLZL1YP83jdfjJn-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/NqLZL1YP83jdfjJn-image.png)

</details></td></tr><tr style="height: 46.6667px;"><td style="width: 18.7152%; height: 46.6667px;">**Download CSV File**

</td><td style="width: 81.298%; height: 46.6667px;">Allows you to download a CSV file with the basic information of all backups, with the same columns as displayed in the table.

</td></tr><tr style="height: 21.2396px;"><td style="width: 18.7152%; height: 21.2396px;">**Configure backup**

</td><td style="width: 81.298%; height: 21.2396px;">Allows you to configure the backup parameters.

</td></tr><tr style="height: 46.6667px;"><td style="width: 18.7152%; height: 46.6667px;">**View**</td><td style="width: 81.298%; height: 46.6667px;">Allows you to show and hide columns in the table.

You can also set the order in which the columns will be displayed.

</td></tr><tr style="height: 46.6667px;"><td style="width: 18.7152%; height: 46.6667px;">**Download**

</td><td style="width: 81.298%; height: 46.6667px;">Allows you to download an XML file with the user. You only need to click on the download icon of one of the records and save the file on your computer.

</td></tr></tbody></table>

#### Configure backup button

With the "Configure backup" button, you can configure the frequency and number of backups. These are the available parameters:

- **Minimum delay between backups**: if the value is 1, when a backup is created, the system will not create a new backup until 1 day later, even if there has been more than one change during that period.
- <div class="label">**Number of backups to keep alive**: if the value is 10, when 10 backups are reached, the oldest backup will be deleted when the next one is created.</div><div class="container wrapped singlevalue" id="bkmrk--1"></div>
- <div class="label">**Enable entitlements history**: enable the history of roles assigned to users.</div>

<details id="bkmrk-image"><summary>Image</summary>

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/iGSB9seMdLvf60x0-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/iGSB9seMdLvf60x0-image.png)

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/8tWdt1UczBxprb6P-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/8tWdt1UczBxprb6P-image.png)

</details>## Others

#### Backup tab on user's page

On the users screen, when you select a user, this addon enables the **Backups tab**.

<details id="bkmrk-image-1"><summary>Image</summary>

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/GTTAgRzgcrwNMTny-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/GTTAgRzgcrwNMTny-image.png)

</details>This tab displays the **user's backups**.

<details id="bkmrk-image-2"><summary>Image</summary>

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/yBLghnWKr7kceH2Q-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/yBLghnWKr7kceH2Q-image.png)

</details>There are also several **buttons** with the rest of the items that can have backup.

<details id="bkmrk-image-3"><summary>Image</summary>

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/Cj1WEp9hnf5LVHn8-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/Cj1WEp9hnf5LVHn8-image.png)

</details>These are the buttons:

- **Groups History**: user assignments to groups have backup
- **Accounts History**: user's accounts have backup
- **Roles History**: user's roles (grants) have backup
- **Mail lists History**: user's mail lists have backup

<details id="bkmrk-image-4"><summary>Image</summary>

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/iwumbrGuDGmb8x0I-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/iwumbrGuDGmb8x0I-image.png)

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/CSUo0aFdpBlodoJs-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/CSUo0aFdpBlodoJs-image.png)

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/blAsYnbIuKcd4h18-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/blAsYnbIuKcd4h18-image.png)

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/Ui4y96dvOaSuBQ0U-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/Ui4y96dvOaSuBQ0U-image.png)

</details>In any of the four options, when selecting an old record, the ‘**Restore**’ button will appear and this object can be restored to the user.

<details id="bkmrk-image-5"><summary>Image</summary>

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2025-12/scaled-1680-/2sxT0ez2wGNPXlb6-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2025-12/2sxT0ez2wGNPXlb6-image.png)

</details>