Chapitre 1 Présentation

1.1 Dynacase Platform

Dynacase est une plate-forme de développement d'applications métier dont l'objectif principal est de fournir un cadre facilitant et accélérant les développements.

Elle s'articule autour des composants suivants :

• un concept de document permettant à la fois la persistance des données et la génération de formulaire;
• des workflows permettant de faire évoluer les documents, d'automatiser l'application de règles métiers;
• un système de gestion de sécurité et des utilisateurs permettant d'indiquer finement les permissions;
• un système de modules permettant d'étendre les fonctionnalités de base.

Ces composants sont proposés et mis en oeuvre par le module principal Dynacase Core.

1.2 Manuel de référence de Dynacase Core

Ce manuel est destiné à des développeurs devant créer une application en utilisant Dynacase comme socle applicatif. Il a pour but de présenter une documentation précise et exhaustive de l'ensemble des fonctionnalités de la plate-forme maintenue par Anakeen.

Il propose au travers de sa structure une approche logique des concepts et techniques de développement.

Les premiers chapitres présentent les objets et mécanismes Dynacase. Leur compréhension est importante car ils introduisent des concepts qui sont utilisés dans la suite du manuel. Les suivants détaillent des fonctionnements de Dynacase Core, pour arriver au détail de l'API de programmation et aux techniques avancées.

Bon développement...

1.3 État de la documentation

Nous marquons les chapitres pour informer le lecteur sur les modifications fonctionnelles.

Note : Si un chapitre est 'marqué', son contenu, incluant ses sous-chapitres, est considéré comme marqué à l'identique -sauf marquage particulier-.

1.4 Historique de la documentation

Ce chapitre contient un descriptif des améliorations entre les releases de Dynacase.

1.4.1 Édition 13

1.4.2 Édition 12

1.4.3 Édition 11

1.4.4 Édition 10

1.4.5 Édition 9

1.4.6 Édition 8

1.4.7 Édition 7

1.4.8 Édition 6

1.4.9 Édition 5

1.4.10 Édition 4

L'édition 4 de la documentation a modifié les points suivants.

1.4.11 Modification release 3.2.12

1.4.11.1 Internationalisation

Ajout de la possibilité d'utiliser les contextes et les formes plurielles dans les traductions.

1.4.11.2 SearchDoc::addGeneralFilter

La méthode SearchDoc::addGeneralFilter() retourne systématiquement une exception en cas d'erreur.

1.4.11.3 SearchDoc::join

La méthode SearchDoc::join() retourne une exception en cas d'erreur.

1.4.11.4 SearchDoc::onlyCount

La méthode SearchDoc::onlyCount() effectue systématiquement un appel à la base de donnée pour récupérer le résultat.

1.4.11.5 SearchDoc::setRecursiveSearch

La méthode SearchDoc::setRecursiveSearch() a un nouveau paramètre pour indiquer le niveau de profondeur. Ceci évite de mettre à jour directement la propriété SearchDoc::folderRecursiveLevel.

1.4.11.6 Importation CSV

Le script importDocument a de nouvelles options permettant de configurer l'importation des formats csv.

L'interface d'administration d'importation des documents permet aussi de configurer les options d'importation pour les fichiers csv.

1.4.11.7 Layout::eSet, Layout::eSetBlockData

Les méthodes Layout::eSet() et Layout::eSetBlockData() ont été ajoutées afin de faciliter l'ajout de clefs correctement encodées dans des fichiers XML et HTML.

1.4.11.8 Dir::insertMultipleDocuments

La méthode Dir::insertMultipleDocuments a été modifiée afin de faire remonter le message d'erreur de la méthode hameçon Dir::postInsertMultipleDocuments dans son retour d'erreur.

Chapitre 2 Introduction à Dynacase

Ce chapitre présente l'ensemble des notions de base composant Dynacase de manière succincte. Il permet a un nouvel utilisateur de faire un rapide tour de présentation de la plate-forme.

2.1 Famille et document et attributs

2.1.1 Résumé

Un élément central de Dynacase est le modèle documentaire. Celui-ci peut-être décrit par les concepts suivants :

La famille

Celle-ci correspond à une structure type permettant de stocker et de représenter des données (par exemple le type compte-rendu de réunion, composé d'un titre, d'une liste de participants, d'une description, etc.). Si on fait une analogie avec le paradigme objet, elle correspond à la classe.

Le document

Il correspond à un élément d'une famille (par exemple : un document de la famille compte-rendu contenant le compte rendu de la réunion marketing du 12 mai 2012 ayant pour invité Mickaël, Jean et Paul). Si on fait une analogie avec le paradigme objet, il correspond à un objet étant une instance de sa famille de référence.

Les collections

Les collections sont des documents regroupant des documents. Il en existe plusieurs types :

Dossier

Un dossier permet à un utilisateur ou à des règles métier d'ajouter et d'enlever des documents à la collection qu'il représente.

Recherche

Une recherche est une collection qui est définie par des critères de recherches. Le contenu de cette collection est donc re-calculé à chaque consultation. Par exemple, la recherche Les documents dont je suis rédacteur sera exprimée sous la forme d'une recherche permettant de trouver l'ensemble des documents où l'utilisateur en cours est cité comme rédacteur.

2.1.2 La famille

Une famille est un élément permettant de décrire la structure et le comportement de documents.

Figure 1. Schéma théorique de famille

Le schéma ci-dessus indique qu'une famille Dynacase est constituée des éléments suivants :

Des propriétés

Elles définissent le comportement de la famille et des méta-données qui lui sont associées.

Une structure

Elle définit l'organisation et le type des données contenues par les documents de la famille.
Elle est composée de deux types d'éléments :

Les attributs

Ils sont de différent types (texte, date, énuméré, lien entre documents, etc.) et définissent le contenu de chaque document.
Par exemple, un compte-rendu de réunion est composé d' un titre de type texte, d'une date de réunion de type date, des annexes de type fichier,

Les paramètres

Ils définissent des éléments de même valeur pour tous les documents d'une même famille.
Par exemple, les compte-rendus ont comme préfixe pour leur titre : "CR_".

Des représentations

Elles permettent de modifier la mise en forme d'un document, cela peut se matérialiser de différentes manières :

• une mise en page simplifiée pour un certain type d'utilisateur (html par exemple);
• une représentation sous la forme de données brutes pour de la communication entre systèmes (xml par exemple);
• une représentation sous la forme d'un fichier bureautique ou PDF;
• etc.

Des contrôles de vues

Ces éléments permettent d'indiquer à quel type d'utilisateur correspond quelle(s) représentation(s). Par exemple, un manager peut voir plus d'éléments sur un compte-rendu qu'un simple participant.

Des règles métiers

Elles sont l'ensemble des règles s'appliquant à un type de document. Elles peuvent être de type très divers (ajout d'une règle de calcul de numéro chrono, ajout de contraintes particulières sur la mise en forme des données, calcul automatique d'une valeur, aide aux utilisateurs pour la saisie des valeurs).
Elles se déclarent de deux manières :

• via une classe associée à la famille : celle-ci permet de surcharger les comportements par défaut de Dynacase lors des étapes de la vie du document (création, sauvegarde, édition, etc.);
• via un fichier PHP : celui-ci liste des méthodes permettant de guider la saisie des utilisateurs (par exemple rechercher uniquement les salles disponibles).

2.1.2.1 Familles système et fonctionnelle

On distingue deux types de familles.

Famille fonctionnelle

Une famille fonctionnelle a un sens fonctionnellement et elle porte les documents des utilisateurs (une famille de compte rendu, de gestion de contrat, etc.).

Famille système

Une famille système permet de créer des documents utilisés par le paramétrage de Dynacase, dont le contenu est recherchable uniquement pour les administrateurs. C'est le cas pour les familles suivantes :

• contrôle de vue : ce document permet de définir la représentation d'un document;
• modèle de mail : qui permet de définir un modèle d'envoi par mail pour un type de document;
• etc.

Ces documents n'ayant pas de sens particulier pour les utilisateurs non administrateurs, ils ne sont pas accessibles via les recherches par défaut pour ne pas les surcharger avec des informations non pertinentes.

NB : il est possible dans le cadre d'un développement Dynacase de définir ses propres familles systèmes et fonctionnelles

2.1.3 Le document

Un document est un objet de Dynacase. Il contient de l'information structurée et est persistant. Il est principalement présenté aux utilisateurs sous la forme de formulaires web à compléter ou de pages web.
Si on s'appuie sur une analogie avec le paradigme objet, il est un objet.

Le document est une instance d'une famille. En reprenant l'exemple des compte-rendus un document de la famille compte-rendu est donc le compte-rendu du 12 mai 2012 se référant à une réunion précise.

Il contient les éléments suivants :

Des propriétés

La date de création, la date de dernière modification, le créateur, le profilage associé…

Des données

L'ensemble des données contenues par le document.

L'historique

L'historique des actions ayant eu lieu autour du document (historique des modifications, des envoi de mail, etc.).

2.1.4 Les types d'attributs

Un type d'attribut est un type de données. Il est utilisé dans les familles pour définir leur structure et dans les documents pour représenter, traiter et sauvegarder les données associées au document.

Il existe trois catégories d'attributs :

Structurant

Ces attributs permettent d'organiser les familles. Il en existe deux catégories :

Onglet

Il permet de regrouper des attributs de type frame.
Il est représenté par un onglet dans les formulaires.

Cadre

Il permet de regrouper des attributs non-structurants.
Il est représenté par un cadre dans les formulaires.

Ces attributs permettent de définir des ensembles sémantiques. Par exemple, dans le compte-rendu, le cadre Description regroupe le titre, la date et le lieu de la réunion.

Donnée

Ces attributs permettent de structurer les données récoltées au sein d'un formulaire. Ils permettent d'indiquer qu'une famille est composée d'un champ texte, d'un champ date, etc. Leur présence permet à la plate-forme de générer à la fois les formulaires et la structure en base de données permettant de stocker les documents.

Tableau

Ce type d'attribut permet de créer une représentation tabulaire d'un ensemble d'attributs Donnée. Ceux-ci deviennent alors les colonnes d'un tableau pouvant avoir plusieurs lignes.

2.1.5 Les attributs

Un attribut correspond à un champ de données dans la définition d'une famille. L'ensemble des attributs définissent le contenu du document. Lors de la définition d'un attribut au sein d'une famille, on lui adjoint des caractéristiques parmi les suivantes :

Type d'attribut

Il permet d'indiquer de quel type est l'attribut (texte, date, numérique, etc.).

Visibilité

Elle définit la manière dont l'utilisateur pourra interagir avec l'attribut, qui peut être soit éditable, en lecture seule, etc. Cet élément peut-être surchargé via les mécanismes des masques / contrôles de vues pour présenter une visibilité de manière dynamique (suivant l'état du document, ou la personne le consultant par exemple).

Label

Il est affiché à côté de l'attribut dans les représentations des documents. Cet élément peut être traduit.

Méthode de calcul (facultatif)

Un attribut ayant une méthode de calcul est dit calculé. Sa valeur est automatiquement calculée par Dynacase à chaque sauvegarde du document. Elle se présente sous la forme d'une méthode PHP renvoyant la nouvelle valeur.

Aide à la saisie (facultatif)

Un attribut possédant une aide à la saisie suggère des valeurs possibles aux utilisateurs lors de sa valorisation. L'aide à la saisie se présente sous la forme d'une fonction PHP renvoyant la liste des valeurs possibles.

Contrainte (facultatif)

Elle permet de valider l'information avant sa sauvegarde. Celle-ci se présente sous la forme d'une méthode PHP renvoyant un statut et, en cas de non respect de la contrainte, un message permettant de guider l'utilisateur dans le choix de la valeur.

Vue particulière (facultatif)

Si cette propriété est présente la représentation de l'attribut peut-être totalement ou partiellement surchargée (présentation d'un graphique dans le formulaire par exemple).

Options (facultatif)

Des options peuvent être adjointes à l'attribut pour modifier son comportement. Celles-ci sont propres à chaque type d'attribut et permettent d'en modifier soit le comportement soit l'affichage.

2.1.6 Famille système

Une famille système permet de créer des documents utilisés par le paramétrage de Dynacase, dont le contenu est recherchable uniquement pour les administrateurs. C'est le cas pour les familles suivantes :

• contrôle de vue : ce document permet de définir la représentation d'un document;
• modèle de mail : qui permet de définir un modèle d'envoi par mail pour un type de document;
• etc.

Ces documents n'ayant pas de sens particulier pour les utilisateurs non administrateurs, ils ne sont pas accessibles via les recherches par défaut pour ne pas surcharger celles-ci avec des informations non pertinentes.

NB : il est possible dans le cadre d'un développement Dynacase de définir ses propres familles systèmes

2.1.7 Collection

Une collection est un document qui permet de regrouper un ensemble de documents. Elle peut-être utilisée comme base pour des recherches particulières ou comme moyen de permettre à un utilisateur de faire des requêtes. Il existe, notamment, les deux types de collections suivants :

Dossier

Un dossier permet à un utilisateur ou à des règles métier d'ajouter et d'enlever des documents à l'intérieur de ce dossier.

Recherche

Une recherche permet à un utilisateur ou un intégrateur de paramétrer des règles permettant de regrouper un ensemble de document (par exemple : l'ensemble des compte rendu de réunion entre le 01/01/2042 et 31/12/2042).

2.2 Cycle de vie

2.2.1 Résumé

Ce chapitre décrit un élément fondamental d'un projet Dynacase : le cycle de vie.

Le cycle de vie est un objet interne à Dynacase qui permet de faire évoluer un document au sein d'un processus. Lors de ce processus, différentes actions peuvent être appliquées au document :

• changement/calcul de valeurs (le numéro chrono n'est affecté qu'après la validation du document),
• changement des droits associés à un document (un document en rédaction ne peut être modifiable que par son rédacteur),
• évolution du formulaire (l'onglet validation n'apparaît que lors de l'étape validation),
• envoi de courriel (le validateur d'un document reçoit un courriel lorsque son avis est nécessaire),
• déclenchement d'un minuteur (si après 1 mois le document est toujours en validation, le valideur est relancé),
• plus généralement du code PHP peut-être déclenché (envoi à un autre élément du système d'informations de l'ordre de paiement après validation finale du document).

Les cycles de vie de Dynacase peuvent être représentés par des graphiques orientés (ceux-ci sont automatiquement générés par la plate-forme).

Figure 2. Exemple de schéma de cycle de vie

2.2.2 Composants d'un cycle de vie

Un cycle de vie est composé des éléments suivants :

Propriétés

Elles facilitent le paramétrage et l'exportation (famille associée, nom logique, etc.).

Structure

La structure est composée d'étapes et de transitions reliant les étapes. Elle constitue la base du cycle et indique comment le document peut évoluer.

Profil du cycle de vie

Un profil est associé au cycle, il permet de définir qui pourra effectuer quelle transition.

2.2.3 Étapes

Les étapes marquent un moment clef dans la vie du document. Une étape est constituée de :

État

L'état est le statut du document à un moment donné (brouillon, rédigé, validé, historique).

Activité

L'activité est la tâche en cours de réalisation sur un document donné (par exemple : en rédaction, en validation).

À une étape, on peut rattacher les éléments suivants :

Courriel (un ou plusieurs)

Ils sont alors envoyés à chaque passage dans cette étape,

Un profil

Il est alors attaché au document lors de son entrée dans l'étape et modifie la liste des comptes pouvant modifier, voir, supprimer le document en cours.

Un contrôle de vue ou/un masque

Il est alors attaché au document lors dans son entrée dans l'étape et modifie la représentation du document.

Couleur

Celle-ci est reprise dans l'IHM et permet aux utilisateurs d'avoir un moyen mémo-technique simple pour identifier rapidement les documents.

Affectation

L'affectation d'un utilisateur à une étape permet de réserver le document à cet utilisateur et d'éventuellement verrouiller le document à l'intention de cet utilisateur et de lui envoyer un courriel.

NB : On considère qu'une étape sans activité doit être terminale (c'est à dire qu'il n'existe pas de transition permettant de sortir de cette étape), car c'est uniquement durant ces étapes que le document n'évolue plus, qu'aucune activité ne s'y applique. Par exemple, un document gardé pour historique n'évolue plus et aucune activité ne s'y applique.

2.2.4 Transition

Les transitions indiquent la possibilité de passage entre une étape et une autre.

Une transition se déroule de la manière suivante :

Figure 3. Déroulement d'une transition

M0 (ou précondition)

La précondition ou M0 est une méthode PHP qui est systématiquement exécutée en début de transition, ce qui correspond aux cas suivants :

• lors de l'affichage de la liste des transitions possibles à une étape donnée,
• avant le déclenchement des ASK (voir entrée suivante),
• avant le changement d'état en lui même

Si la précondition n'est pas remplie alors elle renvoie un message qui est affiché à l'utilisateur et ne permet pas d'effectuer la transition.

ASK

Les ASK sont un ensemble d'attributs utilisés pour poser une question à l'utilisateur avant d'effectuer la transition. Ils peuvent servir à valider une valeur, demander un commentaire, etc. Les valeurs récupérées peuvent être utilisées dans les méthodes du cycle de vie lors des M1, M2, M3.

M1

Le M1 est une méthode PHP qui est appelée après les ASK et le M0 mais avant le changement d'état. On peut l'utiliser pour vérifier un ensemble d'éléments et annuler le passage d'une transition si besoin. Par exemple, on peut vérifier la présence d'un élément dans le document en cours de transition et annuler le passage de la transition si celui-ci n'est pas présent.

M2

Le M2 est une méthode PHP qui est appelée après le changement d'état. Elle est utilisée pour modifier le document une fois la transition effectuée mais avant les courriels et les minuteurs. Elle est utilisée pour modifier le contenu du document avant l'envoi des courriels.

Courriel

Il est possible d'attacher des courriels au passage d'une transition. Ceux-ci sont alors envoyés à chaque passage de cette transition, le contenu et les destinataires peuvent être composés à l'aide du contenu du document en cours de transition.

Minuteur

Il est possible d'attacher des minuteurs au passage d'une transition. Ceux-ci servent à déclencher une action de manière asynchrone (au bout d'un certain temps). Un des usages les plus typiques est la relance par mail (par exemple, si jamais le document est toujours à l'état relecture au bout de 15 jours le relecteur reçoit à nouveau un mail l'invitant à relire le document).

M3

Le M3 est une méthode PHP qui est appelée en tout dernier lors d'une transition. Elle est utilisée pour effectuer une action après le passage de la transition, l'envoi des mails et des minuteurs.

NB : M2 et M3 peuvent retourner un message, contrairement à celui de M0 et M1 il n'empêchera pas le passage de la transition mais sera présenté à l'utilisateur.

2.2.5 Cycle de vie, famille et document

Le cycle de vie se matérialise sous la forme d'un document Dynacase.

Ce document est ensuite lié à une ou plusieurs familles : tous les nouveaux documents de cette ou ces famille(s) :

• sont affectés à ce cycle de vie;
• sont automatiquement affectés à la première étape de ce cycle après leur création;
• utilisent ce cycle pour définir :
  • leur représentation,
  • leur accessibilité (qui a le droit de voir, modifier, supprimer).

NB : il est aussi possible d'affecter un cycle de vie à un document via de la programmation.

2.3 Applications, actions et ACL

2.3.1 Résumé

Toute requête effectuée sur le serveur exécute une action d'une application. L'action détermine la fonctionnalité attendue par la requête.

Vocabulaire :

Application

Une application est un conteneur permettant de regrouper des Actions, des ACL et des paramètres.

Action

Une action est une fonction PHP. Cette fonction peut utiliser l'ensemble de l'API de Dynacase et est exécutée au nom de l'utilisateur en cours (les droits, visibilités et autres sont donc respectés). Elles peuvent être utilisées pour effectuer :

• des exports particuliers (textuel ou binaire),
• des traitements particuliers (dupliquer des documents, effectuer des modifications de groupes, créations automatiques, etc.),
• des IHM spécifiques (mise en place d'un portail d'accueil, d'interface de manipulation de documents, etc.)

ACL

Une ACL est un droit applicatif, elle a deux usages complémentaires. Au niveau d'une action, elle indique que l'utilisateur doit posséder cette ACL pour pouvoir utiliser cette action et associée à un compte (rôle, utilisateur, groupe) elle indique que ce compte possède cette ACL.

2.3.2 Application

Une application est caractérisée par :

Des propriétés

Ces propriétés permettent d'identifier et de caractériser l'application. Il y a notamment :

Nom logique

C'est le nom logique de l'application, il est utilisé lors de son appel.

Nom

Ce nom est utilisé dans les interfaces d'administration, il peut-être traduit.

Description

Cette description est utilisée dans les interfaces d'administration, elle peut-être traduite.

Icône

Cette icône est utilisée dans les interfaces d'administration.

Une liste d'ACL

Cette liste est sous la forme d'un tableau PHP d'ACL. Elle est propre à chaque application

Une liste de définition d'action

Cette liste est présentée sous la forme d'un tableau PHP d'action. La liste des actions est propre à chaque application.

Des paramètres applicatifs

Les paramètres applicatifs sont présentés sous la forme d'une liste décrivant l'ensemble des paramètres applicatifs applicables pour l'application

NB : une application peut hériter d'une autre, elle hérite alors de son paramétrage et des actions et paramètres applicatifs.

2.3.3 ACL

Une ACL est un marqueur permettant d'indiquer que :

• un droit est nécessaire pour effectuer une action,
• un compte le possède et pourra donc effectuer les actions nécessitant l'ACL.

La vérification des ACL est incluse dans la plate-forme et est effectuée automatiquement lors de l'appel à une action. Si le compte utilisé pour faire l'appel ne possède pas l'ACL nécessaire un message d'erreur est alors généré.

2.3.4 Action

L'action est constituée d'une fonction PHP qui est utilisée lors de son appel.

Les principaux éléments constituant une action sont :

Un nom logique

Il est utilisé pour référencer l'action, notamment, lors de l'appel de l'action.

Le nom logique d'une ACL (facultatif)

S'il est présent la plate-forme n'exécute l'action que si le compte demandant l'exécution possède l'ACL.

Un nom de layout (facultatif)

Il permet d'indiquer avec quel layout (template utilisé par le moteur de template) l'action est rendue (par défaut, le template a le même nom que l'action). NB : si l'action n'a pas de représentation, ou renvoie un élément encodé (JSON, base64, etc.), il est possible d'indiquer à l'action de ne pas utiliser le moteur de template.

2.3.5 Paramètre applicatif

Un paramètre applicatif est un élément que l'on peut ajouter à une action pour stocker des données permettant de paramétrer l'action. Une fois le paramètre enregistré une API permet de le manipuler (récupérer, modifier sa valeur).
De plus, les paramètres applicatifs sont présentés via les interfaces d'administration de Dynacase et peuvent être modifiés par les administrateurs système. Il sont utilisés principalement dans deux cas :

• mettre en place une persistance au niveau d'une application pour l'ensemble des utilisateurs (par exemple le format du préfixe du nom de fichier que retourne une action d'export),
• mettre en place une persistance au niveau d'un utilisateur d'une application (par exemple les préférence d'export de l'utilisateur en cours).

Les principaux éléments constituant d'un paramètre applicatif sont :

Un nom logique

Il permet de manipuler le paramètre applicatif.

Une valeur par défaut

Elle est utilisée pour initier la valeur du paramètre.

Une visibilité

Elle indique si un paramètre applicatif est ou pas commun à l'ensemble des utilisateurs.

2.4 Comptes : utilisateurs, groupes et rôles

2.4.1 Résumé

La gestion des droits et de la sécurité dans Dynacase repose sur la notion de compte. Le compte est lui divisé en trois notions :

Utilisateur

Un utilisateur représente une personne (physique ou morale) ayant la capacité de se connecter à la plate-forme, il possède donc à minima un login.

Groupe

Un groupe est un ensemble d'utilisateurs et de groupes.
Les groupes peuvent s'imbriquer et dans ce cas le groupe de plus haut niveau contient l'ensemble des utilisateurs de ses groupes fils (par exemple, le groupe 1 contient le groupe 2 et le groupe 2 contient l'utilisateur 3 alors le groupe 1 contient l'utilisateur 3).

Rôle

Un rôle marque une fonction. La notion de rôle est utilisée dans le cadre du profilage, il a deux usages complémentaires :

• au niveau d'un groupe, il indique que l'ensemble des utilisateurs (directement dans le groupe ou hérités de groupes fils) possèdent ce rôle,
• au niveau d'un profil, il indique que seul les utilisateurs ayant ce rôle peuvent effectuer un certain type d'action (par exemple : uniquement les utilisateurs ayant le rôle rédacteur peuvent modifier le document).

2.4.2 Utilisateur

Les utilisateurs Dynacase possèdent les principales caractéristiques suivantes :

Nom et prénom

Ils permettent d'identifier la personne.

Login

le login est l'identifiant unique d'un utilisateur, il est notamment utilisé pour identifier l'utilisateur lors de la phase de login.

Mot de passe (optionnel)

Le mot de passe est utilisé lors de la phase de login, il est stocké sous la forme d'une empreinte cryptographique (hash) en base de données.

Adresse e-mail (optionnel)

L'adresse e-mail de l'utilisateur est utilisée lors d'un envoi de mail à un utilisateur ou à un groupe d'utilisateurs, cette adresse e-mail est alors automatiquement récupérée par la plate-forme lors de la mise en forme d'un courriel.

Date d'expiration du compte

Cette date permet d'indiquer qu'un compte ne sera plus actif passé une certaine date. Lorsque le compte est inactif, l'utilisateur ne peut plus se connecter. Le compte n'est pas supprimé et peut-être réactivé par la suite.

Il est de plus possible de désactiver un compte et de gérer les groupes via les interfaces d'administration et l'API de Dynacase.

2.4.3 Groupe

Un groupe est un ensemble d'utilisateurs ou de groupes, il permet d'effectuer les actions suivantes :

• envoi d'un mail aux membres d'un groupe,
• affectation d'un ou plusieurs rôles à l'ensemble des membres du groupe,
• affectation d'ACL à l'ensemble des membres du groupe.

Les groupes possèdent les caractéristiques suivantes :

Nom

Nom du groupe

Login

Il sert à l'identification du groupe.

Sans adresse mail de groupe

Désactive la possibilité d'envoyer un mail aux membres du groupe.

Rôle

la liste des rôles associés à ce groupe

De plus, il est possible d'ajouter/supprimer des utilisateurs/groupes d'un groupe via les interfaces d'administration et l'API de Dynacase.

2.4.4 Rôle

Un rôle est uniquement composé de son titre et d'une référence, en effet le rôle n'a de sens que associé à un groupe et à un profil.

2.5 Sécurité : authentification, droit applicatif, droit documentaire

2.5.1 Résumé

Ce chapitre aborde la notion de sécurité au sein de Dynacase. Cela comprend les éléments suivants :

Une mécanique d'authentification

Ce système permet d'identifier l'utilisateur essayant de se connecter. Il est composé d'un système de frontends et de backends d'authentification.

Frontend d'authentification

Système qui décrit la méthode (le protocole) d’interaction avec l'utilisateur pour demander les éléments nécessaires à l'authentification.

Backend d'authentification

Système qui permet de vérifier auprès d'une autorité la validité des informations d'authentification obtenues par le frontend d'authentification.

Une mécanique d'autorisation

Ce système est composé de deux couches et permet de définir ce que l'utilisateur peut ou ne peut pas faire.

La sécurité applicative

Ce système est basé sur des ACL, seuls les utilisateurs possédant l'ACL requise peuvent exécuter l'application ou l'action.

Sécurité documentaire

Un système de droit, profil et rôle permet de désigner de manière statique ou dynamique (suivant l'état ou le contenu du document) quels utilisateurs peuvent consulter, modifier, supprimer, etc. des documents.

On peut résumer les mécanismes de sécurité avec le schéma suivant :

Figure 4. Sécurité : résumé

2.5.2 Mécanisme d'authentification

Le mécanisme d'authentification de Dynacase permet d'identifier les utilisateurs via différentes sources et différents moyens.

Les frontend d'authentification fournis par défaut par Dynacase sont :

• authentification par formulaire web,
• authentification par HTTP Basic,
• authentification par jeton.

Les backends d'authentification fournis par défaut par Dynacase sont :

• authentification sur base Dynacase,
• authentification par LDAP/Active Directory (via un module complémentaire).

Il est de plus possible de créer ses propres backend et frontend d'authentification et d'en indiquer l'ordre d'exécution (par exemple, on peut choisir que l'utilisateur sera d'abord authentifié par un reverse proxy puis, si le reverse proxy n'a pas donné l'authentification, par un login sous forme de formulaire).

2.5.3 Sécurité applicative

La sécurité applicative fonctionne avec un mécanisme d'ACL. Chaque action peut-être associée à une ACL et seuls les utilisateurs possédant cette ACL peuvent exécuter cette action.

NB : une action n'ayant pas d'ACL est accessible à tout utilisateur même si celui-ci n'est pas connecté mais les droits documentaires continuent de s'appliquer (dans le cas d'un utilisateur non connecté c'est l'utilisateur anonymous guest qui est utilisé pour le calcul des droits).

2.5.4 Sécurité documentaire

La sécurité documentaire est le mécanisme permettant de définir qui peut effectuer quelle opération avec un document.

2.5.4.1 Droits par défaut

Les droits par défaut sont les suivants :

Consulter

Permet de consulter et trouver le document.

Modifier

Permet de modifier le contenu du document que ce soit via le formulaire par défaut ou via l'API appelée en son nom. Si ce droit n'est pas présent les modifications ne peuvent être enregistrées.

Supprimer

Permet de supprimer le document que ce soit via l'IHM ou via l'API.

De plus, il existe au niveau d'une famille documentaire les droits suivants:

Créer

Un utilisateur ayant ce droit sur une famille peut créer un document de cette famille en exécutant une action effectuant cette tâche.

Créer manuellement

Un utilisateur ayant ce droit peut créer un document de cette famille, en passant par l'interface de création de document par défaut.

NB : D'autres éléments internes, de plus haut niveau, de Dynacase possèdent plus de droits. Par exemple, les dossiers, recherches et rapport possèdent des droits spécialisés propres à leur fonction (droit d'effectuer la recherche, droit d'ouvrir le dossier, etc.).

2.5.4.2 Profil

Le système d'attribution des droits à des utilisateurs repose sur la notion de profil. Un profil est un document interne comportant une matrice permettant d'indiquer quel rôle, groupe ou utilisateur possède quel droit.

Figure 5. Sécurité : profil

On différencie deux usages de profil :

Statique

la liste des utilisateurs ayant droit ne varie pas suivant le contenu du document (par exemple : les utilisateurs ayant le rôle Rédacteur peuvent modifier ce document),

Dynamique

la liste des utilisateurs ayant droit varie alors suivant l'étape et/ou le contenu du document (par exemple : seul l'utilisateur cité dans l'attribut validateur de document peut le modifier lors de l'étape validation)

Il existe différents types de profils :

Document

Il concerne un document et n'indique que les droits de base (voir, modifier, supprimer).

Famille

Il concerne une définition de famille documentaire et indique les droits de base et les droits de création (via l'IHM par défaut, via le code).

Les autres types de profil

Les documents systèmes spécialisés de Dynacase possèdent des profils contenant des droits spécifiques (Dossier, Recherche, Rapport, etc.).

Une fois le profil créé, celui-ci doit être associé à un document. Pour ce faire, il existe plusieurs moyens :

Via la famille

Le profil est associé via une propriété de la définition de famille. Dans ce cas, tous les nouveaux documents de cette famille porteront ce profil.

Via le cycle de vie

Le profil est associé via le paramétrage du cycle de vie à une étape et tous les documents passant par cette étape se voient appliqué le profil.

Via le code

Le profil est attaché dynamiquement en utilisant les fonctions de l'API.

Via l'interface de gestion

Si l'utilisateur possède les droits suffisants, il lui est possible de changer le profil d'un document en cours.

NB : les moyens sont bien évidemment complémentaires et un document peut changer de nombreuses fois de profil au cours de sa vie.

2.5.4.2.1 Profil dédié

Le profil dédié est un profil qui n'est valable que pour un document. Il est défini directement au niveau du document et permet de gérer au plus près les accès à ce document.
Certain types de document système ne peuvent fonctionner qu'avec des profils dédiés, c'est notamment le cas des :

Cycle de vie

Le cycle de vie utilisant son profilage pour définir l'accessibilité des transitions, son profil est différent pour chaque cycle de vie.

Contrôle de vue

Le document de contrôle de vue utilise son profilage pour définir l'accessibilité des représentations qu'il contient, son profil est donc unique.

2.6 Internationalisation

2.6.1 Résumé

Dynacase comprend un mécanisme permettant l'internationalisation de l'application. Celui-ci permet de :

• traduire l'ensemble des labels présentés dans l'interface,
• présenter la date en fonction de la locale de l'utilisateur.

Par défaut, deux langues sont disponibles : le français et l'anglais.

2.6.2 Mécanisme de traduction

Dynacase utilise le mécanisme standard de traduction gettext et son implémentation en PHP (php-gettext) pour la gestion des traductions des messages.

Cet outil permet deux choses :

• lors du développement : la création de catalogues de traduction en extrayant les clefs directement du code PHP,
• lors de l'exécution : la récupération de la traduction d'une clef par rapport à la locale en cours (la langue choisie par l'utilisateur).

La mise en place des traductions lors du développement d'une application passe donc par les étapes suivantes :

1. Utilisation de l'API pour indiquer les éléments dont la traduction est nécessaire. Ceci se fait soit via :

   • pour le code PHP, la fonction _();
   • pour le code javascript, la fonction _() de l'api DATA;
   • pour les fichier de configuration des mots clefs spécifique au fichier.
2. Extraction des clefs du code et construction des catalogues. Cette partie est soit manuelle, soit instrumentée à l'aide des outils de build des modules Dynacase.
3. Déploiement du catalogue sur le serveur. Lors de la mise à jour du serveur applicatif, il faut fusionner les nouvelles définitions provenant du catalogue avec celles du catalogue principal.
4. Lors de l'exécution du programme. lorsque le code passe par une méthode utilisée lors de l'étape 1, il va chercher dans le catalogue principal de la plate-forme le message traduit correspondant à la clef.

2.6.3 Mécanisme de mise à jour des paramètres régionaux

L'ajout de nouveaux paramètres régionaux (format de date, d'heure, etc.) passe par la mise à jour d'un fichier de configuration sur la plate-forme.

Chapitre 3 Le modèle objet de Dynacase

3.1 Les classes standard de Dynacase Core

Dynacase repose sur le modèle objet suivant :

Ce schéma présente une version simplifiée des héritages (les relations en pointillés omettent volontairement des classes intermédiaires).

Voici une brève explication des différentes classes.

3.1.1 DbObj

La classe DbObj sert à la persistance de données.

Son fonctionnement est détaillé dans la partie correspondante des techniques avancées.

3.1.2 Doc

La classe Doc est la classe de base des documents Dynacase.

Tous les documents héritent de la classe Doc.

3.1.3 DocFam

La classe DocFam est la classe d'une famille de documents.

Ainsi, une famille de document est aussi un type de document particulier, ce qui permet de la manipuler comme tel.

3.1.4 WDoc

La classe WDoc est la classe de base des cycles de vie.

Tous les cycles de vie héritent de la classe WDoc.

3.1.5 DocCollection

La classe DocCollection est la classe de base des collections.

Une collection est un ensemble de documents.

3.1.6 Dir

La classe Dir est la classe d'un dossier.

Un dossier est une collection statique de documents, à laquelle on peut ajouter ou supprimer des documents.

3.1.7 DocSearch

La classe DocSearch est la classe de base des recherches.

Une recherche est une collection dynamique de documents, dont le contenu est calculé à chaque accès en fonction des critères de la recherche.

3.2 Les Hooks

Le document offre de nombreux hooks permettant de modifier son comportement au cours des étapes telles que la création, modification, suppression, etc. de document.

Ces hooks viennent s'ajouter aux droits de l'utilisateur. Par exemple, lors de la création d'un document, Dynacase vérifiera d'abord que l'utilisateur a bien le droit de créer un document de la famille concernée, puis vérifiera ensuite que le hook Doc::preCreated() ne bloque pas cette création.

3.2.1 Création de document

Les méthode surchargeables appelées lors de la création d'un document sont :

• Lors de la création avec Doc::store()
  • Doc::preStore()
  • Doc::preCreated()
  • Doc::customSearchValues()
  • Doc::postCreated()
  • Doc::preRefresh()
  • Doc::postRefresh()
  • Doc::postStore()
• Lors de la création avec Doc::add()
  • Doc::preCreated()
  • Doc::postCreated()

3.2.2 Modification de document

Les méthode surchargeables appelées lors de la modification d'un document sont :

• Lors de la modification avec Doc::store()
  • Doc::preStore()
  • Doc::customSearchValues()
  • Doc::preRefresh()
  • (Doc::customSearchValues() si modification)
  • Doc::postRefresh()
  • Doc::postStore()
• Lors de la modification avec Doc::modify()
  • aucune

3.2.3 Suppression de document

Les méthode surchargeables appelées lors de la suppression d'un document avec Doc::delete() sont :

• Doc::preDelete()
• Doc::postDelete()

3.2.4 Affectation de document

3.2.20 Les méthode surchargeables appelées lors de l'affectation d'un document sont

• Doc::preAffect()
• Doc::postAffect()

utilisé principalement par la fonction new_doc() et par la classe SearchDoc.

3.2.5 Duplication de document

Les méthode surchargeables appelées lors de la duplication d'un document avec Doc::duplicate()

• Doc::preDuplicate()
• Doc::postDuplicate()

3.2.6 Import de document

Les méthode surchargeables appelées lors de l'import d'un document sont :

• Doc::preImport()
• Doc::postImport()

3.2.7 Ajout d'un document dans un dossier

Les méthode surchargeables appelées lors de l'ajout d'un document dans un dossier sont :

• Lors de l'insertion avec Dir::insertDocument()
  • Dir::preInsertDocument()
  • Dir::postInsertDocument()
• Lors de l'insertion avec Dir::insertMultipleDocuments()
  • Dir::preInsertMultipleDocuments()
  • Dir::postInsertMultipleDocuments()

3.2.8 Retrait d'un document d'un dossier

Les méthode surchargeables appelées lors du retrait d'un document dans un dossier avec Dir::removeDocument() sont :

• Dir::preRemoveDocument()
• Dir::postRemoveDocument()

3.3 Lignée documentaire et révisions

Afin de manipuler correctement les documents, il est important de comprendre les notions de révision et de lignée documentaire.

3.3.1 Révision

Une révision est une capture d'un document à un instant donné. Les valeurs (attributs, propriétés et fichiers) de ce document sont mémorisées et figées, et peuvent être consultées ultérieurement.

À un instant donné, une et une seule révision est active (c'est la révision courante) alors que les autres sont figées (ce sont les révisions passées).

Seule la révision active est modifiable, les révisions figées sont uniquement consultables.

3.3.2 Lignée documentaire

L'ensemble des révisions d'un document constituent une lignée documentaire. Alors que chaque document est identifié de manière non ambigüe par son id, unique, une lignée documentaire est identifiée par son initid.

3.3.3 révision, id et initid

Lors de l'enregistrement en base d'un document, s'il ne possède pas encore d'id, un nouvel id est attribuée au document. Cette valeur est également affectée à la propriété initid. La propriété révision, quand à elle, est positionnée à 0.

Lorsqu'un document est révisé, techniquement, un nouveau document est créé (c'est à dire qu'une nouvelle ligne est créée en base de données).
La propriété révision est incrémentée, la propriété initid est conservée, et un nouvel id est affecté au document. L'ancienne révision est également marqué comme figée (voir la propriété locked).

Exemple :

• création d'un nouveau document
  • ancienne révision
    • aucune
  • nouvelle révision
    • initid : 1234
    • id : 1234
    • revision : 0
    • locked : 0
• révision du document
  • ancienne révision
    • initid : 1234
    • id : 1234
    • revision : 0
    • locked : -1
  • nouvelle révision
    • initid : 1234
    • id : 2345
    • revision : 1
    • locked : 0

Note : les valeurs des id et initid sont arbitraires, elles sont, dans les faits, affectées par la base de données.

3.3.4 Révisions et relations

Dans l'interface d'édition, par défaut, les attributs de type docid sont valués avec l'initid du document cible. Lors de la consultation, le lien est ajusté pour pointer vers la dernière révision de sa lignée documentaire.

Ce comportement peut être modifié au moyen de l'option docrev des attributs relation.

3.3.5 Révisions et new_doc

Par défaut, la fonction new_doc récupère la révision correspondant à l'id passé en paramètre ; ce qui veut dire que ce n'est pas nécessairement la révision courante. Le troisième paramètre de new_doc permet de récupérer systématiquement la révision courante.

Si l'identifiant de la fonction new_doc désigne un nom logique, c'est toujours la version courante qui est retournée.

Le nom logique est le même sur toute la lignée documentaire.

3.3.6 Révisions et recherche

Lors des recherches de documents avec un critère sur une relation, si la relation ne contient pas l'initid, on risque de ne pas trouver le document. C'est pour cette raison que les relations contiennent l'initid par défaut. Dans le cas où d'autres révisions peuvent être référencées, il faut ajouter un critère plus complexe tenant compte des ids de toutes les révisions.

Chapitre 4 Familles et documents

4.1 Présentation

Dans Dynacase, le Document est la structure de base. Le document est constitué d'attributs qui contiennent la donnée.

Un document est fortement structuré, c'est à dire que toutes les informations qu'il contient sont typées et ordonnées.

Cette structure est définie par la famille : Une famille est un type de document (Compte-rendu, Demande de congés, Véhicule, …).

Si on fait le parallèle avec la programmation orientée objet, alors on observe les correspondances suivantes :

• la famille est la classe,
• le document est l'instance

Ainsi, dans Dynacase, toute manipulation d'information passera par une manipulation de document :

1. instanciation (depuis la base de données) ou création
2. modification
3. enregistrement

Ce chapitre présente les différents éléments de paramétrage permettant de définir des familles de document. Chaque mécanisme est décrit dans sa propre partie, alors que la dernière partie spécifie le format de définition des structures.

4.2 Les attributs

4.2.1 Présentation

Les attributs correspondent à des éléments de structure du document.

Techniquement, ils correspondent à :

• un champ de saisie en modification ;
• une représentation textuelle en consultation ;
• une colonne en base de données pour stocker la donnée.

Les attributs sont typés, et disposent d'options permettant de modifier leur comportement, leur représentation, etc.

Cette partie présente chaque type d'attribut, décrit son usage, ses représentations, et liste les options disponibles pour chacun de ces types.

Note sur les options : Dans Dynacase, les options sont libres, ce qui veut dire que vous pouvez utiliser vos propres options pour rajouter des informations sur certains attributs (par exemple, vous pourriez rajouter une option inSpecialView pour lister les attributs à afficher dans votre vue spéciale). De par leur nature extensible, les options n'ont pas de valeur par défaut ; aussi, dans leur description, nous indiquerons par (comportement par défaut) le comportement de l'option en l'absence de valeur.

4.2.2 Options communes à tous les types d'attributs

searchcriteria

Indique quelle sera l'utilisation de l'attribut dans les recherches.

Les valeurs possibles sont :

• visible (comportement par défaut) : Dans ce cas

  • l'attribut est indexé pour la recherche plein texte
  • l'attribut est présenté dans les critères des recherches détaillées et des rapports

• restricted : Dans ce cas

  • l'attribut est indexé pour la recherche plein texte
  • l'attribut n'est pas présenté dans les critères des recherches détaillées et des rapports

• hidden : Dans ce cas

  • l'attribut n'est pas indexé pour la recherche plein texte
  • l'attribut n'est pas présenté dans les critères des recherches détaillées et des rapports

showempty

Indique que l'attribut doit être présenté en consultation, même si sa valeur est vide.

Cela modifie le comportement par défaut, qui consiste à n'afficher en consultation que les attributs valués.

Les valeurs possibles sont :

• `` (une chaîne vide) : Dans ce cas, le libellé sera présenté, et aucune valeur ne sera affichée
• toute chaîne de caractères : Dans ce cas, le libellé est affiché, et la valeur est remplacée par le texte donné.

Remarque : Pour le type image, la valeur doit indiquer le chemin relatif à un fichier 'image'. L'image sera alors affichée si la valeur est vide.

sortable

Indique les modalités de tri de l'attribut.

Par défaut, les attributs sont considérés comme non triable.

Les valeurs possibles sont :

• asc : Dans ce cas
  • l'attribut sera présenté dans le menu de tri de ONEFAM et dans les rapports
  • l'ordre de tri par défaut sera ascendant
• desc : Dans ce cas
  • l'attribut sera présenté dans le menu de tri de ONEFAM et dans les rapports
  • l'ordre de tri par défaut sera descendant

version

Indique que l'attribut est utilisé pour la composition de la version. Se reporter aux propriétés de la classe Doc pour plus de détails.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

vlabel

Indique la position du libellé de l'attribut.

Les valeurs possibles sont :

• pour les attributs de type frame et onglet :

  • up (comportement par défaut)
  • none

• pour les attributs de type array :

  • left (valeur par défaut en consultation)
  • up (valeur par défaut en modification)
  • none

• pour les autres attributs :

  • left (comportement par défaut)
  • up
  • none

elabel

Texte du tooltip du label de l'attribut pour le document en mode modification.

Ne s'applique pas aux attributs de structure (tab, frame, array).

Les valeurs possibles sont :

• Toute chaîne de caractères. Attention, la plupart des navigateurs n'acceptent pas de retour chariot.

ititle

Texte du tooltip du bouton '...' de l'aide à la saisie. Par défaut : « choisissez une valeur »

ltitle

Texte affichable en tooltip sur l'hyperlien lorsque la souris passe dessus

ltarget

Nom de la fenêtre destinataire de l'hyperlien. Par défaut _self. Si ltarget=fhidden alors la requête ira dans une fenêtre cachée.

lconfirm

Indique si on veut un message de confirmation avant l'activation du lien. Mettre lconfirm=yes pour activer la confirmation.

tconfirm

Texte de la confirmation

autosuggest

En édition, sur une aide à la saisie, indique que la recherche est lancée à chaque modification du texte saisi. (par défaut yes). Mettre à no pour désactiver l'auto-suggestion

eltitle

Options pour pour les extra liens (elink). Texte affichable surgissant sur le bouton généré par l'extra lien.

elsymbol

Caractère affiché sur le bouton généré par l'extra lien. Par défaut c'est le caractère + qui est affiché.

eltarget

Nom de la fenêtre destinataire sur le bouton généré par l'extra lien.

viewtemplate

Référence de la vue d'attribut à utiliser lors de la consultation du document

edittemplate

Référence de la vue d'attribut à utiliser lors de la modification du document

4.2.3 Type account

4.2.3.1 Description

Les attributs de type account permettent de faire un lien vers un compte (utilisateur, groupe, ou rôle).

4.2.3.2 Représentation

• consultation : Un hyperlien vers l'utilisateur cible, avec comme label le titre l'utilisateur cible, et son icone.

  

  Figure 6. account simple - consultation html

• modification :

  Une aide à la saisie vers les comptes.

  

  Figure 7. account simple - Modification html

• odt :

  Le titre du document cible.

  

  Figure 8. account simple - consultation odt

4.2.3.3 Comportement

Lors du rendu d'un account, Dynacase récupère dynamiquement le titre des documents cibles. Pour chaque document cible, si l'utilisateur n'a pas le droit de voir le document cible, le titre est remplacé par le texte Information non disponible (se reporter à l'option noaccesstext pour personnaliser ce texte).

4.2.3.4 Format de stockage

La valeur stockée est l'identifiant du document associé.

Le type utilisé en base de donnée est text.

4.2.3.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

group

Indique une restriction sur les comptes qui peuvent être référencés par la relation.

L'aide à la saisie générée ne présentera que les comptes appartenant à ces groupes.

Lorsque l'option match vaut group, seuls les sous-groupes des groupes référencés seront proposés.

Cette option est incompatible avec match=role

Les valeurs possibles sont :

• une liste de références de groupes (attribut us_login) séparés par des virgules

match

Indique une restriction sur les types de comptes qui peuvent être référencés par la relation.

L'aide à la saisie générée ne présentera que les comptes dans les types listés.

Les valeurs possibles sont :

• user (comportement par défaut)
• group
• role
• all

multiple

Indique que plusieurs documents peuvent être référencés par la relation.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

noaccesstext

Indique le texte qui est affiché lorsque le document cible n'est pas visible.

Cette valeur sera automatiquement ajoutée au catalogue de traduction.

Les valeurs possibles sont :

• toute chaîne de caractères (sur une seule ligne).

role

Indique une restriction sur les comptes qui peuvent être référencés par la relation.

L'aide à la saisie générée ne présentera que les comptes ayant ces rôles.

Les valeurs possibles sont :

• une liste de référence de rôles séparés par des virgules

4.2.4 Type action

4.2.4.1 Description

Les attributs action permette d'ajouter des boutons dans les interfaces de consultation. Ces boutons déclencheront l'action défini par l'attribut.

4.2.4.2 Représentation

• consultation :

  Un bouton placé en bas du document.

• modification :

  Non représenté

• odt :

Non représenté

4.2.4.3 Comportement

Si l'utilisateur peut exécuter l'action alors le bouton est présenté.

4.2.4.4 Format de stockage

Cet attribut n'est pas stocké.

4.2.4.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

batchfolder

Indique si l'action définie doit être appliquée sur tous les éléments du dossier.

Option utilisable uniquement dans les familles dérivées de la famille EXEC (Traitement). Se reporter à la documentation de la famille Traitement pour plus de détails.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

4.2.5 Type array

4.2.5.1 Description

Les attributs de type array permettent de définir des tableaux.

Chacun des attributs contenu dans un array est alors dit multiple, et correspond à une colonne du dit array. Un tableau ne peut pas contenir d'autres attributs de type array.

4.2.5.2 Représentation

Les array sont représentés au moyen d'une table.

Chaque colonne correspond à un attribut contenu dans l'array. Le libellé de la colonne est le libellé de l'attribut correspondant.

• consultation :

  Un tableau.

  

  Figure 9. array - consultation html

• modification :

  La première colonne contient les outils permettant la sélection, suppression, et le déplacement d'une colonne, alors que la dernière ligne contient les outils permettant de rajouter une ligne ou de dupliquer une ligne existante.

  

  Figure 10. array - Modification html

• odt :

  Un tableau

  

  Figure 11. array - consultation odt

4.2.5.3 Comportement

Aucun comportement particulier.

4.2.5.4 Format de stockage

Le tableau en lui même n'est pas stocké, mais modifie la façon dont les attributs qu'il contient sont stockés. En effet, une fois dans un tableau, un attribut est multiple, et nécessite donc le stockage de plusieurs valeurs. Pour rester simple, la valeur stockée sera une suite des valeurs de stockage simples séparées par un séparateur interne.

Pour plus de précisions, se reporter au chapitre avancé sur les formats de stockage.

4.2.5.5 Options applicables à l'array

cellbodystyle

Indique le style css appliqué sur les cellules du corps de tableau.

Les valeurs possibles sont :

• toute définition css valide.

cellheadstyle

Indique le style css appliqué sur les cellules de l'entête de tableau.

Les valeurs possibles sont :

• toute définition css valide.

classname

Indique une classe css à appliquer aux cellules du corps tableau en consultation.

Les valeurs possibles sont :

• tout nom de classe valide.

displayrowcount 3.2.17

Indique si le nombre de lignes du tableau est affiché dans l'entête de la première colonne.

Les valeurs possibles sont un entier n avec :

• n <= -1 pour ne jamais afficher le nombre de lignes ;
• n = 0 pour toujours afficher le nombre de lignes ;
• n > 0 pour afficher le nombre de lignes si celui-ci est > n.

Par défaut la valeur de displayrowcount est 10.

empty

Indique que le tableau, s'il est vide ne doit pas afficher la première rangée en modification. Dans le cas contraire, en modification, le tableau est initialisé avec une rangée vide.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

height

Indique la hauteur du corps du tableau. Si le corps du tableau dépasse la hauteur spécifiée, un ascenseur vertical apparaîtra.

Ne fonctionne qu'avec les navigateurs récents.

Les valeurs possibles sont:

• Une taille en pixels (par exemple 150px).

sorttable

Indique que le tableau est triable. L'utilisateur peut cliquer sur un en-tête de colonne pour trier cette colonne.

Le tri est effectué au moyen du script sorttable.js.

L'utilisation avancée de sorttable.js sort du sujet de cette documentation, et est à charge et de la responsabilité du développeur.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

twidth

Indique la largeur du tableau. Si le corps du tableau dépasse la largeur spécifiée, un ascenseur horizontal apparaîtra.

Les valeurs possibles sont :

• une valeur absolue en pixel (par exemple 100px),
• une largeur relative en pourcentage (par exemple 30%)

La valeur par défaut est 100%.

userowadd

Indique si l'utilisateur est autorisé à ajouter des rangées au tableau. Dans ce cas, le bouton correspondant est affiché.

Cela permet de ne pas être en conflit si le tableau doit être rempli par un code spécifique sur l'interface, mais pas par l'utilisateur.

Les valeurs possibles sont :

• yes (comportement par défaut)
• no

rowviewzone

Indique une vue spécifique de tableau pour la consultation.

roweditzone

Indique une vue spécifique de tableau pour la modification.

4.2.5.6 Options applicables aux attributs contenus dans un array

align

Indique l'alignement horizontal pour les cellules de la colonne.

Les valeur possibles sont :

• left,
• right,
• center,
• justify

bgcolor

Indique la couleur de fond des cellules de la colonne.

Les valeurs possibles sont :

• toute couleur css valide (exemple : yellow, #FF335A, etc.)

color

Indique la couleur du texte pour les cellules de la colonne.

Les valeurs possibles sont :

• toute couleur css valide (exemple : yellow, #FF335A, etc.)

cwidth

Indique la largeur de la colonne.

Les valeurs possibles sont :

• une valeur absolue en pixel (par exemple 100px),
• une largeur relative en pourcentage (par exemple 30%)
• auto (comportement par défaut)

4.2.6 Type color

4.2.6.1 Description

Les attributs de type color permettent d'insérer une couleur.

4.2.6.2 Représentation

• consultation :

  Un span contenant le code html de la couleur, et la couleur comme background.

  

  Figure 12. color - consultation html

• modification :

  Un color picker basé sur JSColor.

  

  Figure 13. color - Modification html

• odt :

  Non utilisable

4.2.6.3 Comportement

Aucun comportement particulier.

4.2.6.4 Format de stockage

La valeur stockée est le code html de la couleur.

Le type utilisé en base de donnée est text.

4.2.6.5 Options

options communes à tous les types d'attributs.

Ce type d'attribut ne dispose d'aucune option spécifique.

4.2.7 Type date

4.2.7.1 Description

Les attributs de type date permettent d'insérer une date.

4.2.7.2 Représentation

• consultation :

  La date formatée en accord avec la locale de l'utilisateur.

  

  Figure 14. date - consultation html

  La date peut avoir un format particulier en utilisant la notation de strftime.

  Exemple : date("%A %e %B %y") pour afficher vendredi 17 mai 2013

• modification :

  Un date picker (basé sur JSCalendar).

  

  Figure 15. date - Modification html

• odt :

  La date formatée en accord avec la locale de l'utilisateur.

  

  Figure 16. date - consultation odt

4.2.7.3 Comportement

Lors de la saisie, la date est validée, c'est à dire que le format doit être :

• soit au format « français » ;
• soit au format « US » ;
• soit au format ISO8601.

4.2.7.4 Format de stockage

La date est stockée au format ISO8601 (yyyy-mm-dd).

Le type utilisé en base de donnée est date. Si l'attribut est dans un tableau, le type en base donnée sera text.

4.2.7.5 Options

options communes à tous les types d'attributs.

Ce type d'attribut ne dispose d'aucune option spécifique.

4.2.8 Type docid

4.2.8.1 Description

Les attributs de type docid permettent de faire un lien vers un ou plusieurs documents. Ils sont appelés relations.

Les attributs de type docid sont typés, c'est à dire qu'on précise de quelle famille doivent être les documents cible.
Cela se fait au moyen de la syntaxe docid("<family>") (Dans ce cas, les documents doivent être de la famille <family> ou d'une de ses ous-familles).

4.2.8.2 Représentation

• consultation :

  Un hyperlien vers le document cible, avec comme label le titre du document cible, et l'icône du document

  

  Figure 17. docid simple - consultation html

• modification :

  une aide à la saisie vers les documents de la famille cible (et de ses sous-familles). L'aide à la saisie porte sur le titre uniquement, avec le filtre contient, insensible à la casse et aux accents.

  

  Figure 18. docid simple - Modification html

• odt :

  

  Figure 19. docid simple - consultation odt

4.2.8.3 Comportement

Lors du rendu d'un docid, Dynacase récupère le titre des documents cibles. Pour chaque document cible, si l'utilisateur n'a pas le droit de voir le document cible, le titre est remplacé par le texte Information non disponible (se reporter à l'option noaccesstext pour personnaliser ce texte).

4.2.8.4 Format de stockage

La valeur stockée est l'identifiant interne du document cible.

Attention, bien que l'identifiant soit la plupart du temps un nombre, son format de stockage est un format texte.

Le type utilisé en base de donnée est text.

4.2.8.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

creation

Indique qu'un document de la famille cible de la relation pourra être créé depuis le formulaire.

Dans ce cas, un bouton sera ajouté sur le formulaire. Ce bouton ouvre un formulaire de création de la famille cible. Lors de la sauvegarde du nouveau document, ce nouveau document est inséré dans l'attribut de départ.
Si l'utilisateur n'a pas le droit de créer un document de la famille cible, le bouton ne sera pas affiché.

Pour les relations multiples, le nouveau document sera inséré dans la liste des documents.

Lorsque la relation est déjà renseignée, le bouton permet de modifier le document cible au lieu d'en créer un nouveau.
Si le document lié n'est pas accessible en modification, il sera alors affiché en consultation.

Les valeurs possibles sont :

• yes

• un objet (Attention: bien que cela y ressemble, ce n'est pas du JSON) construit de la manière suivante :

  • Pour définir la valeur d'un attribut du document cible : attrid_document_cible: "valeur" (si la valeur est fixe), ou attrid_document_cible: attrid_document_source si la valeur est à recopier depuis le document source.
  • Pour fermer la fenêtre de création lors de la sauvegarde : autoclose: "yes"

  • Pour appeler de nouveau l'aide à la saisie lors de l'insertion de la valeur dans le document source : recallhelper: "yes"

    Cela peut être utile dans le cas où l'aide à la saisie doit remplir plusieurs attributs du document source.

  Par exemple, creation={an_name:CT, an_reference :"une référence", an_target:en_source, recallhelper: "yes", autoclose: "yes"} indique que :

  • l'attribut an_name prendra comme valeur initiale *la valeur actuellement saisie par l'utilisateur dans le champ de l'aide à la saisie
  • l'attribut an_reference prendra la valeur une référence
  • l'attribut an_target prendra la valeur de l'attribut en_source du document source
  • l'aide à la saisie sera rappelée lors de la sauvegarde du document nouvellement créé
  • la fenêtre de création du nouveau document sera fermée lors de sa sauvegarde.

docrev

Indique quelle est la révision pointée par la relation.

Les valeurs possibles sont :

• latest (comportement par défaut) : Dans ce cas, la relation pointe vers la dernière révision de la lignée documentaire ;
• fixed : Dans ce cas, la relation pointe vers la révision ayant l'id référencé ;
• state(step), où step est une étape : Dans ce cas, la relation pointe vers le dernier document à l'étape step.

Cette option affecte le comportement de l'aide à la saisie générée :

• lorsque l'option a la valeur latest, c'est l'initid du document qui est retourné ;
• lorsque l'option a la valeur fixed, c'est le docid de la dernière révision au moment de l'appel qui est retourné ;
• lorsque l'option a la valeur state(step), seuls les documents à l'étape step sont listés, et c'est le docid de la dernière révision à l'étape step au moment de l'appel qui est retourné.

doctitle

Indique qu'un attribut contenant le titre du document cible doit être automatiquement renseigné.

Cela est notamment utile pour la recherche plein texte, les tris, etc.

Les valeurs possibles sont :

• no (comportement par défaut) ;
• tout id d'attribut existant : Dans ce cas, l'attribut référencé contient le titre du document cible ;
• auto : Dans ce cas, un attribut est généré (son id est <id_de_la_relation>_title et son titre est <titre_de_la_relation> (titre) )

isuser

Indique quels attributs sont utilisables pour le profilage des documents.

Les valeurs possibles sont :

• yes : Dans ce cas, il faut que le document lié soit de la famille IUSER (Utilisateur) ou dérivé de IUSER.
• no (comportement par défaut)

multiple

Indique que plusieurs documents peuvent être référencés par la relation.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

noaccesstext

Indique le texte qui est affiché lorsque le document cible n'est pas visible.

Cette valeur sera automatiquement ajoutée au catalogue de traduction.

Les valeurs possibles sont :

• toute chaîne de caractères.

En l'absence de l'option, le texte affiché est Information non disponible

4.2.9 Type double

4.2.9.1 Description

Les attributs de type double permettent d'insérer un nombre avec décimales.

4.2.9.2 Représentation

• consultation :

  Le nombre, sans formatage

  

  Figure 20. double - consultation html

  Le formatage spécifique de double doit être conforme à celui utilisé dans la fonction sprintf. Par exemple double("%.03f") pour avoir 3 chiffres maximum après la virgule.

• modification :

  un input de type texte permettant de saisir le nombre.

  

  Figure 21. double - Modification html

• odt :

  Le nombre, sans formatage

  

  Figure 22. double - consultation odt

4.2.9.3 Comportement

Lors de l'enregistrement, le nettoyage suivant est effectué :

• remplacement des , par .
• suppression des espaces

La valeur nettoyée est validée au moyen de la fonction is_numeric.

4.2.9.4 Format de stockage

La valeur stockée est la valeur nettoyée.

Le type utilisé en base de donnée est double. Si l'attribut est dans un tableau, le type en base donnée sera text.

4.2.9.5 Options

Options communes à tous les types d'attributs.

elabel

En plus du tooltip du label défini par les options communes pour elabel, Cette option affecte sa valeur sur l'attribut title du l'input correspondant.

Les valeurs possibles sont :

• Toute chaîne de caractères. Attention, la plupart des navigateurs n'acceptent pas de retour chariot.

4.2.10 Type enum

4.2.10.1 Description

Les attributs de type enum permettent d'insérer des listes de choix, sous la forme clé|libellé.

4.2.10.2 Représentation

• consultation :

  Le libellé, traduit le cas échéant.

  

  Figure 23. enum - consultation html

• modification :

  Un input de type select présentant les libellés traduits le cas échéant.

  

  Figure 24. enum - Modification html

• odt :

  Le libellé, traduit le cas échéant.

  

  Figure 25. enum - consultation odt

4.2.10.3 Comportement

Aucun comportement particulier.

4.2.10.4 Format de stockage

La valeur stockée est la clé.

Le type utilisé en base de donnée est text.

4.2.10.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

bmenu

Indique si l'énuméré doit apparaître en tant que filtre dans les interfaces de l'application GENERIC

Les valeurs possibles sont :

• yes (comportement par défaut)
• no

boolcolor

Indique que l'énuméré sera représenté (en consultation) par un carré de couleur.

Les valeurs possibles sont :

• Un couple de couleurs css valides séparées par une virgule (par exemple blue,#FF0000). La première couleur indique la couleur de la première clé, et la seconde couleur celle de la seconde clé.

eformat

Indique le mode d'affichage de l'énuméré.

Les valeurs possibles sont :

• list (comportement par défaut)

  • Dans le cas d'un énuméré simple, il sera représenté

    • en modification sous la forme d'un select traditionnel,
    • en consultation sous la forme d'une chaîne contenant le label

  • Dans le cas d'un énuméré multiple, il sera représenté

    • en modification sous la forme d'un select traditionnel (avec utilisation de la touche ctrl pour sélectionner plusieurs valeurs,
    • en consultation sous la forme d'une liste de chaînes contenant le label alignées verticalement

• vcheck

  • Dans le cas d'un énuméré simple, il sera représenté

    • en modification sous la forme de boutons radio alignés verticalement
    • en consultation sous la forme d'une chaîne contenant le label

  • Dans le cas d'un énuméré multiple, il sera représenté

    • en modification sous la forme de checkbox alignées verticalement
    • en consultation sous la forme d'une liste de valeurs alignées verticalement

• hcheck

  • Dans le cas d'un énuméré simple, il sera représenté

    • en modification sous la forme de boutons radio alignés horizontalement
    • en consultation sous la forme d'une chaîne contenant le label

  • Dans le cas d'un énuméré multiple, il sera représenté

    • en modification sous la forme de checkbox alignées horizontalement
    • en consultation sous la forme d'une liste de valeurs alignées horizontalement

• auto

  la présentation de l'énuméré sera similaire à celle d'un attribut de type docid

• bool

  Ne s'applique qu'aux énumérés à 2 valeurs.

  L'énuméré sera présenté

  • en modification sous la forme d'une checkbox (coché sélectionne la seconde valeur, non coché reste sur la première valeur)
  • en consultation sous la forme d'une chaîne contenant le label

esort

Indique l'ordre dans lequel les entrées seront listées.

Les valeurs possibles sont :

• none (comportement par défaut) Les énumérés sont présentés dans l'ordre de déclaration;
• key : Dans ce cas, les propositions sont triées par ordre alphabétique des clés ;
• label : Dans ce cas, les propositions sont triées par ordre alphabétique des traductions des libellés.

etype

Indique si la valeur est restreinte aux valeurs de la liste.

Les valeurs possibles sont :

• free : Dans ce cas, l'utilisateur peut saisir une valeur libre
• open : Dans ce cas, l'utilisateur peut également saisir une valeur libre. Cette valeur sera alors ajoutée à la liste des valeurs possibles pour les choix ultérieurs.

eunset

Indiquer que l'énuméré sera vide par défaut.

S'il y a une valeur par défaut explicite pour l'attribut, l'option eunset est inopérante.

Les valeurs possibles sont :

• yes
• no (par défaut) : Dans ce cas, la valeur par défaut est la première des valeurs de l'énuméré selon sa définition.

mselectsize

Indique le nombre d'items présentés pour les énumérés multiples lorsque l'option eformat est list.

Les valeurs possibles sont :

• tout entier.

La valeur par défaut est 3.

multiple

Indique que l'énuméré peut être multivalué.

Les énumérés multiples ne peuvent pas être utilisés dans les tableaux.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

system

Indique que la gestion de l'énuméré ne peut pas être faite par l'IHM d'administration.

Dans ce cas, la définition est écrasée à chaque importation.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

4.2.10.6 Définition de valeurs d'énumérés

Les énumérés sont structurés sous la forme de couples clé/valeur. La valeur stockée en base de données est la clé, alors que l'utilisateur voit la valeur correspondante.

Les labels peuvent ainsi être traduits, tout en n'altérant pas le stockage en base.

Lors de la Déclaration de familles, il est possible de définir des couples de clé/valeur au moyen de la syntaxe [cle1]|[label 1],[cle2]|[label 2],….

Pour chaque clé définie par ce moyen :

• si la clé existe déjà pour cet énuméré, le label correspondant est mis à jour,
• si la clé n'existe pas pour cet énuméré, elle est ajoutée.

4.2.10.6.1 Restrictions sur la valeur des clés

Lors de la composition des clés, il est interdit d'utiliser

• les caractères :
  • " (guillemet double),
  • ' (apostrophe),
  • & (esperluette),
  • | (pipe)
• les séquences :
  • -dot-,
  • -comma-

En outre, les valeurs suivantes doivent être échappées au moyen du caractère \ (anti-slash) :

• . (point) : voir les énumérés multi-niveaux

4.2.10.6.2 Restrictions sur la valeur des labels

Lors de la composition des labels, il est interdit d'utiliser

• les caractères :
  • | (pipe)
• les séquences :
  • -dot-,
  • -comma-

En outre, les valeurs suivantes doivent être échappées au moyen du caractère \ (anti-slash) :

• , (virgule)

4.2.10.6.3 Suppression de valeurs d'énumérés

Si l'énuméré est déclaré avec l'option system=yes, les définitions des énumérés est réinitialisé à chaque importation.

Si l'énuméré n'a pas cette option, il faut ajouter un ordre RESET;enums pour forcer la réinitialisation avec les nouvelles valeurs définies.

Note : La suppression d'une valeur dans la définition ne supprime pas les valeurs déjà affectés aux documents. Si un document a une valeur non répertoriée dans la définition de l'énuméré ce sera cette valeur (brute) qui sera affichée car son ancien libellé aura été supprimé.

4.2.10.6.4 Énumérés multi-niveaux

Il est possible d'exprimer une arborescence des clés au moyen du séparateur ..

Par exemple, l'énuméré france|France,france.midi|Midi-Pyrénées,france.midi.gers|Gers,france.midi.haute-garonne|Haute-Garonne,france.idf|Île-de-France,france.idf.paris|Paris définit l'arborescence :

• France
  • Midi-Pyrénées
    • Gers
    • Haute-Garonne
  • Île-de-France
    • Paris

Du point de vue interne, c'est la clé 'finale' qui est stockée. Cela permet de modifier l'arborescence sans impacter les clés déjà stockées. Cependant, cela implique aussi que toutes les clés finales d'un énuméré doivent être non‑ambigües (par exemple, un|un,un.one|one,deux|deux,deux.one|one more n'est pas valide, car la clé one désigne à la fois un.one et deux.one).

4.2.10.6.5 Valeurs dynamiques

La définition d'un énuméré peut être fournie par une fonction PHP.

Cette fonction est alors exprimée de la même façon qu'une aide à la saisie : la caractéristique phpfile doit désigner un fichier publié dans le répertoire EXTERNALS et la fonction de définition de l'énuméré doit être définie dans le fichier référencé par phpfile.

Cette fonction doit retourner la définition sous la forme d'une chaîne de caractères comme décrit ci-dessus.

4.2.10.6.6 Localisation des énumérés

Les labels sont traduisibles. les clés de traductions sont composées sous la forme <FAMILYNAME>#<ATTRID>#<ENUMKEY> (exemple MY_FAMILY#my_color#yellow).

4.2.11 Type file

4.2.11.1 Description

Les attributs de type file permettent d'insérer un fichier.

4.2.11.2 Représentation

• consultation :

  Un lien permettant de télécharger le fichier

  

  Figure 26. file - consultation html

• modification :

  Un input de type text présentant le nom du fichier, suivi de 3 boutons :

  • pour choisir un nouveau fichier,
  • restaurer le fichier préalablement enregistré,
  • effacer le fichier.
  

  Figure 27. file - Modification html

  S'il s'agit d'une modification de document et que le fichier est déjà enregistré alors le clic sur le nom du fichier permet de le télécharger.

  Des différences de comportement sont présentes en fonction des navigateur. Sur IE < 11, le bouton original "Parcourir" est affiché lorsqu'on clique sur le bouton "...". Le paramètre applicatif "FDL_OLDFILEINPUTCOMPAT" indique si l'attribut doit présenter, de manière systématique, le bouton original "Parcourir"

  

  Figure 28. file - FDL_OLDFILEINPUTCOMPAT Modification html

• odt :

  Le titre du fichier

  

  Figure 29. file - consultation odt

4.2.11.3 Comportement

Lors de l'enregistrement du document, le fichier est stocké dans le vault.

4.2.11.4 Format de stockage

La valeur stockée est l'identifiant vault du fichier (sous la forme <type-mime>|<vaultid>|<file-name>).

Le type utilisé en base de donnée est text.

4.2.11.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

hideindav

Indique si le fichier apparaît lors de l'accès au moyen du protocole webdav.

Les valeurs possibles sont :

• yes (comportement par défaut)
• no

inline

Si le paramètre est yes, il indique que le fichier doit être consulté directement dans le navigateur. Seuls les types de fichiers supportés par le navigateur peuvent être affichés directement.
Si le paramètre est no, le téléchargement est proposé par le navigateur. Le nom du fichier proposé au téléchargement est celui du fichier enregistré. Si le nom du fichier comporte des double-quotes ", ils sont remplacés par des tirets -.

Les valeurs possibles sont :

• yes
• no(comportement par défaut)

pdffile

Utilisé conjointement avec l'option viewfiletype, indique l'attribut contenant le fichier pdf à afficher.

Les valeurs possibles sont :

• tout id d'attribut de la famille en cours.

preventfilechange

Ajoute une contrainte pour que le fichier à remplacer provienne de la dernière version du serveur.

Cela ne bloque pas un changement de fichier mais avertit l'utilisateur dans le cas où le fichier ne correspond pas à cette dernière version.

Lors du téléchargement du fichier un code identifiant la version est ajouté dans le nom du fichier (exemple foo{i47307-56}.ods pour le fichier foo.ods). Lorsque l'utilisateur envoie à nouveau le fichier, le serveur vérifie ce numéro de version. Si le numéro correspond à la dernière version, alors le fichier est accepté. Dans le cas contraire, une confirmation est demandée à l'utilisateur.

Attention: si l'utilisateur renomme le fichier, la vérification échoue, et le serveur demande la confirmation.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

rn

Indique que le fichier sera renommé sur le serveur.

Les valeurs possibles sont :

• un nom de méthode de la famille courante (par exemple ::myNewName()). La méthode prend en entrée le nom du fichier et doit retourner le nouveau nom sous la forme d'une chaîne de caractères.

Note: Il est recommandé que la méthode fournisse une extension compatible avec le type mime pour l'utilisation ultérieure sur le poste client et les transformations. Pour récupérer l'extension d'un nom de fichier vous pouvez utiliser la fonction getFileExtension de la librairie Lib.FileMime.php

search

Indique si l'attribut est indexé pour la recherche plein-texte.

Les valeurs possibles sont :

• yes (comportement par défaut)
• no

template

Indique si l'attribut file est un template.

se reporter à la documentation des templates OOO pour les explications

Les valeurs possibles sont :

• static
• dynamic

viewfileheigth

Utilisé conjointement avec l'option viewfiletype, indique la hauteur du rendu affiché sur le navigateur.

Les valeurs possibles sont :

• Une taille en pixels (par exemple 150px).
• Une taille en pourcentage de la hauteur de la fenêtre (par exemple 80%)

Il n'y a pas de valeur par défaut

viewfiletype

Indique qu'une prévisualisation du fichier sera disponible dans le navigateur, ne nécessitant donc pas de logiciel tiers.

Les valeurs possibles sont :

• pdf : Dans ce cas, l'attribut indiqué par l'option pdffile sera utilisé comme prévisualisation ;
• image : Dans ce cas, le moteur de transformation génère une visualisation sous forme d'images avec tourne pages du pdf référencé par l'option pdffile.

4.2.12 Type frame

4.2.12.1 Description

Les attributs de type frame permettent de regrouper des attributs. Ce regroupement sera le plus souvent sémantique.

4.2.12.2 Représentation

• consultation :

  un div entourant les attributs contenus dans cette frame. Le titre du cadre est dans une balise div placé avant le contenu.

  

  Figure 30. frame - consultation html

• modification :

  un fieldset entourant les attributs contenus dans cette frame. Le titre du cadre est dans une balise legend.

  

  Figure 31. frame - Modification html

• odt :

  Aucune représentation

4.2.12.3 Comportement

Une frame est collapsible en cliquant sur son libellé.

4.2.12.4 Format de stockage

Cet attribut n'est pas stocké.

4.2.12.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

bgcolor

Indique la couleur de fond du cadre.

Les valeurs possibles sont :

• toute couleur css valide (exemple : yellow, #FF335A, etc.)

4.2.13 Type htmltext

4.2.13.1 Description

Les attributs de type htmltext permettent d'insérer du texte avec mise en forme.

Le langage de mise en forme est le html, et un éditeur WYSIWYG (basé sur CKEditor) permet d'en simplifier la saisie.

4.2.13.2 Représentation

• consultation :

  une div contenant la valeur.

  

  Figure 32. htmltext - consultation html

• modification :

  une iframe dans laquelle est initialisé une instance de CKEditor.

  

  Figure 33. htmltext - Modification html

• odt :

  la mise en forme est conservée.

  Se reporter au chapitre sur les vues odt pour les restrictions sur l'utilisation des attributs de type html dans les document openDocument text.

4.2.13.3 Comportement

L'éditeur CKeditor nettoit le code HTML inséré. Il ne conserve que les balises qui peuvent être insérées avec la barre de menu.

3.2.19 Lors de l'enregistrement sur le serveur, le nettoyage suivant est effectué :

• Suppression de tous les attributs commençant par "on" ou "xmlns"
• Suppression du javascript, applet et vbscript (le contenu est conservé sans les balises )
• Suppression des éléments avec namespace
• Les entités UTF-8 sont décodées ;
• Les commentaires sont supprimés.

En ce qui concerne les balises "script", elles ne sont pas autorisées par CKEditor quelque soit la configuration. Le nettoyage côté serveur est réalisé pour les données qui peuvent provenir d'une autre source que l'éditeur web.

3.2.20 Lors de l'affectation de l'attribut, le fragment HTML est controllé afin de vérifier s'il est bien formé et retourne une erreur si ce n'est pas le cas.

4.2.13.4 Format de stockage

La valeur stockée est le html nettoyé selon les règles précédentes.

Le type utilisé en base de donnée est text.

4.2.13.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

doclink

Cette option nécessite l'installation du module dynacase-ckeditor-plugins.

Active l'option doclink du HTMLEditor. Cette option se présente sous la forme d'un nouveau bouton (dans la partie réservée au lien dans les toolbar et en fin de toolbar sur la Basic), en cliquant sur le bouton une interface vous propose de sélectionner un document et ajoute une balise de lien vers ce document.

Les valeurs possibles sont :

• un objet JSON (par exemple {"famId": "DIR", "docrev" : "fixed"}), contenant les propriétés suivantes :
  • famId (obligatoire) : nom logique de la famille des documents cible,
  • docrev (facultatif) : les valeurs possibles sont les mêmes que l'option docrev des attributs de type docid (latest, fixed, state(keystate)),
  • filter (facultatif) : un filtre SQL qui sera appliqué à la recherche

editheight

Indique la hauteur de la zone d'édition.

Les valeurs possibles sont :

• une taille en pixels (par exemple 400px)

La valeur par défaut est 150px.

htmlclean

Indique que le serveur nettoiera le contenu en supprimant toutes les balises de style, généralement issues d'un copier/coller :

• les attribut des balises span (le contenu est conservé) et font sont supprimés ;
• les attributs @class et @style sont supprimés ;
• les balises style sont supprimées.

De plus, le fragment HTML est réécrit sous une forme normalisée3.2.20

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

allowedcontent 3.2.20

Indique que la liste des balises autorisées n'est pas liée au menu. Toute balise html supportée peut être insérée à l'exception de la balise script. Les attributs de ces balises peuvent aussi être utilisées à l'exception des attributs commençant par on tel que onclick ou onmouseover.

Les valeurs possibles sont :

• all : toute balise supportée est autorisée
• menu (comportement par défaut) en fonction de la barre de menu (voir option toolbar ci-après).

Les balises supportées sont : a, abbr, acronym, address, applet, area, article, aside, audio, b, base, basefont, bdi, bdo, big, blockquote, body, br, button, canvas, caption, center, cite, code, col, colgroup, command, datalist, dd, del, details, dfn, dialog, dir, div, dl, dt, em, embed, fieldset, figcaption, figure, font, footer, form, h1, h2, h3, h4, h5, h6, head, header, hgroup, hr, html, i, iframe, img, input, ins, isindex, kbd, keygen, label, legend, li, link, main, map, mark, menu, meta, meter, nav, noframes, noscript, object, ol, optgroup, option, output, p, param, pre, progress, q, rp, rt, ruby, s, samp, section, select, small, source, span, strike, strong, style, sub, summary, sup, table, tbody, td, textarea, tfoot, th, thead, time, title, tr, track, tt, u, ul, var, video, wbr.

jsonconf

Cette option permet de configurer finement l'éditeur de texte WYSIWYG.

Elle permet notamment de fixer finement le comportement de l'éditeur et le contenu des toolbar. Les options de configuration sont celles de CKEditor, et l'objet de configuration doit être présenté en JSON valide.

Les options propres à CKEditor (resize, correction orthographique, etc) ne sont pas maintenues par Anakeen et leur bon fonctionnement n'est pas garanti par Anakeen.

Aux options de CKEDITOR, dynacase ajoute les options suivantes :

• addPlugin : permet de charger un plugin additionnel.

  La valeur doit être un tableau (JSON) de noms logiques de plugins (par exemple: "addPlugins": ["docattr"]). Dans ce cas, le plugin doit posséder une commande ayant le même nom que le nom logique du plugin. Cette commande est alors ajoutée en fin de toolbar.

Exemple de configuration permettant d'activer le plugin docattr et le plugin doclink et avec un menu basique et l'activation du mode resize : jsonconf={"addPlugins" : ["docattr"], "doclink" : {"famId" : "DIR"}, "toolbar" : "basic", "resize_enabled" : true}

Attention : l'utilisation de cette option bas niveau désactive les options suivantes :

• toolbar
• toolbarexpand
• editheight
• doclink

Il est par contre possible de construire une option jsonconf qui a le même effet que les options précédentes.

toolbar

Indique le template à utiliser pour la barre de menu.

La barre de menu contraint par défaut la liste des éléments acceptés par l'éditeur de texte.

Pour supprrimer cette contrainte, il faut utiliser l'option allowedContent de ckeditor. Exemple pour tout autoriser : jsonconf={"allowedContent" : true, "toolbar" : "Basic"}

Les valeurs possibles sont :

• Simple (comportement par défaut) :

  

  Figure 34. toolbar Simple

  Les balises et attributs autorisés sont :

  • "a[tout attribut] "
  • "address"
  • "br"
  • "caption[text-align]"
  • "div[text-align]"
  • "em"
  • "h1[text-align]"
  • "h2[text-align]"
  • "h3[text-align]"
  • "h4[text-align]"
  • "h5[text-align]"
  • "h6[text-align]"
  • "img[tout attribut] "
  • "li[text-align]"
  • "ol"
  • "p[text-align]"
  • "pre[text-align]"
  • "s"
  • "span[font-size, color, background-color]"
  • "strong"
  • "table[width, height]"
  • "tbody"
  • "td[width, height, border-color, background-color, white-space, vertical-align, text-align, text-align]"
  • "tfoot"
  • "th[width, height, border-color, background-color, white-space, vertical-align, text-align, text-align]"
  • "thead"
  • "tr"
  • "u"
  • "ul"

• Basic :

  

  Figure 35. toolbar Basic

  Les balises et attributs autorisés sont :

  • "a[tout attribut] "
  • "br"
  • "em"
  • "img[tout attribut] "
  • "li"
  • "ol"
  • "p"
  • "strong"
  • "td[width, height, border-color, background-color, white-space, vertical-align, text-align]"
  • "th[width, height, border-color, background-color, white-space, vertical-align, text-align]"
  • "ul"

• Default :

  

  Figure 36. toolbar Default

  Les balises et attributs autorisés sont :

  • "a[tout attribut] "
  • "address"
  • "big"
  • "blockquote"
  • "br"
  • "caption[text-align]"
  • "cite"
  • "code"
  • "del"
  • "div[text-align, padding, background, border]"
  • "em"
  • "h1[text-align]"
  • "h2[text-align, font-style]"
  • "h3[text-align, color, font-style]"
  • "h4[text-align]"
  • "h5[text-align]"
  • "h6[text-align]"
  • "hr"
  • "img[tout attribut] "
  • "ins"
  • "kbd"
  • "li[text-align]"
  • "ol"
  • "p[text-align]"
  • "pre[text-align]"
  • "q"
  • "s"
  • "samp"
  • "small"
  • "span[font-family, font-size, color, background-color]"
  • "strong"
  • "sub"
  • "sup"
  • "table[width, height, border-collapse, border-style, background-color]"
  • "tbody"
  • "td[width, height, border-color, background-color, white-space, vertical-align, text-align, text-align]"
  • "tfoot"
  • "th[width, height, border-color, background-color, white-space, vertical-align, text-align, text-align]"
  • "thead"
  • "tr"
  • "tt"
  • "u"
  • "ul[list-style-type]"
  • "var"

• Full :

  

  Figure 37. toolbar Full

  Les balises et attributs autorisés sont :

  • "a[tout attribut] "
  • "address"
  • "big"
  • "blockquote"
  • "br"
  • "caption[text-align]"
  • "cite"
  • "code"
  • "del"
  • "div[text-align, padding, background, border]"
  • "em"
  • "h1[text-align]"
  • "h2[text-align, font-style]"
  • "h3[text-align, color, font-style]"
  • "h4[text-align]"
  • "h5[text-align]"
  • "h6[text-align]"
  • "hr"
  • "img[tout attribut] "
  • "ins"
  • "kbd"
  • "li[text-align]"
  • "ol"
  • "p[text-align]"
  • "pre[text-align]"
  • "q"
  • "s"
  • "samp"
  • "small"
  • "span[font-family, font-size, color, background-color]"
  • "strong"
  • "sub"
  • "sup"
  • "table[width, height, border-collapse, border-style, background-color]"
  • "tbody"
  • "td[width, height, border-color, background-color, white-space, vertical-align, text-align, text-align]"
  • "tfoot"
  • "th[width, height, border-color, background-color, white-space, vertical-align, text-align, text-align]"
  • "thead"
  • "tr"
  • "tt"
  • "u"
  • "ul[list-style-type]"
  • "var"

Pour les toolbars qui comportent le bouton "insérer une image", le widget permet d'insérer des documents "image" déjà enregistrés sur le serveur. Il permet aussi d'ajouter de nouvelles images si le droit "créer" sur la famille "image" (nom logique : IMAGE) est donné à l'utilisateur. Les nouvelles images créées n'ont pas de profilage particulier et peuvent être réutilisées par d'autres utilisateurs.

toolbarexpand

Indique si la barre de menu doit être dépliée lors de l'affichage de l'éditeur. Dans le cas contraire, un petit bouton permet de la déplier.

Les valeurs possibles sont :

• yes (comportement par défaut)
• no

4.2.14 Type idoc

Document intégré. Obsolète

4.2.15 Type ifile

permet d'intégrer directement la visualisation d'un fichier. Obsolète (préférer une vue d'attribut lorsque nécessaire)

En consultation, cet attribut sera représenté par une iframe affichant le fichier en mode inline.

4.2.16 Type image

4.2.16.1 Description

Les attributs de type image permettent d'insérer une image.

4.2.16.2 Représentation

• consultation :

  une balise img alignée à droite.

  

  Figure 38. image - consultation html

  L'image affichée par défaut est une miniature de l'image (sauf si l'option iwidth=auto) au format png.
  3.2.20 Dans le cas d'image jpeg, la miniature est réorientée automatiquement en fonction des données exif de l'image. Par contre, si c'est l'image originale qui est affichée, elle n'est pas réorientée par le navigateur.
  Les navigateurs (pour l'instant) ne tiennent pas compte de l'orientation dans les tags image mais seulement lors de l'affichage direct sur une page.

• modification :

  Un input de type text présentant une miniature de l'image précédemment enregistrée et le nom du fichier, suivi de 3 boutons :

  • pour choisir un nouveau fichier image,
  • restaurer le fichier préalablement enregistré,
  • effacer le fichier image.
  

  Figure 39. image - Modification html

  Au survol de la miniature, une version plus grande est affichée.

  S'il s'agit d'une modification de document et que le fichier est déjà enregistré alors le clic sur le nom du fichier permet de télécharger l'image.

  Des différences de comportement sont présentes en fonction des navigateur. Sur IE < 11, le bouton original "Parcourir" est affiché lorsqu'on clique sur le bouton "...". Le paramètre applicatif "FDL_OLDFILEINPUTCOMPAT" indique si l'attribut doit présenter, de manière systématique, le bouton original "Parcourir"

  

  Figure 40. image - Modification html

• odt :

  Une image.

  

  Figure 41. image - consultation odt

4.2.16.3 Comportement

Lors de l'upload du fichier, il est enregistré dans le vault.

4.2.16.4 Format de stockage

La valeur stockée est l’identifiant vault du fichier (sous la forme <type-mime>|<vaultid>|<file-title>).

Le type utilisé en base de donnée est text.

4.2.16.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

hideindav

Indique si le fichier apparaît lors de l'accès au moyen du protocole webdav.

Les valeurs possibles sont :

• yes (comportement par défaut)
• no

inline

Indique si l'image' doit être consultée directement dans le navigateur. Dans le cas contraire, le téléchargement est forcé.

Les valeurs possibles sont :

• yes
• no(comportement par défaut)

iwidth

Indique la largeur de l'image dans l'interface web de consultation.

L'image est redimensionnée coté serveur, avec respect des proportions.

Les valeurs possibles sont:

• Une taille en pixels (par exemple 150px).
• auto (dans ce cas, l'image est affichée dans sa taille originale).

La valeur par défaut est 80px.

preventfilechange

Ajoute une contrainte pour que le fichier à remplacer provienne de la dernière version du serveur.

Cela ne bloque pas un changement de fichier mais avertit l'utilisateur dans le cas où le fichier ne correspond pas à cette dernière version.

Lors du téléchargement du fichier un code identifiant la version est ajouté dans le nom du fichier (exemple foo{i47307-56}.ods pour le fichier foo.ods). Lorsque l'utilisateur uploade à nouveau le fichier, le serveur vérifie ce numéro de version. Si le numéro correspond à la dernière version, alors le fichier est accepté. Dans le cas contraire, une confirmation est demandée à l'utilisateur.

Attention: si l'utilisateur renomme le fichier, la vérification échoue, et le serveur demande la confirmation.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

rn

Indique que le fichier sera renommé sur le serveur.

Les valeurs possibles sont :

• un nom de méthode de la famille courante (par exemple ::myNewName()). La méthode prend en entrée le nom du fichier et doit retourner le nouveau nom sous la forme d'une chaîne de caractères.

Note: Il est recommandé que la méthode fournisse une extension compatible avec le type mime pour l'utilisation ultérieure sur le poste client et les transformations. Pour récupérer l'extension d'un nom de fichier vous pouvez utiliser la fonction getFileExtension de la librairie Lib.FileMime.php

4.2.17 Type int

4.2.17.1 Description

Les attributs de type int permettent d'insérer un nombre entier sur 32 bits signés.

4.2.17.2 Représentation

• consultation :

  Le nombre, sans formatage.

  

  Figure 42. integer - consultation html

  Le formatage spécifique de int doit être conforme à celui utilisé dans la fonction sprintf. Par exemple int("%03d") pour avoir 3 chiffres.

• modification :

  Un input de type texte permettant de saisir le nombre.

  

  Figure 43. integer - Modification html

• odt :

  Le nombre, sans formatage

  

  Figure 44. integer - consultation odt

4.2.17.3 Comportement

3.2.18

Lors de la sauvegarde, les vérifications suivantes sont faites :

• Le nombre est un entier compris entre -2 147 483 648 et +2 147 483 647

4.2.17.4 Format de stockage

La valeur stockée est la valeur brute du nombre.

Le type utilisé en base de donnée est int. Si l'attribut est dans un tableau, le type en base donnée sera text.

4.2.17.5 Options

Options communes à tous les types d'attributs.

elabel

En plus du tooltip du label défini par les options communes pour elabel, Cette option affecte sa valeur sur l'attribut title du l'input correspondant.

Les valeurs possibles sont :

• Toute chaîne de caractères. Attention, la plupart des navigateurs n'acceptent pas de retour chariot.

4.2.18 Type longtext

4.2.18.1 Description

Les attributs de type longtext permettent de saisir du texte multilignes, sans mise en forme.

4.2.18.2 Représentation

• consultation :

  La valeur brute.

  

  Figure 45. longtext - consultation html

• modification :

  Un textarea.

  

  Figure 46. longtext - Modification html

• odt :

  La valeur brute.

  

  Figure 47. longtext - consultation odt

4.2.18.3 Comportement

Si un longtext est déclaré dans un tableau, les caractères <BR> sont remplacés par le caractère retour chariot \n lors de l'enregistrement.

4.2.18.4 Format de stockage

La valeur stockée est la valeur brute.

Le type utilisé en base de donnée est text.

4.2.18.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

editheight

Indique la hauteur du textarea correspondant.

Les valeurs possibles sont :

• une taille css valide (par exemple 400px)

La valeur par défaut est 2em

elabel

En plus du tooltip du label défini par les options communes pour elabel, Cette option affecte sa valeur sur l'attribut title du textarea correspondant.

Les valeurs possibles sont :

• Toute chaîne de caractères. Attention, la plupart des navigateurs n'acceptent pas de retour chariot.

4.2.19 Type menu

4.2.19.1 Description

Les attributs de type menu se présentent sous la forme de liens présent dans la barre de menu en haut du document.

Ces menus permettent d'accéder à des urls, et ainsi de déclencher des actions, etc.

L'url du menu est indiqué dans la caractéristique link.

Cette caractéristique supporte, en plus des notations standards, la notation :

::myMethod()

Cette notation permet d'appeler directement une méthode exposée de la famille. L'appel de cette méthode retourne la page de consultation de document mis à jour.

La méthode appelée doit avoit le tag @apiExpose dans le commentaire associée afin de la rendre exposable. Cette méthode doit assurer elle-même les contrôles nécessaires à la sécurité du document.

4.2.19.2 Représentation

• consultation :

  Une entrée de menu supplémentaire.

  

  Figure 48. menu - consultation html

• modification :

  Aucune représentation.

• odt :

  Aucune représentation.

4.2.19.3 Comportement

Le menu n'est pas représenté dans les cas suivants:

• link est vide,
• la visibilité est H,
• le menu référence des attributs au moyen de la syntaxe <attrid> et un de ces attributs est vide (cela peut être contourné par l'utilisation de la syntaxe ?<attrid>).

4.2.19.4 Format de stockage

Cet attribut n'est pas stocké.

4.2.19.5 Visibilité

Le menu est soumis à la visibilité standard. Si la visibilité est H, ou si l'url est vide le menu n'est pas affiché.

Si le champ phpfunc indique une méthode, alors cette méthode sera utilisé pour avoir la visibilité du menu. Cette méthode outrepasse la visibilité indiqué dans l'attribut ou le masque. La méthode doit retourner une des constantes suivantes :

• MENU_ACTIVE : Le menu est visible et actif (cliquable)
• MENU_INVISIBLE : Le menu n'est pas visible
• MENU_INACTIVE : Le menu est visible mais il est inhibé (grisé)

Exemple :

Utilisation de la fonction ::menuResetLoginFailure() déclarée dans la colonne phpfunc :

class myFamily extends \Dcp\Family\Document
    public function menuResetLoginFailure()
    {
        // Do not show the menu if the user has no edit rights on the document
        if ($this->canEdit() != '') {
            return MENU_INACTIVE;
        }
        // Do not show the menu on the 'admin' user
        if ($this->getRawValue('us_whatid') == 1) {
            return MENU_INVISIBLE;
        }
        // Do not show the menu if the account has no failures
        if ($this->getRawValue("us_loginfailure") <= 0) {
            return MENU_INVISIBLE;
        }
        return MENU_ACTIVE;
    }
}

4.2.19.6 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

barmenu

Indique que la popup doit s'ouvrir avec la barre de menus du navigateur.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

global

Indique que l'action effectuée par le menu n'est pas liée à un document en particulier.

Dans ce cas, le menu apparaît aussi dans le menu 'outils' des applications issues de GENERIC, ainsi que dans le menu contextuel du document famille.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

lconfirm

Indique qu'une confirmation doit être demandée avant activation du lien.

Le texte de la confirmation est déterminé par l'option tconfirm.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

lcontrol

Indique que le menu est disponible uniquement dans le menu contextuel du document, lorsque la touche control est appuyée.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

mheight

Indique la hauteur de la fenêtre popup.

Les valeurs possibles sont :

• toute hauteur en pixels (par exemple 400px)

La valeur par défaut est 300px

mtarget

Indique le name de la fenêtre cible de l'hyperlien.

Les valeurs possibles sont :

• _blank (comportement par défaut) : Dans ce cas, la fenêtre cible est une nouvelle fenêtre ;
• _self : Dans ce cas, la fenêtre cible est la fenêtre en cours ;
• fhidden : Dans ce cas, la fenêtre cible est une fenêtre cachée ;
• fdoc : Dans l'application ONEFAM, la fenêtre cible est la fenêtre dans laquelle est affiché le document (utile pour les menus avec l'option global) ;
• tout nom de fenêtre valide.

mwidth

Indique la largeur de la fenêtre popup.

Les valeurs possibles sont :

• toute largeur en pixels (par exemple 400px)

La valeur par défaut est 400px

onlyglobal

Utilisé conjointement avec l'option global, indique que le menu ne doit pas apparaître sur le document.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

submenu

Indique que le menu doit avoir un menu parent.

Les valeurs possibles sont :

• toute chaîne alphanumérique.

tconfirm

Indique la question apparaissant pour la confirmation (ce doit être une question fermée).

Cette question est automatiquement ajoutée au catalogue de traduction.

Les valeurs possibles sont :

• toute chaîne de caractères.

La valeur par défaut est Êtes-vous sûr ?

4.2.20 Type money

4.2.20.1 Description

Permet de représenter un format monétaire.

4.2.20.2 Représentation

• consultation :

  Le nombre, formaté au moyen de la fonction money_format('%!.2n', …).

  

  Figure 49. money - consultation html

  Le formatage spécifique de money doit être conforme à celui utilisé dans la fonction sprintf. Par contre, il faut utiliser %s et non %f car le résultat donné à la fonction de formatage est ce qui est produit par money_format.

  Par exemple money("%s €") pour ajouter la devise de l'euro.

• modification :

  un input de type texte permettant de saisir le nombre.

  

  Figure 50. money - Modification html

• odt :

  Le nombre, formaté au moyen de la fonction money_format('%!.2n', ).

  

  Figure 51. money - consultation odt

4.2.20.3 Comportement

Lors de l'enregistrement, le nettoyage suivant est effectué :

• remplacement des , par .
• suppression des espaces

La valeur nettoyée est validée au moyen de la fonction is_numeric.

4.2.20.4 Format de stockage

La valeur stockée est la valeur nettoyée.

Le type utilisé en base de donnée est double.

4.2.20.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

4.2.21 Type password

4.2.21.1 Description

Les attributs de type password permettent d'insérer des valeurs sans en dévoiler le contenu.

4.2.21.2 Représentation

• consultation :

  3.2.19La valeur du mot de passe est remplacée par 5 étoiles.

  

  Figure 52. password - consultation html

• modification :

  Un input de type password. Le mot de passe n'est pas indiqué même s'il est déjà renseigné.

  

  Figure 53. password - Modification html

• odt :

  Aucune représentation

4.2.21.3 Comportement

En édition, le champ password est systématiquement présenté vide. Lors de la sauvegarde, si la valeur est vide, alors l'ancienne valeur est conservée. Pour l'effacer, il faut mettre un seul caractère espace dans le champ.

4.2.21.4 Format de stockage

La valeur stockée est la valeur brute.

Le type utilisé en base de donnée est text.

4.2.21.5 Options

Options communes à tous les types d'attributs.

Ce type d'attribut ne dispose d'aucune option spécifique.

4.2.22 Type tab

4.2.22.1 Description

Les attributs de type tab permettent de créer des onglets.

4.2.22.2 Représentation

• consultation :

  Un onglet.

  

  Figure 54. tab - consultation html

Note : Lors de l'impression d'un document, les onglets sont présentés comme des titres de paragraphes.
 

• modification :

  Un onglet.

  

  Figure 55. tab - Modification html

• odt :

  Aucune représentation

4.2.22.3 Comportement

Aucun comportement particulier.

4.2.22.4 Format de stockage

Cet attribut n'est pas stocké.

4.2.22.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

viewonfly

Indique que le contenu du tab est chargé en ajax lorsque l'utilisateur clique sur l'onglet. Cela réduit le temps de réponse pour les documents ayant de très nombreux attributs (plusieurs centaines).

Cela n'est applicable que pour les vues utilisant la zone FDL:VIEWBODYCARD. Les actions utilisant cette zone sont :

• FDL:FDL_CARD,
• FDL:IMPCARD,
• FDL:OPENDOC,
• FDL:VIEWEXTDOC.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

firstopen

Indique que cet onglet doit être sélectionné à l'ouverture du document.

Cela n'est applicable que pour les vues utilisant les zones FDL:VIEWBODYCARD et FDL:EDITBODYCARD. Les actions utilisant cette zone sont :

• FDL:FDL_CARD,
• FDL:IMPCARD,
• FDL:OPENDOC,
• FDL:VIEWEXTDOC,
• *GENERIC:GENER

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

4.2.23 Type text

4.2.23.1 Description

Les attributs de type text permettent d'insérer du texte simple, sur une seule ligne.

4.2.23.2 Représentation

• consultation :

  La valeur brute.

  

  Figure 56. text - consultation html

• modification :

  un input de type text.

  

  Figure 57. text - Modification html

• odt :

  La valeur brute.

  

  Figure 58. text - consultation odt

4.2.23.3 Comportement

Lors de la sauvegarde, la valeur est nettoyée :

• le caractère "\r" est remplacé par " " (espace).

4.2.23.4 Format de stockage

La valeur stockée est la valeur nettoyée.

Le type utilisé en base de donnée est text.

4.2.23.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

elabel

En plus du tooltip du label défini par les options communes pour elabel, cette option affecte sa valeur sur l'attribut title de l'input correspondant.

Les valeurs possibles sont :

• Toute chaîne de caractères. Attention, la plupart des navigateurs n'acceptent pas de retour chariot.

esize

Valeur de l'attribut @size de l'input correspondant.

Les valeurs possibles sont :

• Toute valeur entière.

4.2.24 Type thésaurus

4.2.24.1 Description

Les attributs de type thesaurus permettent de faire des relations vers des descripteurs de thésaurus.

Ce type d'attribut est à utiliser avec le module dynacase-thesaurus.

4.2.24.2 Représentation

• consultation :

Identique au type `docid`.

• modification :

une aide à la saisie indiquant une arborescence vers les descripteurs de thésaurus.

4.2.24.3 Comportement

4.2.24.4 Format de stockage

La valeur stockée est l'identifiant interne du descripteur.

Le type utilisé en base de donnée est text.

4.2.24.5 Options

Options communes à tous les types d'attributs.

Ce type d'attribut ne dispose d'aucune option spécifique.

4.2.25 Type time

4.2.25.1 Description

Les attributs de type time permettent d'insérer une heure.

4.2.25.2 Représentation

• consultation :

  La valeur brute.

  

  Figure 59. time - consultation html

L'heure peut avoir un format particulier en utilisant la notation de [strftime][PHP_strftime].
 
Exemple : `date("%H heures %M minutes %S secondes")` pour afficher
 `15 heures 23 minutes 04 secondes`

• modification :

  2 inputs de type text, séparés par le symbole :. Du javascript transforme les entrées pour en faire des heures valides (les nombres sont remplacés par leur modulo respectif avec 24 et 60, et les autres valeurs sont remplacées par 00).

  

  Figure 60. time - modification time

• odt :

  La valeur brute.

  

  Figure 61. time - consultation odt

4.2.25.3 Comportement

Lors de la sauvegarde, l'heure doit être comprise entre 0 et 23, les minutes entre 0 et 59 et les secondes facultatives entre 0 et 59.

La valeur est vérifiée, et doit correspondre à un des formats suivants :

• .\d\d?:.\d\d?
• .\d\d?:.\d\d?:.\d\d?

4.2.25.4 Format de stockage

La valeur stockée est la valeur nettoyée.

Le type utilisé en base de donnée est time. Si l'attribut est dans un tableau, le type en base donnée sera text.

4.2.25.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

4.2.26 Type timestamp

4.2.26.1 Description

Les attributs de type timestamp permettent d'insérer une date et heure.

4.2.26.2 Représentation

• consultation :

  La date et heure formatée en accord avec la locale de l'utilisateur.

  

  Figure 62. timestamp - consultation html

La date peut avoir un format particulier en utilisant la notation de [strftime][PHP_strftime].
 
Exemple : `date("%A %e %B %y à %H heures %M minutes")` pour afficher
 `vendredi 17 mai 2013 à 15 heures 23 minutes`

• modification :

  date picker avec possibilité de définir l'heure.

  

  Figure 63. timestamp - Modification html

• odt :

  La date et heure formatée en accord avec la locale de l'utilisateur.

  

  Figure 64. timestamp - consultation odt

4.2.26.3 Comportement

Lors de la saisie, la valeur est validée, c'est à dire que le format doit être :

• soit au format « français » ;
• soit au format « US » ;
• soit au format ISO8601.

4.2.26.4 Format de stockage

La date est stockée au format ISO8601 « sans T » (yyyy-mm-dd hh:mm:ss).

Le type utilisé en base de donnée est timestamp without timezone. Si l'attribut est dans un tableau, le type en base donnée sera text.

4.2.26.5 Options

options communes à tous les types d'attributs.

Ce type d'attribut ne dispose d'aucune option spécifique.

4.2.27 type xml

4.2.27.1 Description

Le type *XML n'est utilisable que pour des besoins internes de core. Seule la famille "SEARCH" l'utilise.

4.2.27.2 Représentation

Les attributs de type xml sont représentés comme du texte simple.

Le type utilisé en base de donnée est text.

4.2.27.3 Options

Options communes à tous les types d'attributs.

Ce type d'attribut ne dispose d'aucune option spécifique.

4.3 Visibilité des attributs

La visibilité d'un attribut est une caractéristique de présentation de sa valeur.

Seule la visibilité I permet d'ajouter un contrôle d'accès à la valeur. Les autres visibilités ne contrôle pas l'accès mais seulement la présentation de la valeur.

Les différentes visibilités disponibles sont les suivantes :

H

Attribut caché : présent dans la dom, il ne sera pas affiché.

I

Attribut invisible : cet attribut n'est accessible ni par l'IHM, ni par le code (pour le modifier par le code, il faut au préalable modifier explicitement sa visibilité). Cette visibilité est utilisée pour les importations, exportations et le format de collection de document.

O

Attribut visible en modification uniquement, et modifiable.

R

Attribut visible uniquement en consultation.

S

Attribut visible en consultation et en modification, mais non modifiable.

U (applicable uniquement au type array)

Array affiché en consultation et en modification, mais dont le nombre de lignes ne peut pas être modifié.

W

Attribut visible en consultation et en modification, et modifiable

Il est important de distinguer la visibilité et les droits : La visibilité n'offre pas de protection contre l'accès à l'information sauf pour la visibilité I.

4.3.1 Visibilité des attributs structurants

Les visibilités des attributs structurants impactent celle des attributs qu'ils contiennent. Ainsi, par exemple, un attribut W dans un cadre H sera en fait en H. Voici la table qui récapitule ces cas :

Les tableaux en visibilité U sont transparents lors de cette propagation. Pour les attributs contenus dans un tableau en visibilité U, il faut donc regarder l'attribut structurant du-dit tableau.

4.4 Les paramètres de famille

4.4.1 Présentation

Un paramètre de famille est une valeur stockée sur la famille directement, et accessible depuis tous les documents de cette famille.

Ils sont assimilables à des propriétés de classe (ou propriétés statiques) en programmation orientée objet, même si l'implémentation en diffère.

Ils peuvent être soumis à des contraintes. Dans ce cas, la méthode doit être statique.

Un paramètre de famille peut également être dynamique, lorsqu'il est défini par une méthode statique. Dans ce cas, la méthode doit être statique et sera lancée à chaque récupération du paramètre.

4.4.2 Exemple d'utilisation

Imaginons que l'on veuille calculer une référence unique pour tous les documents de la famille compte-rendu. Cette référence doit être sous la forme [PREFIXE] - [chrono] où [PREFIXE] est un préfixe commun à tous les documents, et [chrono] est un numéro chrono (incrémenté de 1 à chaque nouveau document).

Le préfixe étant commun à tous les documents, on le stockera sous la forme d'un paramètre de famille. Cela évite de devoir le stocker dans le code, ce qui rend ce préfixe paramétrable sans redéploiement.

4.5 Les attributs calculés

4.5.1 Présentation

Un attribut calculé est un attribut dont la valeur est calculée par Dynacase. Ce calcul est effectué à chaque appel de la méthode Doc::refresh(), qui est appelée très fréquemment sur les documents. Dans de nombreux cas, il sera préférable d'utiliser les hooks du document (en particulier Doc::postStore).

Le calcul de l'attribut peut être

• local

  Par exemple : attr_c = attr_a * attr_b

• global

  Par exemple : attr_d = nombre de documents du même auteur

• externe

  Par exemple : attr_e = quantité en stock dans l'ERP

Ce calcul peut être effectué au moyen :

• d'une méthode publique de la classe du document contenant l'attribut,
• d'une méthode statique d'une autre classe.

Elle doit retourner un résultat sous forme d'une chaîne de caractères. Le résultat est mis dans l'attribut sur lequel s'applique le calcul (sauf redirection explicite faite lors de la déclaration de l'attribut).

Le calcul est effectué lors du rafraîchissement des documents (voir la méthode Doc::refresh()).

Les attributs en visibilité I ne sont pas modifiés lors de l'actualisation. Pour que ces attributs soit modifiés, il est nécessaire qu'un contrôle de vue modifie cette visibilité pour l'utilisateur courant. Si l'attribut est en visibilité I au moment du calcul, un message d'avertissement sera écrit dans les logs système.

D'un point de vue utilisateur, un attribut calculé est rafraîchi avant chaque consultation de document.

4.5.2 Syntaxe

La syntaxe définissant les attributs calculés est la suivante :

Ce qui donne en BNF :

computeMethod   ::= callMethod ( ( ':' targetAttributeName ) |  )
 
callMethod      ::= ( staticClass |  ) '::' methodName '(' ( methodInputs |  ) ')'
 
methodInputs    ::= methodInput ( ',' methodInput )*
 
methodInput     ::= '<spaces>'* ( sourceAttributeName | familyParameterName | text | keyWord ) '<spaces>'*
 
text            ::= ( "'" '<text>' ) | ( "'" "[^',]+" "'" ) | ( '"' '[^",]+' '"' )
 
keyWord         ::= 'THIS' | 'K'

avec les éléments suivants :

targetAttributeName

Un nom d'attribut existant dans la famille.

Le résultat de la méthode sera affecté à cet attribut.

Si targetAttributeName n'est pas renseigné, alors c'est l'attribut sur lequel est définie la méthode de calcul qui reçoit la valeur.

sourceAttributeName

Un nom d'attribut existant dans la famille.

La méthode de calcul recevra la valeur de l'attribut au moment de l'appel.

Lorsque attributeName est dans un array, alors la valeur passée est :

• la valeur sur la même ligne si l'attribut calculé est dans le même tableau
• la valeur de la colonne (sous la forme d'un tableau php) si l'attribut calculé est en dehors du tableau
• la valeur sur la même ligne si l'attribut est dans un autre tableau, ce qui peut conduire à des comportements surprenants.

familyParametername

Un nom de paramètre existant dans la famille.

La fonction de calcul recevra la valeur du paramètre au moment de l'appel.

keyWord

Un mot clé qui est remplacé par une valeur dynamique

THIS

L'objet du document en cours.

Cela est utile dans le cas d'un appel à une méthode statique.

K

L'index de la ligne en cours si l'attribut est dans un tableau.

Si l'attribut n'est pas dans un tableau, la valeur passée est -1

4.5.3 Exemples

4.5.3.1 Calcul d'un prix total

Extrait de la définition de la famille

Extrait du fichier de méthodes associé

public function computePrice($qte, $price){
    return intval($qte) * floatval($price);
}

Note: on pourrait aussi utiliser une méthode statique, qui aurait sûrement plus de sens ici :

class MathUtils {
    public static function mult($a, $b){
        return floatval($a) * floatval($b);
    }
}

4.6 Les contraintes

4.6.1 Présentation

Une contrainte permet de valider la saisie de l'utilisateur avant que le document soit enregistré.

La contrainte est vérifiée au moyen :

• soit d'une méthode publique de la classe du document contenant l'attribut,
• soit d'une méthode statique d'une autre classe.

Son retour doit être :

• soit une chaîne de caractères utilisée comme message d'erreur,
• soit un tableau associatif contenant
  • un message d'erreur à l'index err
  • un tableau de suggestions à l'index sug

Les suggestions seront proposées à l'utilisateur en remplacement de la valeur refusée par la contrainte.

Les contraintes sont aussi vérifiées lors de l'appel à la méthode Doc::store(). Un paramètre optionnel à cette méthode permet de ne pas vérifier les contraintes.

4.6.2 Syntaxe

La syntaxe définissant les contraintes est la suivante :

Ce qui donne en BNF :

constraint      ::= ( staticClass |  ) '::' methodName '(' ( methodInputs |  ) ')'
 
methodInputs    ::= methodInput ( ',' methodInput )*
 
methodInput     ::= '<spaces>'* ( sourceAttributeName | familyParameterName | text | keyWord ) '<spaces>'*
 
text            ::= ( "'" '<text>' ) | ( "'" "[^',]+" "'" ) | ( '"' '[^",]+' '"' )
 
keyWord         ::= 'THIS' | 'K'

avec les éléments suivants :

sourceAttributeName

Un nom d'attribut existant dans la famille.

La méthode de la contrainte recevra la valeur de l'attribut au moment de l'appel.

Lorsque attributeName est dans un array, alors la valeur passée est :

• la valeur sur la même ligne si l'attribut sur lequel est définie la contrainte est dans le même tableau
• la valeur de la colonne (sous la forme d'un tableau php) si l'attribut sur lequel est définie la contrainte est en dehors du tableau
• la valeur sur la même ligne si l'attribut est dans un autre tableau, ce qui peut conduire à des comportements surprenants.

Lorsque attributeName est un attribut structurant (e.g. array, frame, etc.), alors la valeur passée est une chaîne vide.

familyParametername

Un nom de paramètre existant dans la famille.

La contrainte recevra la valeur du paramètre au moment de l'appel.

keyWord

Un mot clé qui est remplacé par une valeur dynamique

THIS

L'objet du document en cours.

Cela est utile dans le cas d'un appel à une méthode statique.

K

L'index de la ligne en cours si l'attribut est dans un tableau.

Si l'attribut n'est pas dans un tableau, la valeur passée est -1

4.6.3 Exemples

4.6.3.1 Vérification du format d'un entier

<?php
 
Class GenericConstraints{
 
    public static function isInt($value, $min=0, $max=PHP_INT_MAX, $customErrorMessage=''){
        $options = array(
            'options' => array(
                'min_range' => $min,
                'max_range' => $max
            );
        );
        if(false === filter_var($value, FILTER_VALIDATE_INT, $options)){
            if('' === $customErrorMessage){
                $customErrorMessage = "GenericConstraints:%s is not an integer between %s and %s";
            }
            return sprintf(_($customErrorMessage), $value, $min, $max);
        }
        return '';
    }
}
 
?>

4.7 Les aides à la saisie

4.7.1 Présentation

Une aide à la saisie permet de compléter ou de remplir des zones de saisie lors de la modification d'un document, en proposant des suggestions à l'utilisateur.

Les suggestions sont calculées au moyen d'une fonction qui doit être définie dans un fichier php placé dans le répertoire /EXTERNALS/ du contexte.

Elle doit retourner un résultat sous la forme d'un tableau à 2 dimensions :

• la première dimension correspond à la liste des suggestions ;

• la seconde dimension correspond à la liste des valeurs à insérer dans le document lors du choix de cette suggestion.

  Elle est traitée de manière positionnelle :

  • La première valeur est affichée en tant que suggestion pour l'utilisateur ;
  • les valeurs suivantes sont dépilées et affectées dans l'ordre aux attributs cible.

Elle peut également retourner une chaîne de caractères, qui servira de message d'erreur.

4.7.2 Syntaxe

La syntaxe définissant les aides à la saisie est la suivante :

Ce qui donne en BNF :

inputHelp       ::= funcName '(' ( funcInputs |  ) ')' ':' funcOutputs
 
funcInputs      ::= funcInput ( ',' funcInput )*
 
funcInput       ::= '<spaces>'* ( sourceAttributeName | familyParameterName | text | sourceKeyWord | propertyName | '{' appParameterName '}' | '{' familyName '}' ) '<spaces>'*
 
funcOutputs     ::= funcOutput ( ',' funcOutput )*
 
funcOutput      ::= ( targetAttributeName | targetKeyWord )
 
text            ::= ( "'" '<text>' ) | ( "'" "[^',]+" "'" ) | ( '"' '[^",]+' '"' )
 
sourceKeyWord   ::= ( 'CT' | 'CT' '[' relationAttributeName ']' | 'D' | 'I' | 'K' | 'T' | 'A' )
 
targetKeyWord   ::= ( 'CT' | 'CT' '[' relationAttributeName ']' )

avec les éléments suivants :

sourceAttributeName

Un nom d'attribut existant dans la famille.

La fonction de calcul recevra la valeur de l'attribut au moment de l'appel.

Lorsque attributeName est dans un array, alors la valeur passée est :

• la valeur sur la même ligne si l'attribut sur lequel est définie l'aide à la saisie est dans le même tableau,
• la valeur de la colonne (sous la forme d'un tableau php) si l'attribut sur lequel est définie l'aide à la saisie est en dehors du tableau
• la valeur sur la même ligne si l'attribut est dans un autre tableau, ce qui peut conduire à des comportements surprenants.

familyParametername

Un nom de paramètre existant dans la famille.

La fonction de calcul recevra la valeur du paramètre au moment de l'appel.

sourceKeyWord

Un mot clé qui est remplacé par une valeur dynamique.

CT[relationAttributeName]

La valeur de l'input correspondant à la relation relationAttributeName.

Lorsque l'id est rempli, cela correspond au titre du document cible, sinon cela correspond au texte saisi dans cet input.

CT

Raccourci pour CT[currentAttributeName] (où currentAttributeName est le nom de l'attribut sur lequel est définie l'aide à la saisie).

Ne peut être utilisé que sur les attributs de type relation.

D

Accès à la base de données.

I

Id du document courant.

K

L'index de la ligne en cours si l'attribut est dans un tableau.

Si l'attribut n'est pas dans un tableau, la valeur passée est -1

T

L'objet php correspondant au document en cours.

L'objet récupéré est le document tel qu'il est en base de donnée.

A

L'action courante (un objet de la classe Action).

Cela permet, par exemple, de récupérer des informations sur l'utilisateur courant.

propertyName

Une propriété du document.

Elle sera remplacée par sa valeur.

appParameterName

Un paramètre applicatif.

Ce paramètre doit obligatoirement être global.

familyName

Un nom logique de famille.

Il sera remplacé par son id.

targetAttributeName

Un nom d'attribut existant dans la famille.

Lors du choix d'une des suggestions, les valeurs correspondant à ces suggestions sont insérées dans l'ordre dans les attributs désignés par targetAttributeName

targetKeyWord

Un mot clé désignant la cible de l'aide à la saisie.

CT[relationAttributeName]

L'input correspondant à la relation relationAttributeName.

CT

Raccourci pour CT[currentAttributeName] (où *currentAttributeName est le nom de l'attribut sur lequel est définie l'aide à la saisie).

?

permet de "sauter" une des valeurs de retour sans l'utiliser.

Est particulièrement utile dans le cas d'aides à la saisie génériques qui retournent plus de valeurs que d'attributs à compléter.

4.7.3 Exemples

4.7.3.1 Retour unique

<?php
/**
 * EXTERNALS/cities.php
 */
 
function getCities($userInput=''){
    $suggestions = array();
    // Liste des villes utilisables
    $availableCities = array(
        "Paris",
        "Toulouse",
        "Souillac"
    );
    //teste si les villes correspondent à la saisie de l'utilisateur
    foreach($availableCities as $city){
        if( ''===$userInput || preg_match(strToLower($userInput), strToLower($city)) ){
            $suggestions[] = array(
                $city,      //le nom de la suggestion
                $city       //la valeur qui ira dans attr_city
            );
        }
    }
    return $suggestions;
}
 
?>

4.7.3.2 Retour multiple

<?php
/**
 * EXTERNALS/cities.php
 */
 
function getCedex($userInput=''){
    $suggestions = array();
    // Liste des villes utilisables
    $availableCities = array(
        "75000" => "Paris",
        "31000" => "Toulouse",
        "46200" => "Souillac"
    );
    //teste si les villes correspondent à la saisie de l'utilisateur
    foreach($availableCities as $cedex => $city){
        if( ''===$userInput || preg_match($userInput, $cedex) ){
            $suggestions[] = array(
                sprintf("[%d] %s", $cedex, $city),      //le nom de la suggestion
                $cedex,                                 //la valeur qui ira dans attr_cedex
                $city                                   //la valeur qui ira dans attr_city
            );
        }
    }
    return $suggestions;
}
 
?>

4.7.4 Astuces

4.7.4.1 attributs relation

• Lorsqu'une aide à la saisie remplit un attribut de type docid, il faut penser à remplir l'id et le titre affiché (attrid et CT[attrid]).
• Lorsqu'un attribut est masqué (visibilité R ou H), alors le champ désigné par CT[attrid] n'existe pas, il est donc impossible de les désigner comme retour des aides à la saisie.

4.7.4.2 attributs htmltext

• Lorsqu'un attribut de type htmltext est utilisé en entrée d'une aide à la saisie, la valeur reçue est encodée. il est donc nécessaire de la décoder (au moyen de html_entity_decode)

4.8 Déclaration de familles

4.8.1 Introduction

Pour ajouter des familles de document à Dynacase, on va utiliser divers formats de fichier :

• Les familles seront définies dans des fichiers csv ;
• Le code php sera à déployer dans des fichiers php, à intégrer à la plate-forme ;
• Les documents systèmes seront importés au moyen de fichiers csv ou xml.

4.8.2 Définition de familles

Les familles sont définies dans un fichier csv respectant le format suivant :

• Encodage : UTF-8,
• Délimiteur de texte : (vide),
• séparateur de colonnes : ;.

Exemple de définition d'une famille :

BEGIN;;Animal;;;ZOO_ANIMAL;;;;;;;;;;;
//;properties;;;;;;;;;;;;;;;
//propid;value;;;;;;;;;;;;;;;
ICON;zoo_animal.png;;;;
CLASS;Zoo\Zoo_animal;;;;
DFLDID;FLD_ZOO_ANIMAL;;;;
;;;;;;;;;;;;;;;;
//;attributes;;;;;;;;;;;;;;;
//;idattr;idframe;label;T;A;type;ord;vis;need;link;phpfile;phpfunc;elink;constraint;option;Commentaires
;;;;;;;;;;;;;;;;
ATTR;AN_IDENTIFICATION;;Identification;N;N;frame;::auto;W;;;;;;;;
ATTR;AN_NOM;AN_IDENTIFICATION;nom;Y;N;text;::auto;W;Y;;;;;;edittemplate=ZOO:ANIMALNAME:U|viewtemplate=ZOO:ANIMALNAME;
ATTR;AN_TATOUAGE;AN_IDENTIFICATION;tatouage;N;N;int;::auto;W;;;;;;;edittemplate=ZOO:ANIMALTATOO:S|viewtemplate=ZOO:ANIMALTATOO:S;
ATTR;AN_ESPECE;AN_IDENTIFICATION;espèce;N;N;docid("ZOO_ESPECE");::auto;W;Y;;;;;;creation={es_nom:CT}|doctitle=an_espece_title;
ATTR;AN_ESPECE_TITLE;AN_IDENTIFICATION;espèce (titre);Y;N;text;::auto;H;;;;::getTitle(an_espece);;;;
ATTR;AN_ORDRE;AN_IDENTIFICATION;ordre;N;N;text;::auto;R;;;;::getdocvalue(an_espece,es_ordre);;;;
ATTR;AN_CLASSE;AN_IDENTIFICATION;classe;N;N;docid("ZOO_CLASSE");::auto;R;;;;::getdocvalue( an_espece , es_classe);;;doctitle=auto;
ATTR;AN_SEXE;AN_IDENTIFICATION;sexe;N;N;enum;::auto;W;;;;M|Masculin,F|Féminin,H|Hermaphrodite;;;;
ATTR;AN_PHOTO;AN_IDENTIFICATION;photo;N;N;image;::auto;W;;;;;;;;
ATTR;AN_NAISSANCE;AN_IDENTIFICATION;date naissance;N;N;date;::auto;W;;;;;;::validatePastDate(AN_NAISSANCE);;
ATTR;AN_ENTREE;AN_IDENTIFICATION;date entree;N;N;date;::auto;W;;;;;;::validatePastDate(AN_ENTREE);;
ATTR;AN_ENFANT_T;AN_IDENTIFICATION;liste enfant;N;N;array;::auto;W;;;;;;;;
ATTR;AN_ENFANT;AN_ENFANT_T;enfant;N;N;docid("ZOO_ANIMAL");::auto;W;;;;;;;creation={an_nom:CT,an_espece:an_espece};
ATTR;AN_CARNETSANTE;AN_IDENTIFICATION;Carnet Santé;N;N;menu;::auto;W;;%S%app=GENERIC&action=GENERIC_ISEARCH&id=%I%&famid=ZOO_CARNETSANTE&viewone=Y;;;;;;
ATTR;AN_ENCLOS;AN_IDENTIFICATION;Enclos;N;N;menu;::auto;W;;%S%app=GENERIC&action=GENERIC_ISEARCH&id=%I%&famid=ZOO_ENCLOS&viewone=Y;;;;;;
ATTR;AN_PARENT;AN_IDENTIFICATION;Parents;N;N;menu;::auto;W;;%S%app=GENERIC&action=GENERIC_ISEARCH&generic=Y&id=%I%&famid=ZOO_ANIMAL;;;;;;
ATTR;AN_PERE;AN_IDENTIFICATION;pere;N;Y;docid("ZOO_ANIMAL");::auto;R;;;;::getAscendant(M);;;doctitle=auto
ATTR;AN_MERE;AN_IDENTIFICATION;mere;N;Y;docid("ZOO_ANIMAL");::auto;R;;;;::getAscendant(F);;;doctitle=auto
ATTR;AN_FOLDER;;Dossier;N;N;menu;::auto;W;;%S%app=ZOO&action=ZOO_ANIMALFOLDER&id=%I%;;;;;
;;;;;;;;;;;;;;;;
END;;;;;;;;;;;;;;;;

Note : Le format ODS (openDocument Spread Sheet) peut aussi être utilisé comme format de fichier d'importation de famille ou de document.

Ce qui donne, vu dans un tableau :

La définition d'une famille commence toujours par une ligne de la forme :

BEGIN;[fromid];[title];[id];[className];[logicalName]

et se termine toujours par une ligne de la forme :

END;

avec les correspondances suivantes:

BEGIN

Obligatoire, signale le début d'une définition de famille.

[fromid]

Identifiant logique (nom logique ou identifiant interne numérique) de la famille de laquelle cette famille hérite.

Laisser vide s'il n'y a pas d'héritage.

L'utilisation d'un identifiant interne numérique à la place d'un nom logique est à réserver aux familles de core.

[title]

Titre de la famille.

Ce titre est utilisé sur les IHM pour désigner la famille.

Il est automatiquement ajouté au catalogue de traduction, et peut ainsi être traduit.

[id]

Identifiant numérique de la famille.

Laisser vide pour utiliser un identifiant logique (Dans ce cas, Dynacase affectera automatiquement un identifiant interne unique à la famille).

S'il est renseigné, il faut que cet identifiant ne soit pas déjà pris par un autre document.

Les valeurs entre 900 et 999 peuvent être utilisée pour vos besoins spécifiques, bien que l'usage de valeurs numériques fixes soit fortement déconseillée.

[className] (déprécié)

Nom de la classe PHP utilisée pour cette famille.

Cette classe doit être présente sur le serveur dans un fichier appelé /FDL/Class.[CLASSNAME].php.

Permet un héritage autre que celui prévu par défaut par les classes documentaires.

L'utilisation de la propriété CLASS permet de réaliser cette fonctionnalité.

Pour supprimer cette propriété, il faut mettre deux tirets -- comme valeur. Si la valeur est vide, la propriété conserve son ancienne valeur.

[logicalName]

Nom logique de la famille.

Doit commencer par une lettre. Il ne peut ensuite contenir que des caractères alphanumériques ainsi que les caractères _ et - (pas d'espace, ni de ponctuation).

END

Obligatoire, signale la fin d'une définition de famille.

Entre ces 2 lignes, chacune des lignes correspond à :

• un paramètre de propriété,
• une propriété de famille,
• un attribut,
• un paramètre de famille,
• une valeur par défaut,
• une valeur initiale de paramètre,
• une modification d'attribut père,
• une instruction de réinitialisation,

• un commentaire.

  Une ligne qui ne sera pas traitée lors du traitement de la définition de famille.

  Un commentaire commence toujours par //. Par exemple : // Ceci est un commentaire;;;;;;;;;;;;;;;;

4.8.2.1 Définition de paramètres de propriété

Des paramètres permettent de modifier le comportement des propriétés du document.

Leur syntaxe est toujours de la forme PROP;[propid];[param], avec les correspondances suivantes :

[propid]

Nom de la propriété.

[param]

Définition du paramètre, sous la forme [parameterName]=[parameterValue].

Par exemple :

PROP;title;sort=asc

Les paramètres de propriété disponibles sont :

sort

Permet de spécifier si la propriété est disponible dans les recherches et les rapports, et quel est son ordre de tri par défaut.

Les valeurs possibles sont :

• no : la propriété n'apparaîtra pas dans les recherches et rapports ;
• asc : la propriété est disponible dans les recherches et les rapports ; et est trié par défaut par ordre ascendant ;
• desc : la propriété est disponible dans les recherches et les rapports ; et est trié par défaut par ordre descendant.

Les propriétés suivantes ont un paramètre sort par défaut :

• initid : sort=desc,
• revdate : sort=desc,
• state : sort=asc,
• title : sort=asc

Les autres propriétés sont par défaut à sort=no.

4.8.2.2 Définition de propriétés de famille

Les propriétés de famille permettent, selon les cas, de définir un comportement particulier pour la famille, ou de définir les valeurs par défaut des propriétés des nouveaux documents de cette famille.

Leur syntaxe est toujours de la forme [propid];[value], avec les correspondances suivantes :

[propid]

Identifiant de la propriété.

[value]

Valeur de la propriété.

Les différents identifiants de propriété sont les suivants :

CPROFID

Indique le profil utilisé pour les documents créé avec cette famille. Affecte la valeur de la propriété profid pour les nouveaux documents de cette famille.
Contient l'identifiant d'un document profil.

Lors de l'importation, les vérifications suivantes sont effectuées :

• Si la famille hérite de dossier, le profil référencé doit être de la famille profil de dossier ;
• Si la famille hérite de recherche, le profil référencé doit être de la famille profil de recherche, ;
• Sinon le profil référencé doit être de la famille profil de document.

Si la valeur est vide le profil de document par défaut est enlevé.

Note : Cette propriété ne modifie pas les profils des documents de cette famille qui sont déjà créés au moment de la mise à jour de la famille.

CVID

Indique le contrôle de vue qui sera associé aux documents créés avec cette famille. Affecte la valeur de la propriété cvid pour les nouveaux documents de cette famille.
Contient l'identifiant d'un document contrôle de vue.

Lors de l'importation, les vérifications suivantes sont effectuées :

• Ce document doit être de la famille contrôle de vue.
• Ce contrôle de vue doit être applicable à la famille en cours.

Si la valeur est vide le contrôle de vue par défaut est enlevé.

Note : Cette propriété ne modifie pas les contrôles de vue des documents de cette famille qui sont déjà créés au moment de la mise à jour de la famille.

DFLDID

Identifiant du dossier principal permettant de constituer une arborescence spécifique à la famille .

Ce dossier est nécessaire pour manipuler les documents d'une famille depuis l'application "ONEFAM". Il peut être égal à auto, ce qui a pour effet de créer un dossier principal automatiquement. Ce dossier aura les restrictions indiquant que seuls des documents de cette famille et des dossiers pourront être insérés dans ce dossier principal.

Si cette propriété est déjà renseignée, deux cas de figure se présentent :

• La nouvelle valeur est 'auto' : Dans ce cas, l'ancienne valeur est conservée
• La nouvelle valeur n'est pas 'auto' : la nouvelle valeur est utilisée.

Si la valeur est vide le dossier principal par défaut est enlevé.

ICON

Nom du fichier image définissant l'icône de la famille.

Cette icône doit être une image carré. La taille conseillée varie de 48 à 128 pixels. Le format d'image conseillé est png. Les formats d'images supportés sont png et gif.

Si cette propriété est déjà renseignée, la nouvelle valeur ne sera pas prise en compte.

Si la famille n'a pas encore d'icône, alors la nouvelle valeur est prise en compte.

CLASS

Indique le nom de la classe métier utilisée par la famille.

Ce nom de classe doit être unique parmi l'ensemble des classes PHP utilisées sur le serveur. Il est recommandé d'utiliser un namespace afin d'éviter un conflit de nom.

Si la famille définie n'a pas de parent alors la classe métier doit étendre la classe Dcp\Family\Document. Cette classe est une classe héritant de la classe Doc.

Exemple :

BEGIN		Ma première famille		MY_FIRST
CLASS	My\MyFirstFamily
END

namespace My;
class MyFirstFamily extends \Dcp\Family\Document {
    public function myFirstProcedure($x) {
        return $x+1;
    }
}

Si la classe est utilisée avec une famille héritant d'une autre famille, cette classe doit hériter de la classe générée de la famille parente.

Exemple :

BEGIN	IMAGE	Photographie		MY_PHOTO
CLASS	My\MyPhotoFamily
ATTR	MYPHO_FR_INFO		Informations	N	N	frame	::auto
ATTR	MYPHO_EXIF	MYPHO_FR_INFO	Exif	N	N	longtext	::auto
END

namespace My;
class MyPhotoFamily extends \Dcp\Family\Image {
    public function postStore() {
        $err=parent::postStore();
        if (! $err) {
            if (! $this->getRawValue(\Dcp\AttributeIdentifiers\Image::img_file)) {
                $err=_("my::image needed");
            }
            if (! $this->getRawValue(\Dcp\AttributeIdentifiers\My\My_Photo::mypho_exif)) {
                $err=_("my::no exif detected");
            }
        }
        return $err;
    }
}

La classe peut étendre des classes intermédiaires, utiliser des interfaces ou des classes abstraites. La seule contrainte est que la classe générée de la famille parente doit faire partie de la hiérarchie de la classe métier. La classe générée de la famille hérite de cette classe. Elle apporte en plus la définition des attributs de la famille ainsi que le code généré pour les attributs calculés. Le nom de cette classe est \Dcp\Family\<nom de la famille>.

Hiérarchie de classe lorsque la famille MY_PHOTO est intégrée :

namespace Dcp\Core {
    // classe métier de la famille IMAGE
    class Images extends \Dcp\Family\Document {}
}
namespace Dcp\Family {
    // classe générée de la famille IMAGE
    class Images extends \Dcp\CoreFamily\Image {}
}
namespace My {
    // classe métier de la famille MY_PHOTO
    class MyPhotoFamily extends \Dcp\Family\Image {}
}
namespace Dcp\Family {
    // classe générée de la famille MY_PHOTO
    class My_photo extends \My\MyPhotoFamily {}
}
 

Les attributs des classes sont disponibles sous forme de constantes. Une classe d'attributs est générée lors de l'enregistrement de la famille. Cette classe est nommée avec le nom de la famille dans le namespace \Dcp\AttributeIdentifiers. L'usage des constantes permet de s'assurer de la validité des noms d'attributs. La classe d'attributs donne l'accès aux noms d'attribut de la famille et aussi à ceux de ses parents.

Lors de l'importation de la famille les contraintes suivantes sont vérifiées :

• Le fichier PHP de la classe doit être accessible par l'autoloader. Les fichiers de classe sont généralement publiés dans le sous-répertoire de l'application livrée par le module.
  • Le nom du fichier ne doit pas commencer par Method.
  • L'extension du fichier doit être php.
• La classe doit hériter de la classe générée de la famille parente. En cas de famille sans héritage, la classe doit hériter de la classe \Dcp\Family\Document.
• La classe ne doit pas être abstraite.
• L'encodage du fichier doit être utf-8 (incluant l'encodage ascii).
• Le fichier PHP doit être syntaxiquement correct.
• Le nom de la classe doit être unique parmi l'ensemble des classes php utilisées par Dynacase.
• La propriété className ne peut pas être utilisée conjointement avec la propriété CLASS.

METHOD

Cette propriété sert à réutiliser des morceaux de code entre plusieurs familles (Elle est à voir comme une version simplifiée des traits pour les versions de php qui ne les supportent pas).

Indique le nom du fichier PHP contenant les méthodes supplémentaires de la famille.

Le fichier référencé doit être disponible dans le répertoire FDL.

Note : Le nom du fichier doit être unique parmi tous les fichiers présents dans le répertoire FDL. Il est fortement conseillé d'indiquer l'identifiant de la famille dans le nom de fichier (par exemple : Method.MyFamily.php où MYFAMILY est l'identifiant de la famille). Le nom du fichier doit commencer par Method.

Cette propriété peut être utilisée plusieurs fois, avec la sémantique suivante :

• Lorsque le nom est préfixé par +, son contenu est concaténé directement dans la classe générée.
• Lorsque le nom est préfixé par *, le fichier n'est pas intégré directement dans la famille, mais une classe intermédiaire est générée. Cela permet notamment une surcharge plus fine des méthodes. Le prefix '*' ne peut être utilisé qu'une seule fois par famille.

Si la valeur est vide, toutes les méthodes incluses au moyen de ce mot clé sont enlevées (y compris celles déclarées avec * ou +).

Exemple :

BEGIN	IMAGE	Photographie		MY_PHOTO
CLASS	My\MyPhotoFamily
METHOD	Method.MyPhoto.php
ATTR	MYPHO_FR_INFO		Informations	N	N	frame	::auto
ATTR	MYPHO_EXIF	MYPHO_FR_INFO	Exif	N	N	longtext	::auto
END

Hiérarchie de classe lorsque la famille MY_PHOTO est intégrée :

namespace Dcp\Core {
    // classe métier de la famille IMAGE
    class Images extends \Dcp\Family\Document {}
}
namespace Dcp\Family {
    // classe générée de la famille IMAGE
    class Images extends \Dcp\CoreFamily\Image {}
}
namespace My {
    // classe métier de la famille MY_PHOTO
    class MyPhotoFamily extends \Dcp\Family\Image {}
}
namespace  {
    // classe méthode générée de la famille MY_PHOTO
    class _Method_MY_PHOTO_ extends \My\MyPhotoFamily {
        // inclus le contenu de Method.MyPhoto.php
    }
}
namespace Dcp\Family {
    // classe générée de la famille MY_PHOTO
    class My_photo extends _Method_MY_PHOTO_ {}
}

À la place de METHOD, l'utilisation de la propriété CLASS est recommandée afin de définir les classes métier de la famille.

PROFID

Identifiant (nom logique ou identifiant interne) du document profil de famille pour cette famille.

Lors de l'importation, les vérifications suivantes sont effectuées :

• Ce document doit être de la famille 'profil de famille'.

Si la valeur est vide le profil de famille est enlevé.

SCHAR

Indique les modalités de révision des documents de cette famille :

• R : Révision automatique à chaque modification,
• S : document non révisable

Si la valeur est vide la caractéristique spéciale par défaut est enlevée.

TAG

Initialise les valeurs de la propriété atags.

Chaque utilisation de la balise TAG ajoutera une valeur à la propriété atags (tag applicatif).

Note : Les tags applicatifs ne peuvent être supprimés par cette directive. Il faut, pour ce cas utiliser la clef DOCATAG

Certains tags sont déjà prédéfinis par Dynacase :

MAILRECIPIENT

Déclare la famille comme destinataire de mail. Cela permet aux documents de cette famille d'être présentés dans la liste de destinataires lors des envois de mail.

La famille doit alors implémenter l'interface IMailRecipient.

TYPE

Valeur par défaut de la propriété type.

Si la valeur est vide, le type inféré est C.

USEFOR

Caractère désignant une utilisation spéciale. Seulement pour les documents systèmes :

• W : pour les cycles de vie
• G : pour les intercalaires de chemise
• P : pour les profils

Si la valeur est vide l'utilisation spéciale par défaut est enlevée.

WID

Indique le cycle de vie qui sera associé pour les documents créé avec cette famille. Affecte la valeur de la propriété wid pour les nouveaux documents de cette famille. Contient l'identifiant d'un document cycle de vie.

Lors de l'importation, les vérifications suivantes sont effectuées :

• Ce document doit être un document cycle de vie ;
• Le cycle de vie doit être applicable à la famille en cours.

Si la valeur est vide le cycle par défaut est enlevé.

4.8.2.3 Définition d'attributs

Un attribut est défini par la syntaxe suivante :

ATTR;[id_attribut];[id_conteneur];[label];[in_title];[in_abstract];[type];[ordre];[visibility];[required];[link];[phpfile];[phpfunc];[elink];[constraint];[options]

avec les correspondances suivantes :

4.8.2.3.1 ATTR

Obligatoire
Signale que la ligne est une définition d'attribut.

4.8.2.3.2 Caractéristique [id_attribut]

Obligatoire
Identifiant système de l'attribut.

Il sera automatiquement converti en minuscules.

Cet item n'est plus modifiable une fois créé car il peut être utilisé dans les parties spécifiques de la famille.

Cet identificateur doit être unique dans la famille.

Il est conseillé d'adopter des règles de nommage des attributs, permettant de simplifier leur manipulation. Par exemple : [FAM]_[TYPE]_[NAME] avec :

• [FAM] : un préfixe indiquant la famille,
• [TYPE] : une lettre indiquant le type de l'attribut,
• [NAME] : le nom de l'attribut.

4.8.2.3.3 Caractéristique [id_conteneur]

Obligatoire (sauf pour les attributs de type frame ou tab)
Identifiant système de l'attribut structurant ou tableau contenant cet attribut.

Le type tab ne peut pas avoir d'attribut conteneur.

Le type frame peut être contenu dans un tab, ou ne pas avoir d'attribut conteneur.

Le type array doit être contenu dans un frame.

Tous les autres type d'attributs doivent être contenus dans un array ou un frame.

4.8.2.3.4 Caractéristique [label]

facultatif
Libellé de l'attribut.

Ce libellé sera automatiquement traduit s'il est présent dans le catalogue de traduction (la clé correspondante est de la forme [FAMNAME]#[attrid], avec [FAMNAME] le nom logique de la famille et [attrid] l'identifiant de l'attribut, en minuscule).

4.8.2.3.5 Caractéristique [in_title]

Obligatoire (Non applicable pour les types array, frame ou tab)
Indique que l'attribut sera utilisé dans la composition du titre du document.

Le titre du document est alors composé en concaténant toutes les valeurs brutes d'attributs définis, par ordre croissant de leur ordre et en les séparant par des espaces. Les options de formatage des attributs ne sont pas pris en compte pour le titre.

Cette caractéristique est ignorée sur les attributs de type array, frame ou tab.

Si aucun attribut n'est marqué comme composant le titre, ou si tous ces attributs sont vides, le titre sera Document sans titre suivi de l'identifiant interne du document.

Les valeurs possibles sont :

• Y pour yes
• N pour no

La composition du titre peut aussi être définie par programmation en surchargeant la méthode Doc::getCustomTitle().

Le titre d'un document ne peut excéder 255 caractères. Il est automatiquement tronqué si cette limite est atteinte.

La visibilité des attributs n'est pas prise en compte : un attribut en visibilité cachée mais ayant la colonne titre à Y est visible dans le titre.

Les valeurs des attributs multiples seront concaténées et séparées par un espace.

4.8.2.3.6 Caractéristique [in_abstract]

Obligatoire (Non applicable pour les types menu, array, frame ou tab)
Indique que l'attribut sera utilisé dans le résumé du document.

Le résumé du document est utilisé pour construire la fiche résumé dans l'application ONEFAM.

Les valeurs possibles sont :

• Y pour yes
• N pour no

4.8.2.3.7 Caractéristique [type]

Obligatoire Indique le type de l'attribut. Les types d'attributs supportés sont définis au chapitre Type de l'attribut.

Cette colonne permet également de définir le formatage de l'attribut :

• attributs de type text

  Le formatage est effectué avec la syntaxe sprintf.

  Par exemple :

  • text("%s environ") ajoute environ après la valeur ;
  • text("<b>%s</b>") affiche la valeur en gras.

• attributs de type int ou double

  Le formatage est effectué avec la syntaxe sprintf.

  Par exemple :

  • double("%.02f") affiche le nombre avec 2 décimales ;
  • integer("%d m³") affiche la valeur suivie de m³ ;
  • double("%.02f %%") affiche % après le nombre.

• attributs de type date, time et timestamp

  Le formatage est effectué avec la syntaxe strftime.

  Par exemple, time("%H:%M:%S"), ou timestamp("%A %d %B %Y %X").

4.8.2.3.8 Caractéristique [ordre]

Obligatoire
Les attributs ont un ordre dans la structure. Cet ordre est utilisé pour représenter le document mais il est aussi utilisé pour ordonner le calcul des attributs (phpfunc) et pour la composition du titre.

4.8.2.3.8.1 Ordre relatif

3.2.23 Pour que l'ordre suive l'ordre de la déclaration des attributs dans le fichier de déclaration il faut indiquer le mot-clef ::auto.

Soit la famille AA :

Dans ce cas, la structure résultante de AA est :

• A1
  • A2
  • A3
  • A4
    • A5
• A6
  • A7

En cas de surcharge de famille ou d'héritage de famille, l'ordre permet d'indiquer où le nouvel attribut sera inséré. Le mot-clef ::auto indique que l'attribut sera inséré à la fin de la structure de l'attribut englobant (cadre, onglet, tableau), s'il n'y a pas d'attribut englobant, il sera inséré à la fin du document.

Sot la famille BA héritant de la famille AA :

La structure résultante de BA est :

• A1
  • A2
  • A3
  • A4
    • A5
    • B7
    • B8
• A6
  • A7
  • B6
• B1
  • B2
  • B3
• B4
  • B5

Le mot-clef ::first, permet d'insérer un attribut en premier dans la structure englobante.

Soit la famille CA héritant de la famille AA :

La structure résultante de CA est :

• C4
  • C5
• C1
  • C2
  • C3
• A1
  • A2
  • A3
  • A4
    • C7
    • C6
    • A5
• A6
  • A7