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 temporairement 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 de Rational Publishing Engine
    Variable Description
    _numéro_cellule Numéro de cellule dans une ligne actuelle. Si l'élément ne correspond pas à une cellule, la valeur est 0. Vous pouvez utiliser _cell_number depuis l'onglet Expression de données ou Expression de script.
    _id_élément Numéro d'élément au sein du canevas. Conservée en interne dans le canevas et utilisée pour le débogage. Vous pouvez utiliser _id_élément depuis l'onglet Expression de données ou Expression de script.
    _niveau_élément Niveau récursif d'un élément. Si aucune valeur n'est définie pour l'élément dans la propriété Niveau récursif de l'onglet Données, la valeur est 1. Vous pouvez utiliser _niveau_élément depuis l'onglet Expression de données ou Expression de script.
    _numéro_ligne Numéro de ligne dans une table actuelle. Si l'élément ne figure pas dans un élément de ligne, la valeur est 0. Vous pouvez utiliser _numéro_ligne depuis l'onglet Expression de données ou Expression de script.
    _sessionInfo Information de propriété d'exécution de la spécification de canevas ou de document. Sous l'onglet Expression de script, sélectionnez la variable _sessionInfo et entrez le script. Utilisez des guillemets vides sans valeur à l'intérieur afin de générer la valeur par défaut pour la propriété dans la sortie. Exemples de script :

    _sessionInfo.getDocspecProperty("property", "");
    _sessionInfo.getTemplateProperty("property", "");
    _sessionInfo.getDatasourceProperty("data_source_name","property", "");
    _sessionInfo.getOutputProperty("output_type","property", "");
    _sessionInfo.docspecVersion
    _sessionInfo.templateVersion
    _sessionInfo.engineVersion
    _sessionInfo.buildNumber

    Pour la variable getDocspecProperty, vous pouvez utiliser des propriétés de spécification de document existantes ou des propriétés de création de métadonnées personnalisées.

    _sessionLogger A des fins de débogage, vous pouvez afficher des messages d'information, d'avertissement, ou de débogage personnalisés dans le fichier %TEMP%\rpe\rpe.log, la vue Console ou la vue Problèmes. Les messages s'affichent à l'emplacement qui est défini dans le fichier log4j.properties.

    Le paramètre par défaut consiste à afficher les messages d'information dans la vue Console et non dans le fichier rpe.log.

    Sous l'onglet Expression de script, sélectionnez la variable _sessionLogger et entrez le script. Vous pouvez générer des entrées de journal de l'une des manières suivantes :
    1. _sessionLogger.debug(message)
    2. _sessionLogger.info(message)
    3. _sessionLogger.error(message)
    4. _sessionLogger.warn(message)

    Lorsque vous décidez ce que vous allez entrer comme message dans votre script, pensez à utiliser un paramètre callout visuel, par exemple vos initiales ou votre nom d'utilisateur, ainsi que des variables de votre canevas, afin de créer des messages significatifs.

    _sessionUtils Sous l'onglet Expression de script, vous pouvez utiliser cette variable afin d'exécuter une fonction sur le script appelé tidyXHTML. Cette variable est utile si vous remarquez des blocs d'espace blanc dans la sortie qui est créée par un codage XHTML incorrect. Grâce à la variable _sessionUtils, un argument de chaîne est traité et le code XHTML est nettoyé de sorte que l'espace en trop ne s'affiche pas dans la sortie.

    Exemple : _sessionUtils.tidyXHTML(text);

    Lors de l'utilisation de la variable _sessionUtils, sélectionnez également les options Entrée XHTMLt et Sortie XHTML sous l'onglet Expression de script.
    Remarque : Les canevas qui incluent cette variable peuvent être chargés dans de plus anciennes versions de Rational Publishing Engine, mais les scripts ne peuvent pas être correctement évalués.

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. Il doit utiliser des identificateurs Java™ ou JavaScript valides car ils sont utilisés dans les scripts. Règles pour les identificateurs JavaScript :
      • Ils doivent commencer par une lettre, un trait de soulignement (_) ou le symbole du dollar ($)
      • Les caractères suivants peuvent être des chiffres (0-9)
      • Les lettres sont sensibles à la casse
      • Des lettres ISO 8859-1 ou Unicode, telles que å ou ü, peuvent être utilisées
      • Des séquence d'échappement Unicode \uXXXX sous forme de caractères peuvent être utilisées
    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.


Retour d'informations