Vocabulaire

Ce chapitre contient toutes les définitions des termes techniques utilisés dans ces how to.

Smart Structure

Une Smart Structure est la base des formulaires d'Anakeen Platform. Elle consiste en une liste de propriétés (un titre, une icône, etc.) et une structure de données, c'est à dire l'ensemble des champs (Smart Field) qui constituent le formulaire.
Pour faire une comparaison, une Smart Structure est un type de formulaire (Fiche de réunion, Fiche personne, etc.).

Smart Element

Un Smart Element est une instance d'une Smart Structure. C'est donc un formulaire instancié, il correspond à une ligne en base de donnée, possède un numéro d'identifiant unique, etc. Pour faire une comparaison, un Smart Element c'est la fiche de la réunion du 12 mai 2020.

Smart Field

Un Smart Field est un élément d'information contenu dans un Smart Element et défini au niveau d'une Smart Structure.
Il possède plusieurs caractéristiques : un type (texte, date, texte long, etc.), un identifiant, un label, etc. Pour faire une comparaison, la fiche de réunion contient un Smart Field de type date nommé date de la réunion.

Paramètre de Smart Structure

Le paramètre est très proche du Smart Field. La différence se situe dans sa portée, un paramètre de Smart Structure possède une valeur au niveau de la Smart Structure qui est accessible par n'importe quel Smart Element de cette Smart Structure. Pour faire une comparaison, la Smart Structure fiche de réunion possède un paramètre préfixe permettant de calculer son titre, en apposant un préfixe à tous les Smart Element fiche de réunion.

Aide à la saisie

Aide à la saisie, liste déroulante, typeahead, quelque soit la manière dont on le nomme c'est un mécanisme standard permettant de faire des listes déroulantes de suggestion de valeur pour aider les utilisateurs à compléter les formulaires.

Hook de Smart Element

Les hooks des Smart Element permettent de modifier le fonctionnement des Smart Element. Ils peuvent être ajoutés avant une action - hook en pre - et dans ce cas peuvent annuler l'action (le preDelete permet d'annuler la suppression d'un Smart Element).
Ils peuvent être appelés après une action - hook en post - et dans ce cas ils permettent de compléter l'action (le postImport permet de faire des calculs après l'importation d'un Smart Element).

Énuméré

Un énuméré est une liste de valeur (ouverte ou fermée) qui est utilisée par les Smart Field de type enum pour présenter un choix aux utilisateurs.

Cycle de vie ou Workflow

Le cycle de vie ou Workflow est une suite de transition et d'étapes permettant de guider un ou plusieurs utilisateurs pendant la complétion d'un Smart Element. À chaque changement du cycle de vie, il est possible de programmer des relances automatiques, d'envoyer des mails, exécuter du code, changer de représentation de formulaire, etc.

Profil

Le profil permet de contrôler l'accès (lecture, écriture, etc.) au Smart Element. Les profils existent sous plusieurs formes :

  • les profils statiques : ces profils n'ont pas de partie variable suivant les Smart Element. Ils sont donc invariant quelque soit le Smart Element sur lequel ils s'appliquent, ils donnent les mêmes droits aux mêmes comptes,
  • les profils dynamiques : ces profils contiennent des règles qui sont liées à la Smart Structure à laquelle ils sont associés. Cela permet notamment d'ouvrir des droits suivant les utilisateurs qui sont référencés dans un Smart Element, par exemple seul le rédacteur d'une fiche de réunion peut la modifier,
  • les profils dédiés : un profil dédié est associé à un Smart Element. Il peut soit provenir de l'application d'un profil dynamique, soit avoir été créé directement avec le Smart Element.

Smart Field Access Layer

Les Smart Field peuvent porter des droits ceux-ci permettent d'indiquer quel utilisateur peut les consulter et/ou les modifier.

Classe de rendu

Une classe de rendu associée à un Smart Element permet d'en modifier la représentation, via des templates, de la CSS, du JS, etc.

Masque

Un masque permet de modifier les visibilités et les smart field obligatoire d'un Smart Element.

Vue de Smart Element

Une vue est une représentation particulière d'un Smart Element, elle peut constituer en une modification de son rendu, soit via des templates, de la CSS ou du JS additionnel. Une vue d'un Smart Element est l'association d'un masque et d'une classe de rendu.

Contrôle de vue

Un contrôle de vue permet de définir des vues associés à un Smart Element.
Le contrôle de vue peut-être profilé pour indiquer quel type d'utilisateur a accès à quelle vue.

Collection

Un collection est un ensemble de Smart Element, il en existe deux types :

  • statique : cette collection est un ensemble de Smart Element qui sont associés à la collection,
  • dynamique : cette collection est une recherche de Smart Element.

Modèle de mail

Les modèles de mail permettent de paramétrer les mails qui seront envoyés par la plateforme. Un modèle de mail permet de définir :

  • l'expéditeur,
  • le(s) destinataire(s),
  • le sujet du mail,
  • le corps du mail,
  • les pièces jointes

Chacune de ces parties peut être dynamique en fonction des valeurs du Smart Element auquel le mail envoyé est rattaché.

Minuteur

Les minuteurs permettent de lancer des tâches - envoi de courriel, changement d'état, etc. - à des dates prédéfinies. Ces dates peuvent être soit :

  • statiques : le 12 mai 2020,
  • dynamiques : +5 jours après le Smart Field date du Smart Element associé.

Utilisateur

Un utilisateur est un compte correspondant à une personne physique.
Il est utilisé pour permettre à un utilisateur de s'identifier auprès de la pateforme.

Groupe

Un groupe est un ensemble d'utilisateurs ou de groupes.
Un groupe peut être associé à une profil.
Un groupe peut contenir un autre groupe auquel cas ses sous groupes acquièrent les droits associés au groupe parent.

Rôle

Le rôle est utilisé pour faire le lien entre les profils et les groupes ou utilisateurs. Un rôle peut être associé à un groupe - dans ce cas l'ensemble des utilisateurs de ce groupe possède ce rôle - ou alors directement à un utilisateur.
Lorsqu'un rôle est associé à un profil, tous les utilisateurs possédant ce rôle peuvent utiliser le droit ouvert par le profil.

Et ensuite ?

Maintenant que le contexte est introduit et que les notions ultérieurement abordées ont été expliquées, je vous invite de ce pas à rentrer dans le vif du sujet en Fichier cheat sheet.