Définition et affectation de variables

Lors de la conception d'un canevas, il peut être nécessaire de calculer des valeurs ou de rendre des attributs de données disponibles dans des contextes où ils ne le sont généralement pas. Dans ces cas là, vous pouvez définir des variables et leur affecter des valeurs. Ces valeurs peuvent correspondre à des données statiques ou des données disponibles dans le contexte actuel.

Pourquoi et quand exécuter cette tâche

Les variables peuvent être utilisées comme marques de réservation pour les données calculées lors de la phase d'exécution (affectations de variable) ou peuvent être fournies dans la spécification de document. Contrairement aux attributs de données, vous pouvez également utiliser des variables dans les pages originales.
Il existe deux types de variable :
  • Variables définies par l'utilisateur : elles sont définies par le concepteur du canevas. Une variable définie par l'utilisateur peut être interne ou externe.
    • Variables définies par l'utilisateur internes : spécifiez une variable comme variable interne pour effectuer des calculs ou stocker temporarairement des informations, telle qu'une variable permettant d'insérer des données dans les pages originales. Les variables internes ne sont pas affichées dans la spécification de document, de sorte que vous ne pouvez pas leur fournir de valeurs.
    • Variables définies par l'utilisateur externes : spécifiez une variable comme variable externe lorsque vous la fournissez avec une valeur. Les variables externes sont affichées dans la spécification de document. Voir Création d'une spécification de document.
  • Variables Rational Publishing Engine : les variables Rational Publishing Engine sont des variables internes qui peuvent être utilisées dans le canevas de document.
    Tableau 1. Variables internes
    Variable Description
    _id_élément Conservée en interne dans le canevas et utilisée pour le débogage.
    _niveau_élément Niveau récursif d'un élément.
    _numéro_ligne Numéro de ligne dans une table actuelle. Si l'élément ne correspond pas une ligne, la valeur est 0.
    _numéro_cellule Numéro de cellule dans une ligne actuelle. Si l'élément ne correspond pas une cellule, la valeur est 0.

Procédure

  1. Dans la vue Structure, cliquez sur Variables > Insérer > Nouvelle variable. La fenêtre Nouvelle variable s'ouvre.
  2. Entrez les détails sur la variable dans les zones suivantes :
    1. Nom : entrez le nom de la variable. Le nom de la variable doit utiliser des identificateurs Java ou JavaScript valides car ils sont utilisés dans les scripts.
    2. Description : entrez la description de la variable.
    3. Valeur par défaut : entrez la valeur de la variable.
    4. Accès : indiquez si la variable est interne ou externe à la liste.
      • Les variables internes ne sont pas affichées dans la spécification de document, de sorte que vous ne pouvez pas leur fournir de valeurs.
      • Les variables externes sont affichées dans la spécification de document ; vous pouvez leur fournir des valeurs.
  3. Pour affecter une variable à un élément :
    Conseil : Affectez des variables aux éléments de conteneur chaque fois que possible. La variable est appliquée aux éléments de l'élément de conteneur. Par exemple, vous pouvez utiliser une variable dans une table de sorte qu'une ligne soit créée pour chaque variable. Si vous affectez une variable à un élément de table, une table peut être créée pour chaque variable. Ces tables consécutives fusionnent parfois, mais elles peuvent également s'afficher comme des tables distinctes. Si vous ajoutez un élément de conteneur dans la table et faites glisser la ligne dans l'élément de conteneur, puis affectez la variable à l'élément de conteneur, une seule table est créée avec des lignes pour chaque variable.
    Elément de table avec élément de conteneur. L'élément de conteneur contient un élément de ligne avec trois éléments de cellule.
    1. Cliquez sur l'élément à l'aide du bouton droit de la souris, puis sélectionnez Données > Modifier les affectations. La fenêtre Editeur d'affectations s'ouvre.
    2. Cliquez sur Ajouter. La fenêtre Sélection d'une variable s'ouvre.
    3. Entrez le nom de la variable et cliquez sur OK.
    4. Cliquez sur OK dans la fenêtre Editeur d'affectations.

Résultats

La variable sélectionnée est définie et affectée à l'élément actuel.

Lorsque vous affectez une variable à un élément, cet élément affiche une icône icône Affectation des variables dans l'éditeur de contenu de canevas.

Elément de paragraphe avec une requête et une affectation de variable

Que faire ensuite

Conseil : Vous pouvez rechercher une liste des affectations de variable utilisées dans un élément en cliquant à l'aide du bouton droit de la souris sur l'élément auquel la variable est affectée et en sélectionnant Recherche > Références de variable dans l'élément. La vue Recherche s'ouvre et une liste des affectations de variable s'affiche. Vous pouvez cliquer deux fois sur une affectation de variable dans les résultats pour l'éditer.

Vous pouvez rechercher une liste des affectations de variable, des attributs et des requêtes utilisés dans un élément en cliquant sur ce dernier à l'aide du bouton droit de la souris et en sélectionnant Recherche > Toutes les références dans l'élément. La vue Recherche s'ouvre et une liste s'affiche. Vous pouvez cliquer deux fois sur un élément dans les résultats pour l'éditer.


Commentaires