Formulaires de documents

Les formulaires de documents transforment la création et la modification de documents en une expérience guidée et structurée. Au lieu d’un simple éditeur de texte enrichi ou d’un aperçu de fichier, les auteurs voient une disposition composée de sections et de champs adaptés au type de document — métadonnées, propriétés configurables, résumés des risques, documents liés, etc.

Objectif

Les formulaires de documents existent pour visualiser et collecter les propriétés des documents de manière structurée.

Ils sont utiles lorsque :

• Les documents nécessitent des métadonnées cohérentes (propriétaire, classification, date de révision, ressources liées, etc.)
• Les documents liés aux risques doivent visualiser d’un coup d’œil les risques initiaux, actuels et cibles
• Les documents associés doivent être visibles et modifiables directement dans le formulaire sans le quitter
• Les auteurs doivent suivre une structure prédéfinie plutôt qu’une page vierge

Un formulaire de document ne remplace pas les types de documents ni les propriétés de documents. Il s’agit simplement d’une vue de présentation différente qu’un type de document peut choisir d’utiliser. Les données sous-jacentes restent stockées dans les propriétés du document, les éléments liés, les évaluations de risques, etc.

Remarque : Les formulaires de documents sont différents des formulaires de demande. Les formulaires de demande sont des workflows de soumission publics ou internes qui déclenchent des processus. Les formulaires de documents sont des mises en page destinées à l’affichage et à la modification des documents d’un type donné.

Comment les éléments s’articulent

Composants clés

Un formulaire de document est constitué de sections redimensionnables contenant des champs. Les champs appartiennent à trois catégories.

1. Propriétés de document configurables

Il s’agit de propriétés de document définies dans l’espace de travail qui peuvent être placées dans le formulaire. Chaque propriété possède un type de réponse qui détermine son affichage dans l’interface :

Les propriétés prennent en charge :

• Titre et description/libellé (texte d’aide)
• Traductions multilingues du titre et du libellé (lorsque les traductions sont activées)
• Indicateur obligatoire (appliqué conjointement à la configuration du type de document)

2. Widgets

Les widgets affichent des données documentaires enrichies ou des éditeurs spécialisés :

Propriétés des widgets de documents liés

Les widgets de documents liés peuvent être configurés pour chaque champ :

• Type de document à afficher — définit le type de document lié affiché (le widget groupé affiche tous les types de documents liés)
• Afficher/modifier les propriétés du document — choisissez quelles propriétés du type de document lié apparaissent en ligne et si elles sont en lecture seule ou modifiables. Seules les propriétés affectées au type de document lié (obligatoires ou facultatives) sont disponibles.
• Afficher les métadonnées — affichage facultatif de la date de création, de la date de modification, du statut du processus et des risques initial, actuel et cible sur les éléments liés.

3. Métadonnées du document

Métadonnées du document en lecture seule ou modifiables :

Sections et mise en page

Les formulaires de documents utilisent une grille GridStack à 12 colonnes. Chaque formulaire est composé d’une ou plusieurs sections, chacune disposant de :

• Position et taille — coordonnées de grille x, y, w, h
• Titre — intitulé affiché aux utilisateurs
• Champs — liste ordonnée de métadonnées, propriétés et widgets

Dans l’éditeur de formulaire, les sections peuvent être :

• Ajoutées et supprimées
• Déplacées et redimensionnées sur la grille
• Dotées de titres traduits (voir ci-dessous)

Lors de la consultation ou de la modification d’un document, les sections sont affichées sous forme de cartes repliables. La grille s’adapte automatiquement au contenu.

Traductions personnalisées

La prise en charge multilingue est disponible à deux niveaux.

Titres de sections

Dans l’éditeur de formulaire, chaque titre de section peut activer les traductions. Lorsqu’elles sont activées, un titre peut être défini pour chaque langue activée dans l’espace de travail. Les traductions sont stockées sous forme de title_translated (une structure indexée par langue). À l’exécution, l’interface choisit le titre correspondant à la langue active de l’utilisateur, avec repli vers l’anglais puis vers le titre principal.

Libellés des propriétés de document

Les propriétés de document peuvent activer les traductions pour :

• Titre — libellé du champ dans le formulaire
• Libellé/description — texte d’aide affiché à côté du champ

Les traductions des propriétés sont configurées dans Paramètres de l’espace de travail → Propriétés de document, et non dans l’éditeur de formulaire. Le formulaire référence la définition de propriété ; les libellés traduits sont résolus lors de l’affichage selon la langue de l’utilisateur.

Configuration des formulaires de documents (éditeur de formulaires)

Les formulaires de documents sont gérés dans Paramètres de l’espace de travail → Formulaire de document.

Création ou modification d’un formulaire

1. Définir un titre — nom affiché lors de l’affectation du formulaire aux types de documents.
2. Ajouter des sections — les nouveaux formulaires commencent avec deux sections vides ; d’autres peuvent être ajoutées.
3. Concevoir la mise en page dans le concepteur de formulaires :

• Palette de gauche — liste consultable des composants disponibles (Métadonnées, Propriété, Widget)
• Zone de travail de droite — sections GridStack dans lesquelles les composants sont déposés

4. Déposer des composants depuis la palette dans une section, ou réorganiser les champs par glisser-déposer entre les sections.
5. Configurer les champs si nécessaire :

• Texte d’aide — modifier le contenu du texte d’aide
• Documents liés (spécifiques) — choisir le type de document ; configurer la visibilité des propriétés/métadonnées en ligne
• Documents liés (groupés) — configurer la visibilité des métadonnées

6. Modifier les titres de section — cliquer sur le crayon d’une section ; activer éventuellement les traductions par langue.
7. Enregistrer — la mise en page est sauvegardée.

Règles de la palette

• La plupart des composants ne peuvent apparaître qu’une seule fois par formulaire (et sont donc masqués de la palette lorsqu’ils sont déjà utilisés).
• Ligne horizontale et Documents liés (spécifiques) peuvent être ajoutés plusieurs fois (par exemple pour différents types de documents).
• Les propriétés de document définies dans l’espace de travail apparaissent dans la palette sous le type Propriété. Toutes les propriétés de l’espace de travail sont disponibles ; vous choisissez celles à inclure dans chaque formulaire.

Propriétés de document configurables

Les propriétés de document sont définies séparément dans Paramètres de l’espace de travail → Propriétés de document. Elles constituent les éléments de base que les formulaires peuvent afficher.

Définition d’une propriété

Lors de l’ajout ou de la modification d’une propriété, les paramètres suivants sont configurés :

Particularités selon le type de réponse

• Texte (1) — valeur de texte par défaut facultative
• Sélection unique (2) / Sélection multiple (3) — liste d’options
• Sélecteur de liens (4) — un ou plusieurs types de documents pouvant être liés (par ex. Employé, Produit, Contrôle)
• Date (5) — champ de date

Comme les formulaires, les propriétés peuvent être personnalisées pour l’espace de travail ou provenir des modèles Brainframe (importables dans l’espace de travail).

Relation avec les formulaires de documents

1. Créer les propriétés dans les paramètres des propriétés de document.
2. Faire glisser les propriétés depuis la palette de l’éditeur vers les sections du formulaire.
3. À l’exécution, le formulaire affiche chaque propriété avec le contrôle approprié et lit/écrit dans le conteneur de propriétés du document.

Une propriété n’a pas besoin d’être présente dans un formulaire pour exister sur un type de document — voir la configuration des types de documents ci-dessous. Inversement, placer une propriété dans un formulaire ne la rend pas obligatoire ; cela est contrôlé par le type de document.

Configuration sur les types de documents

Les formulaires de documents sont attribués par type de document dans Paramètres de l’espace de travail → Types de documents.

Vue Document vs Vue Formulaire

Chaque type de document possède un paramètre Vue :

Lorsque Vue formulaire est sélectionnée :

1. Choisir Sélectionner une vue — sélectionner le formulaire de document à utiliser (obligatoire).
2. Enregistrer le type de document.

Les documents de ce type chargent alors la mise en page depuis auth/getDocumentForm (mise en cache à l’échelle de l’espace de travail). Si un document contient déjà des données intégrées dans documentFormData, cet instantané peut être utilisé directement.

Propriétés de document obligatoires et facultatives

Dans la même fenêtre de configuration du type de document, indépendamment de l’affectation du formulaire :

• Propriétés de document obligatoires — doivent être renseignées ; leur validation est appliquée lors de la création ou de la modification de documents de ce type
• Propriétés de document facultatives — disponibles mais non obligatoires

Ces listes :

• Déterminent quelles propriétés font partie du modèle de données du type de document
• Alimentent la validation et l’initialisation des propriétés par défaut
• Limitent quelles propriétés peuvent être affichées en ligne dans les widgets de documents liés pour ce type

Distinction importante :

Une propriété obligatoire devrait généralement apparaître dans le formulaire afin que les auteurs puissent la renseigner. Une propriété facultative peut être absente du formulaire tout en existant sur le document (par exemple pour être renseignée plus tard ou utilisée uniquement pour la recherche/le filtrage).

Résumé

Ensemble, ces éléments permettent aux administrateurs de définir quelles données les documents contiennent (propriétés + règles du type de document) et comment les auteurs interagissent avec ces données (mise en page du formulaire), sans modifier le modèle documentaire sous-jacent de Brainframe.

Mis à jour le : 09/06/2026