Evènements métiers (bp)
Sommaire |
Introduction
Les évènements métiers permettent de détecter des changement d'état des objets métiers de l'application, par exemple une nouvelle demande d'engagement a été créée ou le niveau de l'encours commercial d'un client à dépasser un seuil.
Les évènements métiers permettent aux application d'agir sur les processus métiers.
Définition des évènements métiers
Les évènements métiers sont des objets de la classe TdbmEvent contenue dans le référentiel.
Cette classe hérite de la classe des évènements utilisée pour l’enregistrement des traces. Ainsi les évènements métiers et les évènements de trace sont unifiés dans le même modèle. De ce fait tout évènements générés par le système de trace est potentiellement utilisable comme évènement métier à l’intérieur des processus métiers.
Les informations liées à un évènement métier sont enregistrées lors de sa création, elles peuvent être consulter dans le concepteur de processus métiers :
Classes d’évènements métiers
Les classes d’évènements métiers décrivent les évènements métiers pour permettre de les identifier plus facilement. Elles permettent en particulier d’associer une classe métier à un ensemble évènements.
Enregistrement des classes d'évènements métiers
L’enregistrement des classes d'évènements métiers permet de définir des évènements utilisables dans les processus métiers.
Sur le dossier « Classes d’évènements métiers », choisissez la commande Nouvel élément du menu contextuel.
- L’identifiant
- Il est automatiquement construit à partir des constituants. C’est cet identifiant qui est utilisé par les activités pour retrouver les évènements les concernant.
- Type
- Type de l’évènement métier. Ce type dépend de la nature et de la source de l’évènement.
- Nom utilisé
- Ce champ contient la classe de l’objet métier associé. Cet attribut est utilisé uniquement pour les évènements en rapport avec une classe métier.
- Nom de l’évènement
- Ce champ contient une propriété associée à l’évènement. Cet élément est utilisé uniquement pour certains types d’évènements.
| Type de l’évènement | Source | Attribut Classe | Attribut Propriété |
|---|---|---|---|
| Création d’un objet | Traces | Classe de l’objet | |
| Suppression d’un objet | Traces | Classes de l’objet | |
| Mise à jour d’un objet | Traces | Classes de l’objet | Vide ou nom d’un attribut de l’objet |
| Exécution d’une méthode d’un objet | Traces | Classes de l’objet | Nom de la méthode |
| Exécution d’un traitement | Traces | Classes d’un d’objet de type processus ayant une méthode « Execute » | « Execute » |
| Changement de l’état d’un objet | Traces | Classes de l’objet | |
| Exécution d’une règle d’état | Règles | Classes de l’objet | |
| Evènement utilisateur | Code métier, Services | Classe de l’objet ou vide | Nom de l’évènement |
- File d'attente
- La file d'attente permet de classifier les évènements et impact le modèle évènementiel qui sera appliqué par les processus.
- Description de l’évènement
- Il est possible dans cet espace de donner une description de l’évènement ou de saisir du code métier.
|
Note : L’évènement créé sera pris en compte par un Service 1000 uniquement après son redémarrage. |
Relier une activité evènement métier à une classe d'évènement métier.
Pour relier un activité évènement métier à une classe d’évènements il faut éditer l’activité évènement puis sélectionner l’identifiant de la classe d'évènement créée :
Le bouton [+] à gauche de l’identifiant permet de créer directement la classe d'évènement nécessaire si celle-ci n'existe pas.
Création des évènements métiers
Les évènements métiers peuvent être créés par :
- Le framework en fonction des classes d'évènements métier définies.
- L’exécution d’une règle d’état posée dans le modèle.
- Le code métier.
- Le service REST du Serveur Ligne 1000.
Règles d'état
Une règle d’état est une règle métier qui permet de créer automatiquement un évènement métier lorsque l’état d’un objet change.
Une règle d’état est statique.
Les nouveaux types de trace « Changement d’un état » et « Changement d’un état ou création »
De nouveaux types d’éléments de trace ont été ajoutés pour permettre de définir des règles d’état à partir du système de gestion des traces.
Ces éléments fonctionnent comme une règle d’état, l’expression associée à l’élément constituant le code de la règle.
- « Changement d’un état »
- est déclenché uniquement par le changement d’état de l'objet et pas par la création de l’objet.
- « Changement d’un état ou création »
- est déclenché soit par le changement d’état de l'objet ou par la création de l’objet.
Dans le dossier « Classe d’évènements métiers », positionnez-vous sur une classe et ouvrez la fenêtre d’enregistrement d’un évènement.
- « Code associé à la règle »
- ce code doit retourner la valeur de l'état testé par la règle. Il est exécuté avant et après la modification de l'objet. Si les deux valeurs retournées diffèrent alors l'évènement est créé.
|
Tip : Le code associé à une règle d'état est indispensable, sans ce code la règle ne peut pas détecter la modification de l'état de l'objet |
Déclenchement d’un évènement métier par le code métier
- Création d’un évènement métier à partir d’une instance d’objet métier.
Les objets métiers exposent une opération permettant de créer un évènement utilisateur :
Procedure CreateCustomEvent(const iName:String ; iInfo1,iInfo2:variant; iParameters:Array of variant);
Cette opération crée un évènement métier dont l’origine est l’instance. L’objet appelant doit être en transaction et l’évènement créé est ajouté à la transaction en cours.
Les paramètres peuvent être renseignés sous forme de paire Nom, Valeur.
- Créer un évènement métier indépendamment d’une instance d’objet métier.
Utiliser la méthode de classe de TdbmEvent.
Procedure TdbmEvent.CreateCustomEvent(const ieventName :String ; iInfo1,iInfo2 :variant ; iParameters:Array of variant) ;
Cette méthode créé un évènement métier, qui n’est pas lié à une instance, dans une transaction séparée. Après l’appel, l’évènement est enregistré en base de données.
Exemple :
Procedure doCreateAnEvent; begin TdbmEvent.CreateCustomEvent('MyEvent','info1','info2',['a1',0,'a2',1]); end;
Prise en compte des évènements métier par les machines
Une machine d’exécution des processus métiers maintient une date d’exécution égale à la plus petite date d’exécution des instances de processus qu’elle contient. Une machine ne peut pas prendre en compte un évènement antérieur à cette date.
Une des conséquences de cette règle est que les évènements pris en compte par une instance ne peuvent qu’être chronologiques. Ainsi, il n’est pas possible de prendre en compte un évènement antérieur à un évènement déjà pris en compte.
Service REST de création d’un évènement métier
Ce service REST est un service générique qui permet de créer un évènement en exécutant une requête HTTP GET.
Le service n’est pas identifié ce qui signifie qu’il n’est pas nécessaire d’obtenir une session serveur pour l’appeler.
L’URL du service est une URL de service REST :
http://hostname/servicename/server/rpc.l1000/rest/xevent.add?paramètre1=valeur1¶mètre2=valeur2&…
Paramètres de la requête :
| Paramètre | Type | Description | Défaut |
|---|---|---|---|
| Caption | Chaîne | Libellé associé à l’évènement | |
| EventType | Enuméré | Type de l’évènement | CUSTOM |
| EventSourceName | String | Source de l’évènement | REST |
| EventResult | Entier | Valeur entière associée à l’évènement | 0 |
| EventDataBaseURL | Chaîne | Base de données associée à l’évènement | |
| EventSourceInfo1 | Chaîne | Valeur chaîne associée à l’évènement | |
| EventSourceInfo2 | Chaîne | Valeur chaîne associée à l’évènement | |
| InstanceOID
oidEventObject |
TOID | Identifiant de l’objet associé à l’évènement | |
| EventObjectClass | String | Nom de la classe de l’objet associé à l’évènement | |
| EventObjectProperty
EventName |
String | Identifiant de l’évènement | |
| Autres paramètres |
Tous les paramètres de la requête sont copiés dans les paramètres associés à l’évènement. Ils pourront être copiés dans les paramètres de l’instance du processus par l’activité consommant l’évènement.
La réponse du service est un flux XML contenant l’acquittement de l’enregistrement de l’évènement.
Pour créer un évènement CUSTOM , vous devez renseigner les paramètres de la façon suivante :
| EventName | Obligatoire | Identifiant de l’évènement CUSTOM |
| EventSourceInfo1
EventSourceInfo2 |
Facultatif | Des paramètres associés à l’évènement qui pourront être testés dans les activités de l’instance. |
| EventDataBaseURL | Facultatif | L’URL de la base de données si vous souhaitez qui cet évènement ne soit pris en compte que dans un certain contexte |
Exemple d’utilisation
Déclenchement d’un processus par un évènement utilisateur
Pour déclencher un processus depuis un évènement utilisateur, vous pouvez procéder de la façon suivante.
- Vous devez en premier lieu, sur la classe de l’évènement métier, définir l’évènement utilisateur.
- Puis utilisez cet évènement lors du paramétrage d’un évènement métier (double-clic sur l’évènement métier).
- Créez l’évènement dans le code métier.
Dans le journal d’exécution, vous retrouvez les paramètres utilisés lors de la création de l’évènement.
Voir aussi :
