ronan.quintin/Keryloo

Fork 0

Gestion des documents en interne #10

New issue

Closed

opened 2025-12-21 14:30:30 +01:00 by ronan.quintin · 0 comments

ronan.quintin commented

2025-12-21 14:30:30 +01:00

Owner

Besoin

Actuellement les doc générés par Keryloo (juste les quittances) sont générés à la volées. Or on va être amener à générer égalements les échéances, mais aussi stocker des documents tel que les pdf de charge de copro, différents justificatifs etc;.. Il faudrait donc mettre en place un service technique de Ged transverse qui permet de stocker des documents, avec eventuellement différentes version de document avec des version obsolettes etc...

📁 Spécification Fonctionnelle – Service GED Transverse

1. Objectif

Mettre en place un service de Gestion Électronique de Documents (GED) transverse permettant de :

stocker des documents numériques
gérer leurs versions
associer des métadonnées génériques
référencer des entités externes
exposer les documents aux autres blocs applicatifs

Ce service est indépendant de tout domaine métier (quittances, échéances, charges, etc.).

2. Périmètre

Inclus

Stockage de fichiers
Gestion des versions
Métadonnées génériques
Références externes
Cycle de vie technique des documents
API d’accès aux documents

Exclu

Génération de documents
Workflows métiers
Logique comptable ou locative
Règles fonctionnelles
Envoi d’emails
Validation métier

3. Principes Fondateurs

La GED est aveugle au métier
Aucune dépendance vers les domaines fonctionnels
Les documents sont des artefacts techniques
Les métadonnées sont non interprétées
Les références externes sont opaques

4. Concepts Fonctionnels

4.1 Document

Un document représente un fichier stocké dans la GED.

Attributs principaux

Champ	Description
id	Identifiant unique
type	Type libre du document (string)
filename	Nom original du fichier
mimeType	Type MIME
size	Taille du fichier
checksum	Empreinte de contrôle
status	ACTIVE / OBSOLETE / ARCHIVED
createdAt	Date de création
createdBy	Identifiant utilisateur

4.2 Version de document

Un document peut comporter plusieurs versions.

Attributs

Champ	Description
versionNumber	Numéro de version
storagePath	Emplacement physique
checksum	Empreinte du fichier
createdAt	Date de création
isLatest	Indique la version courante

4.3 Métadonnées

Les métadonnées sont des paires clé / valeur associées à un document.

Caractéristiques

clés libres
valeurs typées simples (string, number, date)
non interprétées par la GED
indexables

Exemples :

period = "2025-01"
source = "generated"
owner = "system"

4.4 Référence externe

Permet de lier un document à une entité extérieure sans dépendance directe.

Structure

Champ	Description
system	Nom du système externe
entityType	Type d’entité externe
entityId	Identifiant externe

⚠️ La GED ne connaît pas la sémantique de ces champs.

5. Cycle de Vie Technique

Statut	Description
ACTIVE	Document utilisable
OBSOLETE	Version remplacée
ARCHIVED	Conservé, non modifiable

6. Fonctionnalités Attendues

6.1 Création de document

Upload d’un fichier
Affectation d’un type
Ajout de métadonnées
Ajout éventuel de références externes

6.2 Gestion des versions

Ajout d’une nouvelle version à un document existant
Marquage automatique de l’ancienne version comme OBSOLETE
Accès à l’historique des versions

6.3 Consultation

Récupération des métadonnées
Téléchargement d’une version spécifique
Téléchargement de la dernière version

6.4 Recherche

Critères possibles :

type
statut
métadonnées
référence externe
date de création

6.5 Archivage

Passage manuel d’un document en statut ARCHIVED
Interdiction de modification après archivage

7. Sécurité & Accès

Contrôle d’accès par document
Droits définis par rôle
Vérification systématique à l’accès et au téléchargement

Les règles métiers d’autorisation sont hors périmètre GED.

8. Stockage

Le système doit permettre un stockage interchangeable :

Système de fichiers local
Stockage objet (S3 / équivalent)
NAS

Le choix du backend est technique et configurable.

9. API (Vue Fonctionnelle)

Opérations principales

createDocument
addDocumentVersion
getDocument
listDocuments
downloadDocument
archiveDocument

10. Contraintes Non Fonctionnelles

Scalabilité
Traçabilité
Intégrité des fichiers
Performance en lecture
Séparation stricte GED / Métier

11. Évolutions Futures (hors périmètre)

Signature électronique
OCR / indexation plein texte
Rétention légale
Workflow documentaire

12. Conclusion

Ce service GED constitue une brique technique transverse, destinée à être utilisée par différents domaines fonctionnels, sans dépendance ni connaissance métier.

Toute logique métier devra être implémentée en dehors de ce service.

# Besoin Actuellement les doc générés par Keryloo (juste les quittances) sont générés à la volées. Or on va être amener à générer égalements les échéances, mais aussi stocker des documents tel que les pdf de charge de copro, différents justificatifs etc;.. Il faudrait donc mettre en place un service technique de Ged transverse qui permet de stocker des documents, avec eventuellement différentes version de document avec des version obsolettes etc... # 📁 Spécification Fonctionnelle – Service GED Transverse ## 1. Objectif Mettre en place un **service de Gestion Électronique de Documents (GED)** transverse permettant de : - stocker des documents numériques - gérer leurs versions - associer des métadonnées génériques - référencer des entités externes - exposer les documents aux autres blocs applicatifs Ce service est **indépendant de tout domaine métier** (quittances, échéances, charges, etc.). --- ## 2. Périmètre ### Inclus - Stockage de fichiers - Gestion des versions - Métadonnées génériques - Références externes - Cycle de vie technique des documents - API d’accès aux documents ### Exclu - Génération de documents - Workflows métiers - Logique comptable ou locative - Règles fonctionnelles - Envoi d’emails - Validation métier --- ## 3. Principes Fondateurs 1. **La GED est aveugle au métier** 2. **Aucune dépendance vers les domaines fonctionnels** 3. **Les documents sont des artefacts techniques** 4. **Les métadonnées sont non interprétées** 5. **Les références externes sont opaques** --- ## 4. Concepts Fonctionnels ### 4.1 Document Un document représente un fichier stocké dans la GED. #### Attributs principaux | Champ | Description | |----|----| id | Identifiant unique | type | Type libre du document (string) | filename | Nom original du fichier | mimeType | Type MIME | size | Taille du fichier | checksum | Empreinte de contrôle | status | ACTIVE / OBSOLETE / ARCHIVED | createdAt | Date de création | createdBy | Identifiant utilisateur | --- ### 4.2 Version de document Un document peut comporter plusieurs versions. #### Attributs | Champ | Description | |----|----| versionNumber | Numéro de version | storagePath | Emplacement physique | checksum | Empreinte du fichier | createdAt | Date de création | isLatest | Indique la version courante | --- ### 4.3 Métadonnées Les métadonnées sont des **paires clé / valeur** associées à un document. #### Caractéristiques - clés libres - valeurs typées simples (string, number, date) - non interprétées par la GED - indexables Exemples : - `period = "2025-01"` - `source = "generated"` - `owner = "system"` --- ### 4.4 Référence externe Permet de lier un document à une entité extérieure sans dépendance directe. #### Structure | Champ | Description | |----|----| system | Nom du système externe | entityType | Type d’entité externe | entityId | Identifiant externe | > ⚠️ La GED ne connaît pas la sémantique de ces champs. --- ## 5. Cycle de Vie Technique | Statut | Description | |----|----| ACTIVE | Document utilisable | OBSOLETE | Version remplacée | ARCHIVED | Conservé, non modifiable | --- ## 6. Fonctionnalités Attendues ### 6.1 Création de document - Upload d’un fichier - Affectation d’un type - Ajout de métadonnées - Ajout éventuel de références externes --- ### 6.2 Gestion des versions - Ajout d’une nouvelle version à un document existant - Marquage automatique de l’ancienne version comme OBSOLETE - Accès à l’historique des versions --- ### 6.3 Consultation - Récupération des métadonnées - Téléchargement d’une version spécifique - Téléchargement de la dernière version --- ### 6.4 Recherche Critères possibles : - type - statut - métadonnées - référence externe - date de création --- ### 6.5 Archivage - Passage manuel d’un document en statut ARCHIVED - Interdiction de modification après archivage --- ## 7. Sécurité & Accès - Contrôle d’accès par document - Droits définis par rôle - Vérification systématique à l’accès et au téléchargement > Les règles métiers d’autorisation sont hors périmètre GED. --- ## 8. Stockage Le système doit permettre un stockage interchangeable : - Système de fichiers local - Stockage objet (S3 / équivalent) - NAS Le choix du backend est technique et configurable. --- ## 9. API (Vue Fonctionnelle) ### Opérations principales - `createDocument` - `addDocumentVersion` - `getDocument` - `listDocuments` - `downloadDocument` - `archiveDocument` --- ## 10. Contraintes Non Fonctionnelles - Scalabilité - Traçabilité - Intégrité des fichiers - Performance en lecture - Séparation stricte GED / Métier --- ## 11. Évolutions Futures (hors périmètre) - Signature électronique - OCR / indexation plein texte - Rétention légale - Workflow documentaire --- ## 12. Conclusion Ce service GED constitue une **brique technique transverse**, destinée à être utilisée par différents domaines fonctionnels, sans dépendance ni connaissance métier. Toute logique métier devra être implémentée **en dehors** de ce service.