Ajout d'un élément de code JavaScript

Utilisez un élément de code JavaScript pour chaque bloc de code que vous utilisez dans un canevas.
Restriction : icône Nouvelle fonction L'élément Code JavaScript n'est disponible que dans les canevas version 2.

Pourquoi et quand exécuter cette tâche

JavaScript peut être composé d'arguments simples ou de scripts complexes.
  • Pour les arguments simples, vous pouvez appliquer le script au contenu d'un élément, tel qu'un élément Texte. Cliquez deux fois sur l'élément de texte, sélectionnez l'onglet Expression de script et entrez un script.
  • Pour les scripts complexes, vous pouvez utiliser cette tâche pour appliquer votre script à l'aide de l'élément de code JavaScript.
L'élément de code JavaScript présente des avantages sur l'onglet Expression de script d'un élément :
  • Vous pouvez réutiliser les scripts des autres utilisateurs.
  • Vous pouvez regrouper les calculs sans vous soucier de leur ordre d'exécution.
  • Vous pouvez créer des structures de données normales et complexes, telles que des collections, et les alimenter en permanence.
    Conseil : A partir de Rational Publishing Engine version 2.1, vous pouvez appeler la fonction définie dans un élément de code JavaScript dans un autre élément de code JavaScript ou une autre expression de script en définissant une propriété Script de bibliothèque dans le code du script. Pour définir la propriété Script de bibliothèque, accédez à la vue Propriétés de l'élément Code JavaScript et sélectionnez l'onglet Spécifique puis cochez la case Script de bibliothèque. Pour plus d'information sur la propriété de script de bibliothèque, voir Propriétés des éléments de code JavaScript.

Le fichier JavaScript utils.js est inclus dans vos fichiers d'installation et dans les fichiers prédéfinis du composant Document Builder pour que vous puissiez l'utiliser pour du JavaScript simple, par exemple, pour inclure la date du jour dans une sortie de rapport.

Pour afficher une liste des codes JavaScript existants dans votre canevas, cliquez sur Canevas > Réviser les scripts Java. La vue Recherche s'ouvre et une liste des éléments qui utilisent JavaScript s'affiche. Les filtres natifs ne sont pas considérés comme du JavaScript dans ce contexte. Ils ne sont pas répertoriés dans les résultats de la recherche.

Procédure

  1. Sauvegardez votre canevas avant de commencer à utiliser JavaScript.
  2. Dans la vue Palette, sélectionnez l'élément Code JavaScript icône Code JavaScript et faites-le glisser dans l'éditeur de contenu de canevas.
  3. Cliquez deux fois sur l'élément de code JavaScript.
  4. Dans l'onglet Expression de script, sélectionnez une variable dans l'arborescence afin de lui appliquer le code JavaScript.
  5. Entrez le code JavaScript à l'aide de l'une des options suivantes :
    • Ecrivez un script manuellement dans cette fenêtre
    • Copiez et collez un script à partir d'un éditeur externe dans cette fenêtre
    • Cliquez sur Inclure un script et sélectionnez un fichier sur votre ordinateur, sur un serveur distant ou dans le composant Document Builder
  6. Facultatif : Si vous avez copié le script à partir de XHTML, vous pouvez :
    • Sélectionnez l'option Entrée XHTML pour permettre l'édition des balises XHTML contenues dans le script.
    • Désélectionnez l'option Entrée XHTML pour supprimer toutes les balises XHTML du script.
    Si vous copiez du texte enrichi ou que vous en utilisez dans des conditions, vous devez sélectionner l'option Entrée XHTML.
    Important : Echec des générations de documents en raison d'un XHTML non valide. Vérifiez que votre XHTML est valide avant d'enregistrer vos modifications.
  7. Facultatif : Si vous générez le canevas dans une sortie XHTML, vous pouvez :
    • Sélectionner l'option Sortie XHTML pour analyser le script et l'afficher comme texte enrichi.
    • Désélectionner l'option Sortie XHTML pour traiter le script comme du texte en clair.
    Cette sélection s'applique à tous les attributs de source de données de l'expression. Vous ne pouvez pas combiner du texte en clair et du XHTML dans votre script.

    Si vous copiez du texte enrichi ou que vous en créez sur une base ad hoc, vous devez sélectionner l'option Sortie XHTML.

  8. Une fois que vous avez entré le script, cliquez sur Tester le script pour valider le code. Si votre code JavaScript contient des erreurs, la génération de documents peut ne pas s'effectuer correctement.
  9. Cliquez sur OK pour sauvegarder les changements. Le bloc de code est réduit dans l'élément. Vous pouvez le développer pour l'afficher dans l'éditeur de contenu de canevas.

Utilisation de l'éditeur JavaScript

Utilisez l'éditeur JavaScript pour travailler sur votre script avec une mise en couleur de la syntaxe et un assistant de contenu.

Pourquoi et quand exécuter cette tâche

La mise en couleur de la syntaxe spécifie la couleur et le style du code source JavaScript. Pour modifier les préférences par défaut, sélectionnez Fenêtres > Préférences > JavaScript > Editeur > Mise en couleur de la syntaxe dans Document Studio.

L'assistant de contenu affiche dans une fenêtre en incrustation une liste de possibilités pour compléter la ligne de code en cours. Pour l'activer, appuyez sur Ctrl + Espace.

Ceci est une capture d'écran de l'éditeur JavaScript.

Procédure

  1. Cliquez deux fois sur l'élément de code JavaScript. La fenêtre Code d'entrée pour l'élément de code JavaScript s'ouvre.
  2. Facultatif : Si vous souhaitez inclure un nouveau script à partir d'un autre fichier, cliquez sur Inclure un script et sélectionnez un fichier sur votre ordinateur, sur un serveur distant ou dans le composant Document Builder. Cliquez sur OK.

    Pour un fichier sélectionné sur votre ordinateur ou sur un serveur distant, une copie du code JavaScript du fichier s'ouvre dans l'éditeur JavaScript.

    Pour un fichier sélectionné dans Document Builder, la fenêtre Utiliser la référence du script s'ouvre. Vous devez indiquer si le JavaScript doit être inclus sous forme de lien de référence dans le canevas :
    • Si vous sélectionnez Oui, le lien vers le fichier JavaScript (.js) est inclus dans une balise <Script>. Par exemple, le lien de référence suivant est ajouté dans l'éditeur JavaScript et vous ne devez pas le modifier :
      <Script src= "library://api/scripts/51"></Script>
      A faire : Lorsque vous exécutez la génération de document à partir du canevas, si celui-ci contient un JavaScript sous forme de lien de référence, Document Builder doit être en fonctionnement et connecté à Document Studio. Pour plus de détails, voir la rubrique Connexion au composant Document Builder.
    • Si vous sélectionnez Non, une copie du code JavaScript du fichier sélectionné s'ouvre dans l'éditeur JavaScript.
  3. Facultatif : Cliquez sur Ouvrir dans l'éditeur pour entrer le script dans un éditeur Eclipse JavaScript. Le script s'ouvre dans un nouvel onglet de l'éditeur en tant que fichier .js temporaire ; vous pouvez éditer le JavaScript et gérer le script avec les options de la vue Structure. Une fois que vous avez fini de modifier le script, enregistrez vos modifications et refermez l'onglet JavaScript temporaire de l'éditeur pour reveir à la fenêtre Code d'entrée pour l'élément de code JavaScript.
  4. Cliquez sur Tester le script pour valider le code.
  5. Cliquez sur OK pour sauvegarder les changements et fermer la fenêtre.