ronan.quintin/Keryloo

Fork 0

Gestion des communications #25

New issue

Open

opened 2025-12-28 10:46:56 +01:00 by ronan.quintin · 0 comments

ronan.quintin commented

2025-12-28 10:46:56 +01:00

Owner

Spécification fonctionnelle — Module de Communication

1. Objectif

Mettre en place un module de communication transverse permettant l’envoi automatique de documents
(avis d’échéance, quittances, justificatifs futurs) aux locataires, déclenché par des événements métier
et orchestré via les workflows existants.

Ce module doit être générique, traçable, et évolutif (nouveaux canaux, nouveaux types de documents).

2. Périmètre fonctionnel

Inclus

Création d’un module Communication
Paramétrage des préférences de communication au niveau du locataire
Intégration avec les workflows existants :
- Création d’échéance → avis d’échéance
- Paiement complet → quittance
Traçabilité des communications (succès / échec)

Exclu (pour l’instant)

Relances automatiques d’impayés
Communication bailleur
Portail de consultation des communications
Multicanal avancé (SMS, courrier)

3. Concepts fonctionnels

3.1 Communication

Une Communication représente l’intention et l’exécution d’un envoi vers un destinataire.

Attributs fonctionnels :

Type de communication (AVIS_ECHEANCE, QUITTANCE, etc.)
Canal (EMAIL uniquement dans un premier temps)
Destinataire (locataire)
Statut :
- PENDING
- SENT
- FAILED
Documents associés (références GED)
Date de création
Date d’envoi
Message d’erreur éventuel

4. Paramétrage des locataires

4.1 Nouveaux paramètres

Au niveau de la fiche Locataire, ajouter les paramètres suivants :

Envoi automatique des avis d’échéance
Envoi automatique des quittances
Envoi automatique du suivi des charges locatives (usage futur)

Ces paramètres conditionnent l’exécution ou non des workflows de communication.

5. Intégration avec les workflows existants

5.1 Workflow — Avis d’échéance

Déclencheur

Événement : création d’une échéance

Logique fonctionnelle

Vérifier que l’avis d’échéance PDF a été généré et stocké en GED
Vérifier que le locataire a activé l’envoi automatique des échéances
Créer une Communication de type AVIS_ECHEANCE
Envoyer la communication par email avec le PDF en pièce jointe
Mettre à jour le statut (SENT / FAILED)

5.2 Workflow — Quittance

Déclencheur

Événement : quittance générée

Logique fonctionnelle

Vérifier que la quittance PDF est disponible en GED
Vérifier que le locataire a activé l’envoi automatique des quittances
Créer une Communication de type QUITTANCE
Envoyer la communication par email avec la quittance en pièce jointe
Mettre à jour le statut (SENT / FAILED)

6. Règles de gestion

Une communication n’est envoyée que si :
- Le document PDF existe
- Le locataire a un email valide
- Le paramètre d’envoi automatique est activé
Les erreurs d’envoi ne bloquent pas le workflow métier principal
Chaque tentative d’envoi est tracée

7. Évolutivité

Le module doit permettre à terme :

Ajout de nouveaux types de communication
Ajout de nouveaux canaux (SMS, portail, courrier)
Relances automatiques
Communication vers le comptable

8. Impacts transverses

Les workflows existants doivent être complétés pour déclencher des communications
L’agent backend devra tenir compte de ce module lors de futures implémentations
impliquant des documents ou des événements métier.

9. Cas d’usage initiaux

Cas 1 — Envoi d’un avis d’échéance

Une échéance est créée → le locataire reçoit automatiquement l’avis d’échéance par email.

Cas 2 — Envoi d’une quittance

Un paiement couvre une échéance → une quittance est générée → le locataire reçoit la quittance par email.

# Spécification fonctionnelle — Module de Communication ## 1. Objectif Mettre en place un **module de communication transverse** permettant l’envoi automatique de documents (avis d’échéance, quittances, justificatifs futurs) aux locataires, déclenché par des **événements métier** et orchestré via les **workflows existants**. Ce module doit être générique, traçable, et évolutif (nouveaux canaux, nouveaux types de documents). --- ## 2. Périmètre fonctionnel ### Inclus - Création d’un module **Communication** - Paramétrage des préférences de communication au niveau du **locataire** - Intégration avec les workflows existants : - Création d’échéance → avis d’échéance - Paiement complet → quittance - Traçabilité des communications (succès / échec) ### Exclu (pour l’instant) - Relances automatiques d’impayés - Communication bailleur - Portail de consultation des communications - Multicanal avancé (SMS, courrier) --- ## 3. Concepts fonctionnels ### 3.1 Communication Une **Communication** représente l’intention et l’exécution d’un envoi vers un destinataire. Attributs fonctionnels : - Type de communication (AVIS_ECHEANCE, QUITTANCE, etc.) - Canal (EMAIL uniquement dans un premier temps) - Destinataire (locataire) - Statut : - PENDING - SENT - FAILED - Documents associés (références GED) - Date de création - Date d’envoi - Message d’erreur éventuel --- ## 4. Paramétrage des locataires ### 4.1 Nouveaux paramètres Au niveau de la fiche **Locataire**, ajouter les paramètres suivants : - Envoi automatique des avis d’échéance - Envoi automatique des quittances - Envoi automatique du suivi des charges locatives (usage futur) Ces paramètres conditionnent l’exécution ou non des workflows de communication. --- ## 5. Intégration avec les workflows existants ### 5.1 Workflow — Avis d’échéance **Déclencheur** - Événement : création d’une échéance **Logique fonctionnelle** 1. Vérifier que l’avis d’échéance PDF a été généré et stocké en GED 2. Vérifier que le locataire a activé l’envoi automatique des échéances 3. Créer une Communication de type AVIS_ECHEANCE 4. Envoyer la communication par email avec le PDF en pièce jointe 5. Mettre à jour le statut (SENT / FAILED) --- ### 5.2 Workflow — Quittance **Déclencheur** - Événement : quittance générée **Logique fonctionnelle** 1. Vérifier que la quittance PDF est disponible en GED 2. Vérifier que le locataire a activé l’envoi automatique des quittances 3. Créer une Communication de type QUITTANCE 4. Envoyer la communication par email avec la quittance en pièce jointe 5. Mettre à jour le statut (SENT / FAILED) --- ## 6. Règles de gestion - Une communication n’est envoyée que si : - Le document PDF existe - Le locataire a un email valide - Le paramètre d’envoi automatique est activé - Les erreurs d’envoi ne bloquent pas le workflow métier principal - Chaque tentative d’envoi est tracée --- ## 7. Évolutivité Le module doit permettre à terme : - Ajout de nouveaux types de communication - Ajout de nouveaux canaux (SMS, portail, courrier) - Relances automatiques - Communication vers le comptable --- ## 8. Impacts transverses - Les workflows existants doivent être complétés pour déclencher des communications - L’agent backend devra tenir compte de ce module lors de futures implémentations impliquant des documents ou des événements métier. --- ## 9. Cas d’usage initiaux ### Cas 1 — Envoi d’un avis d’échéance Une échéance est créée → le locataire reçoit automatiquement l’avis d’échéance par email. ### Cas 2 — Envoi d’une quittance Un paiement couvre une échéance → une quittance est générée → le locataire reçoit la quittance par email.

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: ronan.quintin/Keryloo#25

No description provided.

Rows
Columns