Utilisation de variables dans un workflow

Plusieurs types de variables sont disponibles dans le workflow.

Certaines variables définissent, décrivent ou composent les éléments du workflow (comme les activités de workflow). Certaines variables sont disponibles spécifiquement pour faciliter l’exécution d’un workflow (telles que 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 : administrateur

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 elle est conçue.

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. » devant 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 après que l’activité a été déplacée vers le canevas, utilisez une politique d’interface utilisateur sur la table wf_activity.

   Pour accéder aux variables ou leur attribuer des valeurs dans 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 transmises et référencées par un workflow au cours de son exécution.

Avant de commencer

Rôle requis : administrateur

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 à l’élément demandé de table [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 dans le menu de commande de l’éditeur de workflow.

Procédure

1. Accédez à la Tout > Workflow > Éditeur de workflow.
2. Modifiez et extrayez un workflow.
3. Sélectionnez le menu Activités du workflow, puis sélectionnez 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 de workflow n’apparaissent pas sur le canevas du workflow, elles ne peuvent être consultées que dans le menu Activité du workflow.

   Les variables d’entrée peuvent être utilisées dans des 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.

Affecter des valeurs à des variables provenant de l’extérieur du workflow

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

L’exemple suivant montre comment définir la valeur d’une variable de workflow 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 montre un moyen plus lisible de transmettre plusieurs variables implique de déclarer un objet, d’ajouter les noms/valeurs à l’objet et de 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 ) ;

Affecter des valeurs pour les entrées de flux secondaire à partir d’un flux de travail 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, soit à partir du bloc-notes, soit à partir 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 n’importe où dans le workflow qui accepte JavaScript par remontée pas à pas sur l’objet de workflow actuel :

var readValue = workflow.inputs.variable_name;

Variables de bloc-notes du workflow

Stockez et partagez des variables basées sur des chaînes en tant que paires nom-valeur entre les activités du 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 workflow en cours d’exécution et ne nécessite aucune déclaration spécifique. Les variables sont déclarées et stockées simultanément dans le bloc-notes en le référençant. Par exemple :

workflow.scratchpad.variableName = variableValue;

Affichage

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

Figure 1. Exemples d’enregistrements de 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 leur attribuer. Par exemple, utilisez ce format pour affecter une valeur de variable de bloc-notes particulière.

workflow.scratchpad.variableName = variableValue;

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

var myValue = workflow.scratchpad.variableName;

Variables actuelles

actuel est la base de données GlideRecord qui a démarré le workflow, soit par association à la table dans la table des propriétés du workflow, soit en étant associée à un élément de catalogue.

Déclaration

Les variables dans la tâche actuelle sont les colonnes définies dans le fichier dictionary.xml qui prennent en charge l’enregistrement de base de données. Il n’y a aucun moyen d’ajouter des variables à l’enregistrement actuel au moment 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");