Agent de suppression de documents processus

Sommaire

• Présentation générale
• Fonctionnalité de l’agent
• Configuration de l’agent
  • Créer l’agent à partir d’un modèle
  • Paramétrage du XML de l’agent
  • Exemple de configuration
• Utilisation

Présentation générale

On a souvent besoin de “purger” un processus des documents inutiles (comme les brouillons - documents non envoyés dans le processus - ou les documents annulés).

Cet agent planifié permet de supprimer des documents répondant à des critères donnés.

Fonctionnalité de l’agent

Supprimer des documents.

Configuration de l’agent

Créer l’agent à partir d’un modèle

Allez dans Administration > Planification des agents.

Créez un agent à partir du modèle Agent de suppression des documents de processus (DeleteWorkflowInstancesAgent).

Paramétrage du XML de l’agent

Il est nécessaire de paramétrer l’agent via un XML (Onglet “Configuration”), en cliquant sur le bouton Remplacer par la configuration d’origine.

• deletion/organization : Nom système de l’organisation de l’application.

• deletion/project : Nom système de l’application.

• deletion/catalog : Nom système du groupe de processus.

• deletion/workflowContainers : Noms systèmes des processus à purger, séparés par des “;”.

Pour vous aider, voici un rappel sur la structure des différents niveaux / où trouver les noms systèmes pour Project, Catalog, WorkflowContainer dans le Studio :

• constraint : Les filtres pour sélectionner les documents à supprimer (opérateur logique “ET” entre les contraintes).

Toutes les contraintes ne sont pas forcément utilisées, mais au moins une doit être présente.

Les contraintes possibles sont :

- `status` : le statut interne du document :
    - "DRAFT" : Brouillon.
    - "STARTED" : En cours.
    - "ABORTED" : Annulé.
    - "TERMINATED" : Terminé.

- `datefield` : Un champ date + `lessThanNbOFDays` : nombre de jours passés depuis le champ date.

- `documentState` : Un état de document particulier.

- `processState` : Un état de processus particulier.

Exemple de configuration

<configuration>
 <deletion organization="DefaultOrganization" project="ApplicationName" catalog="CatalogName" workflowContainers="processName1;processName1">
  <constraint status="ABORTED"/>
  <constraint dateField="sys_CreationDate" lessThanNbOFDays="15"/>
  <constraint documentState="En cours" />
  <constraint processState="Initialisé" />
 </deletion>
</configuration>

Utilisation

Planifiez l’agent ou exécutez-le en interactif.

Le rapport d’exécution de l’agent liste les références des documents supprimés.

Astuce : avant la première exécution de l’agent, cela peut-être une bonne idée de faire une sauvegarde des documents :

• sur DevOps : faire un SnapShot
• on-remise : faire un backup de la BBD (lourd) ou concevoir une vue avec comme filtre les mêmes contraintes que celles déclarées dans l’agent et affichant toutes les colonnes puis faire un export Excel de cette vue.