Le concepteur de processus métiers (bp)
(→Service Ligne 1000 et processus métiers) |
(→Prise en compte des évènements métier par les machines) |
||
| Ligne 42 : | Ligne 42 : | ||
| − | |||
| − | |||
| − | |||
| − | |||
===Service REST de création d’un évènement métier=== | ===Service REST de création d’un évènement métier=== | ||
Version du 19 août 2009 à 10:45
Introduction
Le concepteur de processus métiers est accessible par le menu Fichier / Outils / Concepteur de processus métiers.
La fenêtre du concepteur de processus métiers comporte quatre parties :
Arbre de la partie gauche de la fenêtre
L’arbre à gauche de la fenêtre affiche les différentes entités en rapport avec les processus métiers :
- les serveurs, locaux ou distants, qui ont été enregistrés. Leur état est signalé (arrêté, suspendu, démarré) et il est possible de suivre l’exécution des processus métiers qui sont présents dans les moteurs.
- les processus métiers, destinés à être exécutés par un service, et organisés en catégories.
- les machines,
les processus exécutés par la machine,
les instances de processus exécutées par la machine,
- les classes d’évènements métiers enregistrés,
- les instances d’évènements métiers.
La palette d’outils centrale
Elle contient l’ensemble des évènements et activités disponibles pour construire un processus métier. Ces éléments sont regroupés logiquement dans des onglets.
La barre d’outils centrale
Elle contient les éléments les plus fréquemment utilisés.
La zone de droite
Elle contient la zone d’édition graphique des processus métiers.
La zone d’affichage des messages d’erreurs
La zone au bas de la fenêtre affiche les messages d’erreurs éventuels lors de la validation d’un processus métier.
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 | Défaut | |
| Caption | Chaîne | Libellé associé à l’évènement | |
| EventType | Enuméré | Type de l’évènement | CUSTOM |
| EventSourceName | 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 |
OID | Identifiant de l’objet associé à l’évènement | |
| EventObjectClass | Nom de classe | Nom de la classe de l’objet associé à l’évènement | |
| EventObjectProperty
EventName EventId |
Chaîne | 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 |
Palette d’outils centrale : séquences, évènements et activités
Définitions
Séquences
Les séquences servent à relier les évènements et les activités et sont symbolisées par des courbes de couleurs :
Une séquence ne relie que deux « objets » entre eux : un seul évènement à une seule activité (ou deux évènements entre eux, ou deux activités entre elles).
Chaque activité et évènement est une étape du processus métier.
Les évènements
Les évènements sont des « signaux » permettant de démarrer des processus métier. Il peut s’agir de changements dans le métier (création ou modification d’objets métiers par exemple), ou d’évènements extérieurs (réception de mail, création de fichier dans un répertoire…). Ils sont symbolisés par un rond avec une couleur ou une signalétique spécifique :
Les activités
Les activités sont toutes les « actions » que peuvent faire les Processus Métier. Elles sont symbolisées par un rectangle avec une couleur et une signalétique spécifique :
Evènements et activités standards
Onglet « Evènements initiaux »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/image125.pngEvènement initial déclenché par le métier
Evènement initial qui est déclenché par la création d’un évènement métier.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Evènement Immédiat
Evènement initial qui est déclenché immédiatement.
Cet évènement se déclenche à chaque cycle d’exécution de la machine.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Evènement Jamais
Evènement initial qui n’est jamais déclenché.
Cet évènement est utile pour définir des processus métiers qui sont appelés par d’autres processus.
Onglet « Evènements »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Evènement Toujours
Evènement intermédiaire qui est toujours vérifié.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Evènement Terminé
Un processus doit posséder un évènement final par branche.
Onglet « Activités standards »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Activité Nulle
Activité qui n’effectue aucune opération. Elle sert principalement à mettre au point et tester un processus métier. Elle se termine toujours avec un résultat « succès ». Il est possible de lui adjoindre des notifications, contrairement à d’autres activités, ce qui peut être utile pour vérifier le fonctionnement d’un processus métier.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Activité Appel d’un processus
Activité qui exécute un autre processus. Cette activité peut être utilisée pour :
l’intervention en simultané de plusieurs en parallèle sur un même processus,
découper un processus métier complexe et en tester facilement les branches,
créer des sous processus métiers réutilisables par plusieurs processus.
Onglet « Général »
Processus
Identifiant du processus à exécuter. Si le processus n’est pas présent dans la machine au moment de l’exécution, il sera automatiquement chargé.
Attendre la fin d’exécution pour poursuivre
Exécution synchrone d’un processus. L’activité attendra la fin du processus exécuté pour poursuivre l’exécution.
Exécution asynchrone : l’activité n’attend pas la fin d’exécution du processus exécuté pour poursuivre.
Délai d’attente
Précise un délai au-delà duquel l’activité considèrera que le processus appelé est en Timeout.
La case Attendre la fin d’exécution pour poursuivre doit être cochée pour qu’un Timeout soit détecté.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Activité Synchronisation de branches
Activité permettant de synchroniser plusieurs branches d’exécution.
Exemple :
La première activité de ce processus va créer deux branches d’exécution qui seront synchronisées. Le processus ne peut se terminer que si les deux branches sont terminées.
Les gestionnaires
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Gestionnaire des Time Out (expiration des délais d’attente)
Gère l’expiration des délais d’attente qui ne sont définies explicitement dans le processus métier.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Gestionnaire des Erreurs
Gère les séquences Echec qui ne sont définies explicitement dans le processus métier.
Les évènements et activités liés au métier
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Evènement Métier
Evènement intermédiaire attendant l’apparition d’un évènement métier.
Onglet « Général »
Evènement
Nom de l’évènement métier qui doit déclencher le processus.
Préfixe (évènement attente)
Préfixe utilisé pour copier les attributs de l’évènement dans les paramètres de l’instance du processus. Si ce champ n’est pas renseigné, les attributs ne seront pas copiés. Pour un évènement initial la valeur vaut toujours « initial ».
Evènement de l’instance principale (évènement attente)
L’évènement métier doit avoir été créé par l’objet associé au processus pour être pris en compte.
Tester la valeur de Info1 ou Info2
Les valeurs des attributs EventSourceInfo1 ou EventSourceInfo2 de l’évènement doivent correspondre aux valeurs renseignées dans les champs correspondants Info1 et Info2 pour que l’évènement soit pris en compte.
Info1, et info2 :
Valeurs des attributs info1 et Info2 attendues.
Déterminé par Info1 ou Info2 (évènement attente) :
Si les valeurs des attributs Info1 ou Info2 de l’évènement correspondent aux valeurs renseignées, alors l’activité se dirige vers la séquence Succès qui sera enchainée ; dans le cas contraire elle se dirige vers la séquence Echec qui sera enchainée.
Définir comme objet de l’instance.
L’objet associé à l’évènement métier devient l’objet associé à l’instance du processus.
Onglet post-condition :
Cet onglet permet d’ajouter une ou plusieurs conditions sur le métier pour que l’évènement soit déclenché.
Lorsqu’un évènement métier déclenche un processus métier :
- il copie ses attributs dans les paramètres de l’instance du processus métier. La source des attributs est « initial »
- l’objet ayant créé l’évènement devient l’objet associé à l’instance du processus métier.
Onglet Métier
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Exécuter un script
Cette activité exécute un script métier.
Toutes les possibilités du langage de script sont disponibles.
La valeur de retour de l’exécution détermine la séquence qui sera enchaînée .
| bprOK | La séquence Succès sera enchaînée |
| bprNOK | La séquence Echec sera enchaînée |
| bprWAIT | L’instance reste dans l’état courant et l’activité sera ré exécutée au prochain cycle. |
| bprHALT | L’instance est interrompue. |
| bprERR | L’instance est interrompue. (TODO) |
Une erreur de compilation est équivalente à un retour bprOK.
Attributs spécifiques aux processus métiers
| Instance | Référence | Référence sur l’objet métier rattaché à l’instance du processus |
| ProcessId | Chaîne | Identifiant du processus |
| InstanceId | Chaîne | Identifiant de l’instance du processus
Cet identifiant est unique pour une exécution du processus, si le processus est placé dans plusieurs machines l’unicité n’est pas garantie. |
| InstanceGUID | Chaîne | GUID de l’instance du processus.
Cet identifiant est un GUID tiré par le système et garanti unique. |
| HostName | Chaîne | Nom du Serveur exécutant le processus |
| HostServiceName | Chaîne | Nom du Service exécutant le processus |
| HostBaseURL | Chaîne | Base de l’URL du serveur exécutant le processus. |
| HostBaseRESTURL | Chaîne | Base de l’URL des services REST du serveur, égale à
(BaseHostURL)rpc.l1000/rest/ |
| PublicFolder | Chaîne | Répertoire publique du serveur |
| InstanceFolder | Chaîne | Un répertoire réservé à l’instance du processus |
| InstanceDatabaseURL | Chaîne | L’Url de la base de données associée à l’instance du processus. |
Les méthodes spécifiques aux processus métiers sont :
function Get(const iPrefixedParameter :string) :Variant ;
function GetParameter(const iPrefix:string; const iName:string):Variant;
Ces méthodes retournent la valeur d’un paramètre.
function GetPublicFolder(const aSubFolder:string):string;
Cette méthode retourne un chemin de repertoire dans la zone publique du serveur.
procedure Set(const iPrefixedParameter :string; const value:Variant);
procedure AddParameter(const iPrefix:string; const iName:string; const value:Variant);
Ces méthodes positionnent la valeur d’un attribut, si celui-ci n’existe pas il est créé.
function uniqueID(const aPrefixedParameter :string) :variant ;
Positionne la valeur d’un attribut avec un identifiant unique. Si celui-ci n’existe pas il est créé. Un identifiant unique est un GUID (Global Unique Identifier) et invisible pour l’utilisateur, tiré sur la machine exécutant le processus.
Procedure setInstance(const iOID :TOID) ;
Cette méthode définit l’instance d’objet métier associé à l’instance du processus métier.
Procedure AddMessage(const imsg :string) ;
Cette méthode ajoute un message dans la liste des messages de l’instance du processus métier.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Exécuter une expression
Cette activité évalue une expression. Si le résultat est positif, la séquence « Succès » est enchaînée, sinon la séquence « Echec est enchaînée.
Exemple
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Exécuter une méthode
Cette activité permet d’encapsuler l’exécution d’une méthode métier.
Mode
Indique le type d’exécution :
une méthode de l’objet associé à l’instance,
une méthode d’une façade.
Classe
Nom de la classe supportant la méthode. Cette classe doit être une classe non persistante.
Méthode
Nom de la méthode à exécuter. La méthode ne doit comporter que des paramètres simples, les types classes, listes ou variant ne sont pas autorisés.
Préfixe
Préfixe de copie des paramètres en sortie de la méthode. Les paramètres de sortie sont tous les paramètres de type « out » ainsi que le résultat de la méthode si celle-ci est une fonction.
Associer l’objet retourné à l’instance
Si la méthode est une fonction et si celle-ci retourne un objet, cet objet sera défini comme l’objet associé à l’instance du processus.
Grille des paramètres
Liste des valeurs à passer à la méthode lors de l’appel.
Si vous cochez la colonne « Paramètre », la valeur est une expression qui sera évaluée et substituée lors de l’exécution.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Exécuter une modification
Cette activité permet d’effectuer des modifications sur l’objet associé à l’instance ou sur les paramètres de l’instance.
Onglet « Valeur »
Attributs à modifier
La liste des attributs de l’objet ou de l’instance à modifier.
Vous pouvez saisir un nouvel attribut qui sera créé au moment de l’exécution.
Paramètre
Lorsque cette case est cochée, une expression est saisie en valeur.
Préfixe
Utilisez cette zone lors de la création de nouveaux attributs de l’instance.
Il est impossible d’effectuer un retour en arrière (rollback) après une modification réalisé par cette activité.
Cas d’utilisation des activités d’exécution de méthode et de modification
Cet exemple utilise une méthode pour créer un objet et l’associer à l’instance du processus.
- La première activité exécute une méthode d’une façade qui crée un objet métier. Cet objet est associé à l’instance du processus.
La méthode exécutée :
unit TestSYFREWF;
interface
Type
TestAPI = Class(TitObject)
public
Function CreateAWFClasseA():WFClasseA;
end;
Implementation
{TestAPI}
Function TestAPI.CreateAWFClasseA():WFClasseA;
var inst:WFClasseA;
begin
ClassManager.beginTran;
try
inst := WFClasseA.Create;
classmanager.InsertToTran(0,inst);
inst.unCode := 'Nouveau-'+DateTimeToStr(Now);
ClassManager.Commit;
Result := inst;
except
ClassManager.RollBack;
raise;
end;
end;
end.
- la seconde activité modifie les attributs de l’objet précédemment créé et crée un nouvel attribut de l’instance.
- la troisième activité exécute une méthode de l’objet.
L’activité suivante attend que l’utilisateur change la valeur de l’état.
Le résultat de l’exécution ainsi que le code exécuté sont indiqués dans les messages.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Exécuter un curseur
L’activité curseur permet d’exécuter un curseur sur une classe et de traiter tous les objets retournés par le curseur.
Le principe d’exécution du curseur est le suivant :
- Lors de la première activation le curseur est ouvert et l’ensemble des objets qu’il retourne sont stockés dans une liste temporaire. Le premier objet est ensuite sélectionné et l’évènement « OK » est retourné.
- A chaque activation suivante, l’objet suivant de la liste est sélectionné et un évènement « OK » est retourné. Lorsque tous les objets sont traités, un évènement « NOK » est retourné.
Classe
Classe sur laquelle porte le curseur. Cette classe peut être différente de la classe de l’objet associé au processus métier.
Référence
Attribut de type référence du processus métier auquel sera associée l’instance du curseur.
Cas d’utilisation d’un curseur
L’exemple suivant exécute un curseur sur une classe.
Un attribut de type référence est défini sur le processus métier:
Le curseur est paramétré de la façon suivante :
L’activité exécutée à chaque pas de la boucle du curseur enregistre un message.
Le journal rappelle le résultat de l’exécution lorsque le curseur renvoie trois objets.
Les évènements et activités temporels
Onglet « Evènements initiaux»
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Evènement Horloge
Cet évènement permet une planification de l’exécution d’un processus métier. Il permet de créer des instances du processus sur la base d’une planification.
Onglet « Propriétés »
Onglet « Simulation»
Cet onglet permet de réaliser une simulation de la planification pour vérifier que les déclenchements correspondent aux besoins.
Exécuter / Stop
Démarre et arrête la simulation.
Date et heure de départ.
Indique la date et l’heure de départ de la simulation.
Pas d’horloge.
Indique la mesure de simulation.
Date et heure de dernière exécution.
Indique la date et l’heure de la dernière exécution au moment du démarrage de la simulation.
La simulation fonctionne en accélérant le temps et en affichant les dates de déclenchement.
Onglet « Evènements »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Evènement attente d’un délai
Cet évènement attend un délai avant de poursuivre l’exécution, la séquence suivante est toujours « Succès ».
Délai d’attente
Durée en seconde de l’attente.
Le délai démarre au moment où l’instance de processus entre dans l’activité. Si le processus est interrompu puis relancé à une date supérieure à la date du début de l’activité, le délai d’attente s’ajoute et l’instance enchaîne l’exécution.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/Evènement attente d’une date et heure
Cet évènement attend une heure précise avant de poursuivre l’exécution, la séquence suivante est toujours « Succès ».
Date
Permet de définir une date relative à laquelle le processus continuera.
Heure
Heure à laquelle l’instance de processus continuera.
Les évènements et activités de messagerie
Onglet Messagerie
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Envoyer un Mail
Cette activité permet d’envoyer un email. La boîte de dialogue de propriétés ressemble à celle de vos messageries habituelles.
Onglet « Propriétés »
Id
Identifiant de l’email. Cet identifiant est utilisé pour faire le lien avec un évènement « Attente de réponse ». Si plusieurs mails sont envoyés par le processus métier et que des traitements doivent tenir compte des mails, ils utiliseront cet identifiant pour les reconnaître.
A, CC
Adresse des destinataires.
La saisie des adresses des destinataires utilise les conventions suivantes :
les adresses sont séparées par points-virgules,
si l’adresse contient un caractère arobase @ alors il s’agit d’une adresses externe Internet,
si l’adresse ne contient pas de caractère arobase @ alors il s’agit d’une adresses interne d’une boîte à message de l’application.
De
Adresse de l’expéditeur et de réponse. Cette adresse sera l’adresse à laquelle sera envoyée la réponse à ce mail. Si vous ne renseignez pas cette valeur, l’adresse d’expéditeur paramétrée dans les paramètres SMTP sera utilisée.
Seul le provider SMTP gère cette adresse.
Objet :
Objet de l’email.
Contenu
Contenu de l’email.
Bouton d’insertion de paramètre
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/Ce bouton permet d’insérer une expression dans les champs A, CC, Objet qui sera remplacée lors de l’exécution. Le curseur doit se trouver dans un des trois champs concernés.
Exemple
Par exemple si l’objet qui a déclenché le processus métier possède un attribut email et que le mail doit être envoyé à cette adresse, on utilisera ce bouton pour insérer le code [Instance.email]. Lors de l’exécution du processus métier ce code sera remplacé par l’attribut concerné, dans cet exemple par l’adresse email.
Barre d’outils HTML
HTML REST
Ce menu permet d’insérer une URL de réponse (REST) ou une URL d’accès à un écran accessibles pour le destinataire.
Les liens HTML REST demandent que le destinataire ait accès au serveur Sage 1000.
Référence du mail : l’évènement qui traitera la réponse à ce mail se basera sur cette référence pour l’identifier par rapport à tous les autres mails qui pourraient se trouver dans la boîte à mail référencée par le processus métier.
Lien réponse OK / NOK : Lorsque l’utilisateur cliquera sur ces liens il sera dirigé vers un écran HTML qui permettra au serveur Sage 1000 de mémoriser cette réponse et de déclencher la suite du processus métier. Celui-ci devra plus loin être relié à un évènement d’attente de réponse mail pour gérer cette réponse et générer un résultat Succès ou Echec.
Lien vers l’écran associé : Lorsque l’utilisateur cliquera sur le lien, un écran Sage 1000 sera ouvert. L’écran associé se paramètre dans l’onglet « Avancé » de l’activité.
Seul le premier lien cliqué sera pris en compte.
POP 3
Ce menu permet d’insérer un bloc de texte dans le corps de l’email pour gérer la réponse (POP3).
Insérer un attribut : Le programme va insérer dans le corps du message, à l’endroit du curseur, le code d’un attribut de l’objet métier. Quand le message sera envoyé, ce code sera remplacé par la valeur réelle de l’objet métier en mémoire.
Réponse standard : Le programme va insérer un texte prédéfini expliquant comment répondre avec une réponse OK ou une réponse NOK, ainsi que la référence du mail.
Réponse OK / NOK : insère un code qui sera remplacé, à l’envoi du mail, par une réponse prédéfinie pour « accepter » ([mailresponse_ok]) ou « refuser » ([mailresponse_nok]).
Pour répondre à un mail, le destinataire doit être dans un environnement avec une messagerie compatible POP3.
Si le destinataire répondant à un email POP3 laisse par erreur les deux réponses OK /NOK dans le corps du mail ce sera la première réponse, par ordre de lecture, qui sera prise en compte.
Si le destinataire a fait une erreur dans sa réponse et renvoie une nouvelle réponse, seule la première réponse sera prise en compte car le processus métier aura continué son exécution. Le fonctionnement est identique pour les réponses via lien HTML REST.
Onglet « Avancé »
Ecran associé
Ecran provenant de Sage 1000 utilisé par le lien « Lien vers l’écran associé ». il peut être saisi manuellement ou inséré via la boîte de sélection adjacent à la zone de saisie.
Ouvrir cet écran en mode création
Permet d’ouvrir l’écran en mode insertion au lieu de l’ouvrir en mode consultation.
Paramètres passés à l’écran
Permet de définir des paramètres de l’écran.
Onglet « Pièces jointes »
Cet onglet permet de définir les pièces à joindre à l’email.
Si vous renseignez un chemin de fichier, le fichier doit être accessible lors de l’exécution du processus métier.
Si vous renseignez un nom de fichier sans chemin, le fichier sera recherché dans le répertoire de l’instance du processus métier. Généralement ce fichier a été généré par une autre activité du processus et le nom du fichier est contenu dans un paramètre de l’instance. Il y a un répertoire par instance.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Réponse à un mail par REST
Cet évènement attend la réception d’un évènement créé par une réponse à un email envoyé par l’instance du processus.
Réponse à.
Identifiant de l’activité ayant envoyé l’email.
Délai d’attente
Délai au-delà duquel l’évènement génèrera un timeout qui pourra être pris en charge par un évènement Timeout.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Réponse à un Mail par POP3
Cet évènement attend la réception d’une réponse à un email envoyé par l’instance du processus.
Onglet «Général»
Réponse à.
Identifiant de l’activité ayant envoyé l’email.
Serveur, Port, Login, Mot de passe
Paramétrage du serveur POP3 et du compte de messagerie sur le serveur.
Délai d’attente
Délai au-delà duquel l’évènement génèrera un timeout qui pourra être pris en charge par un évènement Timeout.
Onglet « Avancé »
Action sur les réponses reçues.
Détermine le comportement de l’activité lorsqu’une réponse est reçue.
Aucune : pas d’action. l’email est laissé en place sur le serveur de messagerie
Supprimer : l’email est supprimé du serveur de messagerie
Action sur les mails qui ne sont pas des réponses reçues
Détermine le comportement de l’activité lorsqu’un mail présent dans la boîte n’est pas une réponse.
Préfixe de paramètre pour la réponse
Préfixe utilisé pour copier les attributs de l’email reçu dans les paramètres de l’instance.
Il est important que le destinataire laisse dans le corps du message la référence du mail. Dans le cas contraire le système ne pourra pas le mettre en relation avec le processus métier et l’évènement « Réponse à un Email ». Dans ce cas, l’instance du processus métier restera indéfiniment en attente sauf si un Timeout et une séquence ont été prévus.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/Evènement réception de Mail
Les tâches métiers
Onglet « Tâches »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Impression
Cette activité permet d’exécuter une impression.
Onglet Propriétés
Base de données
Base de données sur laquelle s’effectue l’édition. Renseignez cette base si elle diffère de la base de données sur laquelle l’instance du processus est exécutée.
Rapport
Nom de l’édition à réaliser.
Sortie sur
Sélectionne le type de sortie.
Imprimante
Lorsque le type de sortie est « imprimante », cette zone indique l’imprimante sur laquelle l’édition est imprimée. L’imprimante sélectionnée doit être une imprimante accessible depuis le serveur exécutant le processus. Pour cette raison, seules les imprimantes réseau sont proposées.
Type de fichier
Lorsque le type de sortie est « Fichier » cette zone indique le format de sortie.
Fichier de sortie
Si vous renseignez un nom de fichier sans chemin le fichier sera généré dans le répertoire de l’instance.
Si vous renseignez un chemin de fichier, celui-ci devra être accessible du serveur exécutant le processus.
Onglet paramètres
Cet onglet permet de renseigner les paramètres de la requête.
Valeur
Utilisez cette colonne si vous renseignez une valeur constante.
Expression
Utilisez cette colonne si vous renseigner une expression qui sera évaluée à l’exécution.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Import de données
Cette activité permet d’exécuter un import de données.
Base de données
Base de données dans laquelle s’effectue l’import. Renseignez cette base si elle diffère de la base de données sur laquelle l’instance du processus est exécutée.
Fichier
Fichier de données à importer.
Si vous renseignez un nom de fichier sans chemin, ce fichier doit être présent dans le répertoire de l’instance.
Si vous renseignez un chemin de fichier celui-ci doit être accessible du serveur exécutant le processus.
Descripteur
Descripteur d’importation.
Mode d’importation
Indiquez quel mode d’importation vous souhaitez utiliser.
Options sur les erreurs
Défini les options sur les erreurs détectées.
Options sur le fichier
Défini les actions sur le fichier importé.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Export de données
Cette activité permet d’exécuter un export de données.
Onglet Propriétés
Base de données
Base de données sur laquelle s’effectue l’exportation. Renseignez cette base si elle diffère de la base de données sur laquelle l’instance du processus est exécutée.
Fichier
Fichier de données à générer.
Si vous renseignez un nom de fichier sans chemin, ce fichier sera généré dans le répertoire de l’instance.
Si vous renseignez un chemin de fichier, celui-ci doit être accessible du serveur exécutant le processus.
Descripteur
Descripteur d’exportation.
Onglet paramètres
Cet onglet permet de renseigner les paramètres de la requête
Valeur
Utilisez cette colonne si vous renseignez une valeur constante.
Expression
Utilisez cette colonne si vous renseigner une expression qui sera évaluée à l’exécution.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Activité : Exécuter un traitement métier
Cette activité permet d’exécuter un traitement métier. Les traitements métiers sont des traitements de l’application utilisable dans les processus métier et dans l’automate.
Onglet Propriétés
Base de données
Base de données sur laquelle s’effectue le traitement. Renseignez cette base si elle diffère de la base de données sur laquelle l’instance du processus est exécutée.
Tâche
Sélectionner le traitement à réaliser.
Configurer la tâche
Ce bouton exécute l’écran permettant de configurer la tâche. Terminer l’écran en cliquant sur le bouton [Planifier].
Les évènements et activités techniques
Onglet « Systèmes »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/Evènement initial fichier et Evènement fichier
Ces évènements attendent qu’un fichier du système d’exploitation soit présent.
Fichier
Chemin du fichier concerné.
Les chemins du fichier doivent être accessibles depuis le serveur exécutant le processus.
Action
Action sur le fichier détecté.
Aucune
- Aucune action n’est effectuée.
Renommer
- Le fichier est renommé. Le nouveau nom est l’ancien nom ajouté d’une extension numérique.
Déplacer
- Le fichier est déplacé à l’emplacement indiqué par la zone Destination.
Supprimer
- Le fichier est supprimé.
Préfixe des paramètres
Préfixe des paramètres copiés dans les paramètres de l’instance. Les paramètres sont :
fiename : nom du fichier destination.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Exécution d’un programme exécutable (exe)
Cette activité exécute un programme du système d’exploitation.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Exécution d’un fichier de commande (batch)
Cette activité exécute un fichier de commande du système d’exploitation.
Onglet Propriétés
Fichier de commande
Chemin du fichier de commande à exécuter.
Paramètres
Paramètres passé au fichier de commande. La règle de passage des paramètres est celle du système d’exploitation.
Mode d’exécution
| Ne pas attendre la fin de l’exécution. | Dans ce mode l’activité n’attend pas la fin de l’exécution du fichier de commande'.' 'L'a séquence '« 'Succès' »' est enchaînée. |
| Attendre la fin de l’exécution. | Dans ce mode, l’activité attend la fin de l’exécution du fichier de commande. La séquence « Succès » est enchaînée. |
| Attendre la fin de l’exécution et tester la valeur de retour. | Dans ce mode, l’activité attend la fin de l’exécution du fichier de commande. Elle teste ensuite la valeur de retour pour déterminer la séquence suivante. Si la valeur de retour correspond à la valeur renseignée alors la séquence est « Succès ». Dans le cas contraire, la séquence est « Echec ». |
Les évènements et activité de maintenance
Onglet « Outils »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Epurer le journal
Cette activité permet de supprimer les éléments contenus dans le journal
Onglet propriétés
Epurer les enregistrements antérieurs à
Sélectionne la période d’épuration.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Epurer les évènements
Une activité particulière permet d’épurer les évènements métiers devenu obsolètes.
Les évènements obsolètes sont tous les évènements de date antérieure à la plus petite date d’exécution des machines.
Une conséquence de cette règle est que si une machine a été arrêtée à un instant T, tous les évènements de date supérieure à cet instant ne peuvent pas être épurés.
Cette activité n’a pas de paramètres, elle épure tous les évènements inutiles.
Les évènements et activité de communication
Onglet « Communication »
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Transfert de fichier via FTP (Upload)
Cette activité permet de transférer un fichier vers un serveur FTP.
https://frp.sage.fr/wiki1000/medias/images/guide_-_processus_metiers/ Transfert de fichier via FTP (download)
Cette activité permet de recevoir un fichier d’un serveur FTP.
Serveur
Adresse du serveur FTP.
Port
Port du serveur FTP (21 pour un serveur standard).
Login
Utilisateur du serveur FTP.
Mot de passe
Mot de passe de l’utilisateur du serveur FTP.
Répertoire FTP
Répertoire FTP dans lequel il faut se positionner avant le transfert. S’il n’existe pas, il sera créé. Il est possible d’indiquer un chemin en séparant les éléments par le séparateur « \ » sous Windows.
Nom du fichier FTP
Nom du fichier dans le répertoire du le serveur FTP.
Fichier
Fichier à envoyer ou recevoir. Si le nom est relatif le fichier sera retrouvé ou placer dans le répertoire de l’instance du processus.
Propriétés d’un serveur de processus
Pour afficher la fenêtre de propriétés d’un serveur de processus, sélectionnez la commande Propriétés du menu contextuel du serveur de processus métier.
Onglet « Propriétés »
Nom du serveur
C’est le nom du serveur de Processus Métier. Lorsque le serveur de processus est exécuté sur un Service Ligne 1000 ce nom doit correspondre au nom de la machine physique qui exécute le Service ligne 1000.
Nom du service
Il s’agit du nom du Service Ligne 1000.
Si le nom du serveur est localhost le serveur est considéré comme étant un serveur local. Un serveur local est utile lors de la phase de mise au point pour exécuter des machines à l’intérieur de l’application Desktop.
Onglet « informations »
L’onglet « Informations » donne des informations sur la configuration du serveur et l’état de celui-ci.
Propriétés d’une machine
Pour afficher la fenêtre de propriétés d’une machine, sélectionnez la commande Propriétés du menu contextuel de la machine.
Onglet Propriétés
Nom du moteur
Identifie le moteur.
Base de données
Les évènements métiers pris en compte par la machine sont filtrés sur cette base de données. Si la base de données n’est pas renseignée, toutes les bases de données enregistrées dans le framework lors de l’exécution sont prises en comptes.
Délai de Cycle
Délai en millisecondes entre chaque étape de la machine.
Synchronisation
Intervalle en nombre de cycles entre deux synchronisations des évènements métiers. La synchronisation des évènements métiers consiste à lire la table des évènements métiers pour prendre en compte les nouveaux évènements. Couplé au paramètre « Délai de Cycle », ce paramètre conditionne la fréquence des requêtes effectuées par la machine dans la table des évènements.
Exemple
Avec un délai de cycle de 1 seconde et un pas de 1 seconde la machine exécutera une requête par seconde. Avec un pas de 10 la machine exécutera une requête toutes les 10 secondes.
Renseignez 0 pour indiquer aucune synchronisation. Ce cas est utile pour une machine hébergeant des processus techniques n’ayant aucune interaction avec les évènements métiers.
Sauvegarde toutes les
Indique le délai minimum entre deux sauvegardes.
En cours d’exécution la machine effectue une sauvegarde de son état si un état a changé au cours d’un cycle et si le délai avec la dernière sauvegarde est supérieur à cette valeur.
Date de synchronisation
Cette date indique la date de synchronisation de la machine. La date de synchronisation est la date au delà de laquelle les évènements sont pris en compte.
Séquence d’évènement
Cette information indique le numéro de séquence du dernier évènement pris en compte.
Onglet « Commentaire »
Dans l’onglet « Commentaire » vous ajoutez des informations utiles à la compréhension du moteur.
Onglet « XML contenu »
Cet onglet affiche le script xml.
Propriétés d’un processus métier
Pour afficher la fenêtre de propriétés d’un processus métier, sélectionnez la commande Propriétés du menu contextuel du processus.
Cette boîte de dialogue concerne les processus en cours de conception et non les Processus en cours d’exécution. Lorsqu’un processus métier est exécuté, les copies exécutées ne sont pas impactées par ce dialogue.
Voir le § « ».
Onglet propriétés
Nom du processus
Nom identifiant le processus.
Version du processus
Un processus est identifié par la combinaison de son nom et de sa version.
Il est possible d’exécuter simultanément plusieurs versions de processus.
Ce processus métier est désactivé
Un processus métier désactivé ne démarre plus de nouvelle instance.
Enregistrer dans journal
L’enregistrement de l’exécution d’une instance s’effectue lorsque l’instance ce termine. Décochez cette option si vous ne voulez pas garder trace de l’exécution.
Nombre maximum d’exécution
Indique le nombre d’instance que peut démarrer le processus. Si le nombre est à -1, le nombre d’exécutions est illimité. Les exécutions devront être stoppées au niveau du processus.
Nombre maximum d’instances simultanées
Indique le nombre maximum d’instances du processus pouvant s’exécuter simultanément. Lorsque ce nombre est atteint, le démarrage de nouvelles instances est temporisé.
Délai d’attente maximal
Indique le délai d’attente maximal par défaut pour toutes les activités. Une valeur « 0 » indique qu’aucun délai d’attente n’est pris en compte. Il est possible de définir ce délai au niveau de chaque activité.
Onglet « Commentaire »
Dans l’onglet « Commentaire » vous ajoutez des informations utiles à la compréhension du processus.
Onglet « Attributs »
Cet onglet permet de définir les attributs du processus.
Les attributs sont des variables pouvant être manipulés dans les activités du processus. Il est aussi possible de définir dynamiquement de nouveaux attributs lors de l’exécution des instances. L’intérêt de prédéfinir les attributs à ce niveau est d’avoir ensuite la possibilité de les manipuler dans les interfaces de conception. En effet, si les attributs sont définis dynamiquement il ne sera pas possible de les utiliser par la suite dans es activités.
Onglet « Avancés »
Il est possible d’associer une classe métier au processus métier. Cette classe pourra être utilisée par certaines activités.
Créer un objet et Base de données : Ces propriétés servent à créer automatiquement un objet métier (persistant) lorsqu’une instance du processus est démarrée. L’objet est associé à l’instance du processus.
Onglet « XML contenu »
Cet onglet affiche le script xml.
Propriétés d’un processus en cours d’exécution
Pour afficher la fenêtre de propriétés d’un processus en cours d’exécution, sélectionnez la commande Propriétés du menu contextuel du processus.
Les informations modifiables dans cette boîte de dialogue sont identiques à celles de la fenêtre de propriétés d’un processus.
Propriétés d’une instance en cours d’exécution
Pour afficher la fenêtre de propriétés d’une instance en cours d’exécution, sélectionnez la commande Propriétés du menu contextuel de l’instance.
Onglet Propriétés
Identifiant :
Nom de l’instance.
Etat en cours :
Etat en cours d’exécution. L’état correspond à une activité.
Date de changement :
Date à laquelle cet état a été atteint.
Expire-le :
Date d’expiration de l’état quand un délai d’expiration est défini. « zéro » indique aucune expiration.
Onglet Messages
Cet onglet affiche tous les messages collectés par l’instance.
Onglet Paramètres
Cet onglet affiche toutes les valeurs des paramètres de l’instance.
Propriétés d’une activité ou d’un évènement
Toutes les activités ont une fenêtre de dialogue de propriétés. Celui-ci dépend de l’activité. En général ces dialogues incluent les pages suivantes.
Pour afficher la fenêtre de propriétés d’une activité ou d’un évènement, double-cliquez sur l’activité ou l’évènement concerné.
Pour plus de détails sur la fenêtre de propriétés d’un évènement métier, reportez-vous au § .
