Propriétés de l'instance de flux

Les propriétés de l'instance Flow servent à l'échange de données entre les différentes tâches et les points de décision afin de mettre en œuvre la fonctionnalité métier souhaitée.

Introduction

Une « Exécution » ( URL ) est générée par le système une fois qu'un flux spécifique a été orchestré et publié, conformément aux instructions décrites dans la section « Gestion du Flow Designer ». Une nouvelle instance du flux est générée à chaque fois que l'on clique sur l' URL. Pour chaque instance de ce type, un ensemble de propriétés par défaut ou intégrées est renseigné. Outre les propriétés par défaut, la tâche utilisée permet d'ajouter une série de propriétés personnalisées.

Ces propriétés servent à l'échange de données entre différentes tâches et différents points de décision afin de faciliter la mise en place de la fonction métier appropriée.

Propriétés de l'instance de flux

Consultez la liste suivante des propriétés par défaut qui sont initialisées à chaque fois qu'une instance est déclenchée.

Nom d'attribut Descriptif Type
__tenantid Le nom du locataire auquel appartient l'utilisateur. Chaîne
__locale L'ensemble des préférences relatives à la langue ou au pays pour une interface utilisateur. Chaîne
status Le statut de la tâche (réussite ou échec). Chaîne
statusDetails La description de l'état de la tâche. Chaîne
error Objet permettant de récupérer les détails relatifs aux erreurs rencontrées par le flux. JSON
themeId L'UUID d'un thème personnalisé que l'utilisateur souhaite configurer pour le flux. Il doit être déclaré en tant que paramètre de requête au moment où l' URL du flux est déclenchée. Chaîne
user Les informations relatives à l'utilisateur ont été extraites du CD. SCIM
Remarque :
  • Au cours de l'exécution des tâches, les paramètres de sortie de certaines tâches sont ajoutés au contexte du flux de travail.
  • Le statut des propriétés, les détails du statut et les erreurs sont réinitialisés au début de chaque tâche. Dans le cas de Page, il est possible d'utiliser ces valeurs pour afficher l'erreur correspondante ou les détails de l'état à l'utilisateur.
  • L' URL d'exécution peut être enrichie à l'aide de paramètres de requête supplémentaires afin d'ajouter de nouvelles propriétés à celles par défaut.
  • Les champs de saisie configurés dans la tâche « Page » sont également conservés dans l'instance du flux. <input type="text" name="username"></input> Par exemple, si une tâche de page comporte un champ de saisie, la propriété « username » est enregistrée dans l'instance du flux, ce qui correspond au nom saisi dans ce champ
Veuillez vous reporter à la liste suivante des propriétés soumises à autorisation.
Nom d'attribut Descriptif Type
applicationId L'identifiant de l'application pour laquelle l'accès est demandé. Chaîne
requestorId L'identifiant de l'utilisateur qui a demandé l'accès. Chaîne
requestId L'identifiant de la requête générée lors de l'exécution des tâches d'approbation. Chaîne
entitlementId L'identifiant du droit pour lequel l'accès est demandé. Chaîne

Propriété d'erreur dans l'instance de flux

Si le flux rencontre une erreur au cours de son exécution, une propriété d'erreur est générée dans l'instance du flux. L'erreur est de type JSON.

En cas d'erreurs irrémédiables, le flux est redirigé vers la page d'erreur par défaut et l'instance est fermée. En cas d'erreur récupérable, c'est à l'utilisateur de décider de la suite à donner. La décision peut être prise à partir des adresses messageId,, messageDescription, ou taskName, indiquées dans la propriété « error ».

Lorsqu'une tâche spécifique rencontre une erreur, son statut est failed.

Utilisation des propriétés lors du rendu des modèles

Tout comme pour les autres tâches, les propriétés de l'instance de flux sont disponibles lors de l'exécution de la tâche Page. Ces propriétés peuvent être utilisées pour remplacer les macros et générer des pages d'erreur ou des formulaires de saisie pertinents, nécessaires dans différents cas d'utilisation. Ces propriétés peuvent être utilisées comme macros de la manière suivante : @context.propertyName@.

La macro peut être écrite comme suit lorsqu'une propriété spécifique est imbriquée : @context.propertyName.nestedPropertyName@.

Prenons l'exemple d'une propriété d'erreur. Pendant la conception du flux, on peut accéder à la propriété comme suit : @context.error@. De même, on peut accéder à l' messageId s relatives à l'erreur en utilisant : @context.error.messageId@.

L'utilisateur peut accéder au n-ième nœud de la propriété via une macro en définissant le nom de la propriété, suivi d'un «. » servant de délimiteur.

Remarque : si une macro non valide est utilisée, pour une raison quelconque, celle-ci s'affiche telle quelle et n'est pas remplacée par une chaîne valide.