# Règles métier

Les règles métier permettent de configurer le fonctionnement des formulaires en fonction des vraies règles qui s’appliquent à votre métier.

Ainsi au travers des règles, il est possible de

de faire des vérifications sur le formulaire,
de calculer certains champs,
d’envoyer des informations ou de les afficher à l’utilisateur à certains moments,
ou encore de préremplir certains champs lors de la création d'un formulaire

Plusieurs types de règles métier peuvent être configurées dans easyAP4. Les règles métier déclenchées après l’enregistrement des modifications faites par l'utilisateur sur le formulaire, les règles métier déclenchées lors de la création d'un formulaire ou encore les règles métiers liées à l'arrivée à une étape pour les formulaires avec cycle de vie.

Dans ce chapitre vous allez comprendre

les différents types de règles métier,
le fonctionnement général des règles métier,
voir les différents types d’instructions,
les pièces logiques,
les différentes pièces typées,
les pièces variables locales et paramètres du formulaire,
ainsi que la notion de listes

# Configuration des règles métier pour un formulaire

La configuration des règles métier pour un formulaire est faite depuis la page de configuration générale du formulaire, au travers du bouton menu Règles métier.

# Interface

Lorsque vous arrivez sur l’interface de paramétrage des règles métier, la fenêtre est séparée en 3 parties :

Le volet de gauche:
- propose différentes pièces à sélectionner permettant de paramétrer les règles.
  - Plusieurs types de pièces sont disponibles :
    - les instructions,
    - les pièces logiques,
    - les pièces typées,
    - les pièces variables locales et paramètres du formulaire,
    - et les champs.
  - Dans le cas de configuration de règles de préremplissage, les pièces d'origine de création, sont disponibles
La zone centrale:
- présente les instructions actuellement paramétrées,
- permet de manipuler, organiser et agencer les différentes pièces qui composent les règles métier, les instructions, les pièces logiques et les pièces typées par glisser/déposer,
- permet de configurer les pièces, saisir des valeurs ou paramètres.
- Par défaut, les règles d'enregistrement sont affichées. Vous pouvez afficher les règles de préremplissage en cliquant sur le bouton en haut de la zone centrale.
Le volet de droite:
- présente une aide contextualisée en fonction de la pièce sélectionnée.

# Définitions et représentation graphique des règles métier

Les règles métier sont configurées par l’intermédiaire d’instructions, de pièces logiques et de pièces typées.

L’ensemble de ces éléments sont des pièces que vous pouvez déplacer et positionner à votre gré dans la zone centrale.

Afin de distinguer les pièces en fonction de leur type, les types de pièces ont une représentation différente.

# Les pièces instructions

Les instructions sont des pièces permettant d’effectuer une action. Elles sont représentées par une forme rectangulaire

Les instructions sont composées de cellules, éléments à bords arrondis dans lesquels peuvent être positionnés des pièces typées

Les instructions peuvent être exécutées les unes à la suite des autres. Elles peuvent donc être positionnées les unes au-dessus des autres, comme dans l’exemple ci-après.

# Les pièces logiques

Les pièces logiques sont des pièces permettant de retourner une valeur booléenne, soit vrai ou faux.

Ces pièces logiques sont représentées par une pièce de forme hexagonale et peuvent s’imbriquer dans des pièces logiques avec une cellule de la même forme.

# Les pièces typées

Les pièces typées permettent de retourner une valeur d’un type donné. Les pièces typées sont représentées par des pièces aux bords arrondis.

Afin de différentier les pièces de type différent, les pièces ont une couleur en fonction du type retourné

La valeur peut être statique ou calculée en fonction de la valeur d’un champ du formulaire.

Ces pièces peuvent être déposées dans les cellules, des instructions ou des pièces logiques contenant une cellule de la même forme, aux bords arrondis.

D'autres pièces typées, aves des couleurs différentes, permettent d'utiliser les lignes de tableaux ou encore les listes

# Les pièces d'origine de la création

Les pièces d'origine de la création sont disponibles uniquement dans les règles métier de préremplissage du formulaires.

Ces pièces de type lien permettent de cibler le lien vers le formulaire d'une certaine catégorie, à l'origine de création du formulaire donc les champs seront préremplis.

# Les pièces variables locales et paramètres du formulaire

Certaines pièces particulières, non typées, permettent de manipuler des données temporaires ou variables dans les règles métier, comme les

variables locales qui permettent d'enregistrer une donnée de manière temporaire ou pour itérer sur une boucle ou un tableau,
ou les paramètres du formulaire qui permettent d'enregistrer des données persistantes, partagées entre les formulaires d'une même catégorie.

Le type retourné par ces pièces dépend du type de la valeur enregistrée précédemment.

# Les listes

Une liste est un type de pièce, représentant une liste ordonnée d'éléments, utilisé dans les règles métier.

Plusieurs champs du formulaire peuvent être utilisés en tant que listes, les colonnes des tableaux du formulaire et l'ensemble des champs multiples du formulaire, comme les Listes de liens vers des formulaires ou les Listes de comptes utilisateurs

Les variables locales peuvent être aussi utilisées pour itérer sur les lignes d’un tableau (« Pour chaque ligne ») et peuvent s'avérer aussi utiles lorsque vous mettez à jour des champs multiples de votre formulaire par exemple.

Vous pouvez vous référer à l'exemple d'utilisation des variables locales pour modifier les champs multiples au travers des règles métier.

# Types de règles métier

# Règles métier d'enregistrement

Les règles métier d'enregistrement sont les règles affichées par défaut, lors de l'accès à la page de configuration des règles métier.

Les instructions déposées dans la liste d’instructions Instructions à exécuter lors de l’enregistrement sont appelées automatiquement une fois l’enregistrement demandé par l’utilisateur.

Ces instructions sont appelées une fois les données enregistrées dans le formulaire. Ces instructions permettent de vérifier certaines conditions avant d’éventuellement annuler la modification et permettent aussi de modifier automatiquement certaines valeurs des champs.

Configurez les différents traitements ou vérifications que vous souhaitez effectuer lors de l'enregistrement du formulaire, comme décrit la section fonctionnement général des règles métier.

# Règles métier liées à l'arrivée à une étape

Pour les formulaires avec cycle de vie, en plus des règles métier vérifiées lors de l’enregistrement, il est possible de configurer des règles métiers,

exécutées lors de l’arrivée à une étape donnée
ou des Instructions programmées exécutées au bout d’un certain temps après l’arrivée à une étape,

Le fonctionnement détaillé de ces règles est décrit dans le chapitre règles métier pour le cycle de vie.

# Règles métier de préremplissage

Les règles métier de préremplissage sont accessibles depuis la page de configuration des règles métier, en cliquant sur le bouton Règles de préeremplissage situé sur en haut de la zone centrale.

Les instructions déposées dans la liste d’instructions Instructions pour préremplir le formulaire sont appelées automatiquement lors de la création d'un formulaire demandé par l’utilisateur.

Ces instructions sont appelées lors de la création d'un formulaire. Ces instructions permettent

de préremplir des champs du formulaire, à partir des informations générales, comme la date du jour ou l'utilisateur connecté
ou encore de préremplir des champs en fonction du formulaire originaire de la création.

On peut par exemple avoir une catégorie de formulaires Client avec les données des différents clients et une catégorie de formulaire Facture, représentant les factures pour un client.

exemple-regle-champ-de-lien

Dans cet exemple, avec les règles de préremplissage, lors de la création d'une facture, il est ainsi possible d'initialiser la date de création de la facture à partir de la date du jour. Et dans le cas où la facture a été créée à partir d'un formulaire client, préremplir les champs liés au client de la facture, comme l'adresse du client, directement à partir du formulaire client, originaire de la création, plutôt que l'utilisateur ait à les saisir manuellement.

Configurez les différents préremplissages des champs que vous souhaitez effectuer lors de la création formulaire, comme décrit la section fonctionnement général des règles métier.

# Fonctionnement des règles métier

Les règles métier, que ce soit les règles métier d’enregistrement, les règles métier de préremplissage, ou les règles métier liées à l'arrivée à une étape, une pièce principale est présentée vide.

Cette pièce principale est par exemple Instructions à exécuter lors de l’enregistrement pour les les règles métier d’enregistrement ou Instructions pour préremplir le formulaire pour les règles métier de préremplissage lors de la création d'un formulaire de la catégorie.

Cette pièce est destinée à recevoir les instructions permettant d'effectuer des contrôles sur des valeurs de champs, vérifier certaines conditions avant d’éventuellement annuler la modification, d'effectuer des traitements métier, permettant de modifier automatiquement certaines valeurs des champs ou d'effectuer des actions, par exemple envoyer un courriel ou bien aller à une étape pour les formulaires avec cycle de vie.

Dans cette pièce de liste d’instructions, des pièces instructions peuvent être imbriquées, les unes au-dessus des autres.

Le traitement des instructions est fait dans l’ordre d’agencement des instructions dans l’instruction générale.

Les pièces instructions sont configurables avec des pièces logiques et des valeurs -fixes ou à partir du champ du formulaire- obtenues grâce aux pièces typées et fonctions champs.

Attention aux types

Une attention particulière doit être portée aux types des valeurs renvoyés par les pièces typées et utilisés dans les autres éléments.

Les pièces typées, pièces logiques et instructions ont des types acceptés.

Une pièce d’un type non accepté ne pourra pas être configurée avec ce type.

Certaines pièces ou instructions itératives peuvent être utilisées pour faire des boucles ou itérer sur les lignes d'un tableau par exemple. Des variables locales peuvent être utilisées pour manipuler les données dans ces instructions.

Dans certains cas, il peut être utile d'avoir des champs ou des données partagées entre les formulaires. Les paramètres du formulaire permettent de manipuler des variables partagées entre les formulaires.

# Les instructions, opérations et pièces typées des règles métier

Les différentes pièces, Instructions, opérations et pièces typées, ont des caractéristiques et comportements différents, en fonction du type et de la pièce. Les particularités sont présentées dans les chapitres relatifs à chacune des pièces :

← Le cycle de vie {#cycle} Les instructions →