Utilisation de variables dans un workflow

Dans le workflow, plusieurs types de variables sont disponibles.

Certaines variables définissent, décrivent ou composent les éléments du workflow (tels que les activités du workflow). Certaines variables sont disponibles spécifiquement pour faciliter l’exécution d’un workflow (comme les variables de bloc-notes). Certaines variables définissent, décrivent ou composent les enregistrements de données manipulés par le processus de workflow (par exemple, les éléments d’un enregistrement Glide qui sont définis dans un fichier dictionary.xml décrivant un enregistrement, tel qu’un incident).

Variables d’activité

Les variables d’activité sont des propriétés spécifiquement associées à une activité de workflow.

Avant de commencer

Rôle requis : admin

Pourquoi et quand exécuter cette tâche

Il s’agit des entrées qui apparaissent sur la définition d’activité lorsqu’une activité spécifique est glissée sur le canevas du workflow. Ces variables sont des propriétés qui définissent, composent ou décrivent l’activité du workflow, ou le travail pour lequel il est conçu.

Les variables d’activité sont déclarées dans une liste connexe au sein de la définition d’activité du workflow.

Pour ajouter, afficher ou modifier une variable :

Procédure

1. Accédez à la Tout > Workflow > Définitions d'activités.
2. Sélectionnez une activité de workflow, telle que Approbation - Utilisateur.
3. Dans la section ou l’onglet Variables d’activité , ajoutez, affichez ou modifiez les variables. Les variables d’activité sont définies à l’aide des mêmes champs que le dictionnaire système.
   Remarque :

   Si vous définissez une nouvelle variable d’activité qui dépend d’une autre variable d’activité, placez le préfixe « vars. » avant le nom de la variable d’activité parente. Par exemple, si le champ enfant dépend d’un champ nommé parent, placez la valeur vars.parent dans le champ Dépendant .

   Pour contrôler la visibilité d’une variable d’activité sur le canevas du workflow une fois que l’activité a été glissée vers le canevas, utilisez une politique d’interface utilisateur sur la table wf_activity.

   Pour accéder aux variables ou leur affecter des valeurs au sein de l’activité de workflow, utilisez la variable vars de l’activité de workflow.

    activity.vars.variable_name = new_variable_value 

Variables d’entrée du workflow

Les variables de workflow sont des valeurs externes qui sont transmises à un workflow et référencées par celui-ci au cours de son exécution.

Avant de commencer

Rôle requis : admin

Pourquoi et quand exécuter cette tâche

Les variables de workflow peuvent être déclarées en externe dans un script et transmises dans un workflow principal, ou elles peuvent être déclarées dans un workflow principal et transmises en tant qu’entrées à un flux secondaire.

Remarque :

Il existe un type spécifique de variable d’entrée pour tout workflow déclaré par rapport à la table Élément demandé [sc_request_item]. Pour comprendre l’utilisation de ces variables, reportez-vous à la section Variables de catalogue de workflow.

Les variables de workflow sont déclarées dans un formulaire disponible à partir du menu de commande de l’éditeur de workflow.

Procédure

1. Accédez à la Tout > Workflow > Éditeur de workflow.
2. Modifier et extraire un workflow.
3. Sélectionnez le menu Activités du workflow, puis Modifier les entrées.
4. Sélectionnez une variable existante ou sélectionnez Nouveau.

   Notez le champ Nom de colonne . Utilisez cette valeur lors de l’accès à la variable à partir d’un script.

   Les variables du workflow n’apparaissent pas sur le canevas du workflow, elles ne peuvent être affichées que dans le menu Activité du workflow.

   Les variables d’entrée peuvent être utilisées dans les scripts. Pour accéder à une variable d’entrée à partir d’un script :

   var input  = workflow. variables. variableName //get the workflow variable identified by column name.

Attribuer des valeurs à des variables extérieures au workflow

Après avoir été déclaré dans un workflow, des valeurs peuvent être attribuées aux variables à partir desquelles le workflow est lancé.

L’exemple suivant montre comment la valeur d’une variable de workflow peut être définie dans un script include, une règle métier ou une action d’interface utilisateur :

 
//Declare an instance  of workflow.js 
var wf  = new Workflow ( ) //Get the workflow id 
var  wfId  = wf. getWorkflowFromName ( "Workflow Name" ) ; 
//Start workflow, passing along name : value pair(s) for mapping to variable 
//where input_var_name is the name of the variable declared in gear menu 
//and input_var_value is whatever that value should be for this execution of 
//workflow
wf. startFlow (wfId , null , "Workflow Name" , {input_var_name : input_var_value } ) ;

Un autre exemple qui démontre une façon plus lisible de passer plusieurs variables consiste à déclarer un objet, à ajouter les noms/valeurs à l’objet et à le transmettre :

//Declare an instance  of workflow.js 
var wf  = new Workflow ( ) 
//Get the workflow id 
var  wfId  = wf. getWorkflowFromName ( "Workflow Name" ) ; 
//Start workflow, passing along object containing name/value pairs mapping to inputs expected by the workflow 
var vars  = { } ;
vars. input_var_name1 = input_var_value1 ;
vars. input_var_name2 = input_var_value2 ; 
// add as many variables as your workflow is expecting, then pass the object
wf. startFlow (wfId , null , "Workflow Name" , vars ) ;

Affectation de valeurs pour les entrées de flux secondaire à partir de l’intérieur d’un workflow principal

Si un workflow qui accepte des entrées est appelé à partir d’un autre workflow, ces valeurs d’entrée peuvent être définies à partir du canevas de workflow dans l’interface utilisateur de l’activité de workflow. Chaque variable d’entrée déclarée pour un flux secondaire aura une zone de saisie de zone de texte affichée sur l’activité. Dans ces zones de texte, les variables peuvent être définies avec n’importe quelle valeur à partir du bloc-notes ou de l’enregistrement actuel.

Pour plus d'informations, voir Workflows utilisés comme flux secondaires.

Lecture de la valeur d’une variable d’entrée de workflow

La valeur d’une variable d’entrée de workflow est accessible partout dans le workflow qui accepte javascript en remontée pas à pas de l’objet de workflow actuel :

var readValue = workflow.inputs.variable_name;

Variables de bloc-notes du workflow

Stocker et partager des variables basées sur des chaînes sous forme de paires nom-valeur entre les activités de workflow.

Le bloc-notes est global à l’instance du workflow en cours d’exécution et, en tant que tel, est disponible de la même manière pour toutes les activités.

Déclaration

Le bloc-notes lui-même est automatiquement disponible pour un flux de travail en cours d’exécution et ne nécessite aucune déclaration spécifique. Les variables sont déclarées et stockées dans le bloc-notes simultanément en le référençant. Par exemple :

workflow.scratchpad.variableName = variableValue;

Affichage

Afficher les valeurs de bloc-notes d’activité à partir de la table Bloc-notes de l’historique de l’activité du workflow [wf_history_scratchpad]. Bloc-notes de l’historique de l’activité du workflow est également une liste incorporée dans les enregistrements d’historique des activités Worfklow.

Figure 1. Exemple d’enregistrements bloc-notes de l’historique de l’activité du workflow

Accès et affectation

Utilisez la notation d’objet JavaScript standard pour accéder aux valeurs de bloc-notes ou les affecter. Par exemple, utilisez ce format pour affecter une valeur variable de bloc-notes particulière.

workflow.scratchpad.variableName = variableValue;

Utilisez ce format pour affecter une variable JavaScript à une variable bloc-notes.

var myValue = workflow.scratchpad.variableName;

Variables actuelles

La base de données GlideRecord actuelle a lancé le workflow, soit par association à la table dans la table Propriétés du workflow, soit en étant associée à un élément de catalogue.

Déclaration

Les variables actuelles sont les colonnes définies dans le fichier dictionary.xml qui prennent en charge l’enregistrement de base de données. Il n’existe aucun moyen d’ajouter des variables à l’enregistrement actuel lors de l’exécution.

Affichage

Les variables d’un enregistrement actuel sont affichées sur les formulaires et listes Glide dans toutes les applications qui les utilisent.

Accès et affectation

Pour accéder aux variables ou leur affecter des valeurs au sein de l’activité de workflow, obtenez la valeur de l’enregistrement actuel en faisant référence à l’élément Glide.

var myVarValue = current.getElement(nameOfTheField);

ou

var myVarValue = current.fieldName;

ou

current.variableName.setValue( "A Variable Value");