> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/produit/efalia-ecm/administration/controle-de-retention.md).

# Contrôle de rétention

## Aperçu

<img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-8402bfd36bf4219e626789183afed0882a26960c%2Fzz-controle-de-retention-01.png?alt=media" alt="" width="24">

Le contrôle de rétention permet de définir une durée au terme de laquelle les anciens documents sont automatiquement retirés du système ou transmis à un processus défini.

Le contrôle de rétention peut être défini individuellement pour chaque type de document. Pour démarrer les actions configurées une fois la durée définie écoulée, le contrôle de rétention doit être activé et piloté par un planificateur. Les actions de rétention sont exécutées pour tous les types de documents configurés.

## Création d’un processus de rétention

<img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-8b57c3f721e8bf5eb2dafc7467173248167148b4%2Fzz-controle-de-retention-02.png?alt=media" alt="" width="24">

Pour créer un processus de rétention, sélectionnez l' ***icône de contrôle de rétention*** et choisissez Nouvel outil.

Depuis la fenêtre suivante des ***Paramètres de Rétention*** , vous pouvez définir les paramètres pour chaque type de document dans le Gestionnaire DTD. Tous les processus de conservation effectués sur les documents du Cabinet sont basés sur une date précise à partir de laquelle la période de conservation commence.

Chaque Type de Document peut être configuré séparément, de sorte que différentes actions soient effectuées, selon les exigences des documents stockés dans chaque Type de Document.

Pour appliquer des paramètres pour chaque type de document, sélectionnez le type de document dans la liste affichée dans la ***fenêtre des Paramètres***, puis appliquez les paramètres de rétention.

## Conditions

### Type de document

Le menu déroulant contient tous les types de documents dans le Gestionnaire DTD. Les règles, définies dans la section Règles, ne s'appliquent qu'au type de document sélectionné.

{% hint style="info" %}
Si plusieurs types de documents doivent être configurés pour le contrôle de la rétention, un processus de conservation distinct doit être mis en place pour chaque type de document.
{% endhint %}

### Valeurs de champ

Dans ce tableau, des conditions supplémentaires peuvent être définies sur la base des valeurs des champs. Plusieurs entrées sont liées par un opérateur ET.

Le champ correspondant peut être sélectionné via un menu déroulant dans la colonne ***Champ***. Seuls les champs liés au type de document sélectionné sont affichés dans le menu déroulant.

<img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-8ebe97f06bcfd5ba350733613e5d558dfc584dd7%2Fzz-controle-de-retention-03.png?alt=media" alt="" width="24">

Ce bouton ajoute une ligne supplémentaire à la table.

<img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-e97888424510b8b087f3327853bb2c40bc664b93%2Fzz-controle-de-retention-04.png?alt=media" alt="" width="24">

Ce bouton supprime la dernière ligne du tableau.

## Règles

### Date de référence

Date de référence à partir de laquelle la durée de conservation des documents et les actions à exécuter après son expiration doivent être configurées.

| Option                        | Description                                                                                                                            |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Date de création du document  | La date de création du document dans Efalia ECM                                                                                        |
| Date de dernière modification | C'est la date de la dernière révision                                                                                                  |
| Champ d'index                 | Ici, un champ d'index de dates peut être sélectionné. Tous les champs de date disponibles du type de document sélectionné sont listés. |

### Période de conservation

La période de conservation peut être définie en années, mois et jours à partir de la date de référence sélectionnée. À l’issue de cette période, le processus de rétention configuré démarre.

Appuyez sur le ***bouton Plus*** pour ajouter une période de rétention.

Plus d'une période de rétention avec des actions peuvent être configurées pour chaque type de document.

### Action externe

<img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-88bd296d79e610a447e6034a767e998ae9990214%2Fzz-controle-de-retention-05.png?alt=media" alt="" width="24">

La case ***à cocher Action externe*** permet d'implémenter dans votre processus de rétention des actions qui ne sont pas effectuées par Efalia ECM.

Lors de la sélection d'action externe, ***les années*** sont fixées à ***999.*** Des chiffres comme ***999888777***, etc. sont réservés à l'***action extérieure***.

Dans ce cas, un utilisateur doit confirmer cette étape externe via la phase de validation dans Efalia ECM WinClient. La phase de validation se trouve dans l’onglet Modifier du ruban ainsi que dans le menu contextuel accessible par clic droit.

### Action de démarrage

Des actions multiples, différentes et consécutives peuvent être définies ici pour chaque type de document.

{% hint style="warning" %}
La première action définie dans la liste de la colonne Start Action sera exécutée immédiatement lors de la prochaine exécution du planificateur de contrôle de rétention.
{% endhint %}

Appuyez sur le ***bouton Plus*** pour ajouter une période de rétention.

Les actions suivantes peuvent être appliquées.

| Paramètre              | Description                                                                                                                                                                                                                                                                                                                                          |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Aucun                  | Aucune action de démarrage ne sera appliquée.                                                                                                                                                                                                                                                                                                        |
| Exportation            | Copie les données du document conservées dans le pool de stockage vers l'emplacement défini dans Exporter. Les données dans la base de données ne sont pas modifiées. Les données d'index et le document restent au Cabinet.                                                                                                                         |
| Exporter et supprimer  | Déplace les données documentaires contenues dans le pool de stockage vers l'emplacement défini dans Export. Les données d'index dans la base de données ne sont pas modifiées. Note : Le répertoire d'exportation doit être ajouté aux pools de stockage car les documents restent récupérables par les utilisateurs. Voir Nouveau pool de stockage. |
| Marquer comme supprimé | Signale un document comme supprimé et n'est pas listé dans les listes de recherche ou de recherche étendue                                                                                                                                                                                                                                           |

de WinClient ou WebServer. Une ***recherche d'informations*** utilisant l'option ***Statut : Supprimé*** est nécessaire pour récupérer ces documents.

{% hint style="info" %}
Le document n'est pas supprimé physiquement du pool de stockage et les données d'index dans la base de données ne sont pas modifiées. Processus Si des processus ont été définis, les documents peuvent être envoyés à un processus spécifié.
{% endhint %}

### Action finale

L'Action de fin sera appliquée aux documents une fois que toutes les périodes de traitement de conservation seront terminées.

Les options disponibles sont :

| Paramètre                  | Description                                                                                                                                                                                                                                                                                                                                          |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Aucun                      | Aucune action finale ne sera appliquée.                                                                                                                                                                                                                                                                                                              |
| Exportation                | Copie les données du document conservées dans le pool de stockage vers l'emplacement défini dans Exporter. Les données dans la base de données ne sont pas modifiées. Les données d'index et le document restent au Cabinet.                                                                                                                         |
| Exporter et supprimer      | Déplace les données documentaires contenues dans le pool de stockage vers l'emplacement défini dans Export. Les données d'index dans la base de données ne sont pas modifiées. Note : Le répertoire d'exportation doit être ajouté aux pools de stockage car les documents restent récupérables par les utilisateurs. Voir Nouveau pool de stockage. |
| Exportation et destruction | Déplace les données du pool de stockage du document vers un emplacement défini, supprime le document contenu dans le pool ainsi que toutes les données d'index de la base de données.                                                                                                                                                                |
| Détruire                   | Supprime toutes les données de documents contenues dans le pool de stockage, ainsi que toutes les données de la base de données.                                                                                                                                                                                                                     |
| Marquer comme supprimé     | Signale un document comme supprimé et n'est pas listé dans les listes de recherche ou de recherche étendue de WinClient ou WebServer. Une recherche d'informations utilisant l'option Statut : Supprimé est nécessaire pour récupérer ces documents. Note :                                                                                          |

Le document n'est pas supprimé physiquement du pool de stockage et les données d'index dans la base de données ne sont pas modifiées. Processus Si des processus ont été définis, les documents peuvent être envoyés à un processus spécifié.

### Exporter vers

L'emplacement où les données du document doivent être exportées peut être défini. Veuillez noter que le ***compte FD-Server*** nécessitera des autorisations pour accéder à l'emplacement sélectionné. Seul un utilisateur administratif d'Efalia ECM peut définir le chemin d'exportation.

### Exercice financier

Le paramètre Exercice Fiscal vous permet de configurer toute période de rétention pour qu'elle fonctionne uniquement à la fin de l'exercice financier de votre entreprise. Il se peut que la période de conservation d'un document expire fin mai, mais que vous ne souhaitiez que les documents soient traités uniquement à la fin de votre exercice financier, c'est-à-dire fin décembre. Dans ce cas, fixez la valeur à 12.

### Exemple

L'exemple suivant montre un ***contrôle de rétention*** pour le type de document ***Facture entrante***.

Les factures doivent être ***marquées comme supprimées*** après 10 ans et ***détruites*** après 11 ans.

La période de conservation est basée sur la ***date de création*** du document concerné.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-613d1d93259abd5b6d18abfc2d3ed3ed0eddf492%2Fzz-controle-de-retention-06.webp?alt=media" alt=""><figcaption></figcaption></figure>

### Éléments utilisés dans cet exemple

#### Type de document

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-8fcd54ac2e72d1293b221132e1c9f1578360b9f1%2Fzz-controle-de-retention-07.webp?alt=media" alt=""><figcaption></figcaption></figure>

#### Date basée sur

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-6fd8e0971ac2ab321ec54fc3a2a46d0b64bd6655%2Fzz-controle-de-retention-08.webp?alt=media" alt=""><figcaption></figcaption></figure>

Première action – Aucune L'action, définie dans la première ligne de la table, est exécutée immédiatement lors de l'exécution suivante du planificateur de contrôle de rétention.

La valeur saisie dans la ***colonne Années*** dans cet exemple (***10***) commence après l'exécution de l'action de cette ligne et est calculée en fonction de la date définie sous ***Date basée sur***.

Dans ce cas, l'action est ***Aucun*** et est calculée en fonction de ***la date de création du Document***.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-85be685454040c1afe3013e79c6ee1254a45150e%2Fzz-controle-de-retention-09.webp?alt=media" alt=""><figcaption></figcaption></figure>

Deuxième action – Marquer comme supprimé L'action, définie dans la ligne suivante du tableau, est exécutée après la période définie dans la ligne précédente Dans ce cas, après ***10 ans***.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-6c9794faeb47ace5472344db49e2bff1f534f9ea%2Fzz-controle-de-retention-10.webp?alt=media" alt=""><figcaption></figcaption></figure>

Action finale L' ***action de fin*** est exécutée après la période, définie dans la dernière ligne du tableau ci-dessus Dans ce cas, un an après que le document concerné ait été ***Marqué comme supprimé*** ou 11 ans après la ***date de création du document***.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-50424f47921ba5a9a4377c211fec7b149ccc92a7%2Fzz-controle-de-retention-11.webp?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Les valeurs dans le tableau sont basées sur la ligne précédente et ne sont pas calculées à partir de la valeur définie sous Date basée sur.
{% endhint %}

## Exportation et récupération de données sur CD

Si des données sont exportées dans un répertoire défini, un fichier vide est créé dans ce répertoire avec un identifiant média dans le nom du fichier. (Nom du fichier : date et heure exacte, par exemple : FD 2005-01-17T17\_03\_48.096.mid) ainsi que le répertoire de données du Cabinet. Ce fichier doit être copié sur CD afin de rendre possible la récupération depuis CD.

{% hint style="info" %}
Si l'action Destruction est activée, les documents sont complètement supprimés et ne peuvent plus être récupérés.
{% endhint %}

Dans la base de données SQL, cet identifiant média est stocké par rapport aux documents exportés pertinents.

Pour récupérer des documents à partir des données d'index encore présentes dans la base SQL, le lecteur CD doit être spécifié comme un pool de stockage alternatif. Si un document est recherché, on recherche d'abord le pool de stockage par défaut puis les emplacements de stockage selon leur priorité. Ensuite, la recherche est étalée sur le \*. Fichiers MID stockés dans la base de données SQL. Si le lecteur CD était spécifié comme pool de stockage alternatif, le CD avec l'identifiant média correspondant devait être inséré. S'il n'est pas présent, un message s'affiche, et le système demande d'insérer le bon CD.

Il est nécessaire d'étiqueter les CD avec le bon identifiant de support.

{% hint style="info" %}
Lors de l'utilisation d'Oracle comme serveur de base de données, le nom du fichier \*.mid n'est pas spécifié, y compris les millièmes de seconde.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.efalia.com/produit/efalia-ecm/administration/controle-de-retention.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
