Adding a JavaScript code element

Use a JavaScript code element for each block of code you are using in a template.
Restriction: New feature icon The JavaScript code element is available only in version 2 templates.

About this task

JavaScript can range from simple arguments to complex scripts.
  • For simple arguments, you can apply script to the content of an element, such as a Text element. Double-click the text element, select the Script expression tab, and enter a script.
  • For complex scripts, you can use this task to apply your script using the JavaScript code element.
There are benefits to using the JavaScript code element over the Script expression tab of an element:
  • You can reuse scripts from other users.
  • You can group calculations without worrying about the order of their execution.
  • You can create normal and complex data structures, such as collections, and continually add to them.
    Note: You cannot call the function defined in one JavaScript code element in another JavaScript code or Text element.

The JavaScript file utils.js is included in your installation files and in the predefined Central Management component files for you to use for simple JavaScript, like including the current date in report output.

To see a list of the existing JavaScript code in your template, click Template > Review JavaScript. The Search view opens and a list of elements that use JavaScript displays. Native filters are not considered JavaScript in this context. Native filters are not listed in the search results.

Procedure

  1. Save your template before starting to work with JavaScript.
  2. In the Palette view, select the JavaScript code icon JavaScript code element and drag it into the template content editor.
  3. Double-click the JavaScript code element.
  4. In the Script expression tab, select a variable from the tree to apply the JavaScript code to.
  5. Enter the JavaScript code by using one of these options:
    • Write a script manually in this window
    • Copy and paste a script from an outside editor into this window
    • Click Include script and selecting a file from your computer, a remote server, or from the Central Management component
  6. Optional: If you copied the script from XHTML, you can:
    • Select the XHTML Input option to allow the XHTML tags contained in the script to be edited.
    • Clear the XHTML Input option to remove all XHTML tags from the script.
    If you are copying rich text or using rich text in conditions, you must select the XHTML Input option.
    Important: Invalid XHTML fails document generations. Verify that your XHTML is valid before saving your changes.
  7. Optional: If you are generating the template into XHTML output, you can:
    • Select the XHTML Output option to parse the script and render the script as rich text.
    • Clear the XHTML Output option to treat the script as plain text.
    This selection applies to all of the data source attributes in the expression. You cannot mix plain text and XHTML in your script.

    If you are copying rich text or creating rich text on an ad hoc basis, you must select the XHTML Output option.

  8. After entering the script, click Test script to validate the code. If there are errors in your JavaScript, document generation might not complete successfully.
  9. Click OK to save the changes. The block of code collapses in the element. You can expand the code to view it in the template content editor.

Working in the JavaScript editor

Use the JavaScript editor to work on your script with colored formatting and line numbering.

Procedure

  1. Double-click the JavaScript code element. The Input code for JavaScript code element window opens.
  2. Optional: If you are including a new script from another file, click Include script and select a file from your computer, a remote server, or from the Central Management component. Click OK to close the window and double-click the element to open the Input code for JavaScript code element window again.
  3. Click Open in editor to enter the script in an Eclipse JavaScript editor. The script opens in a new editor tab as a temporary .js file and you can edit the JavaScript.
  4. Manage the script through the options in the Outline view.
  5. Save the changes.
  6. Close the temporary JavaScript editor tab. You are returned to the Input Code for JavaScript Code Element window.
  7. Click Test script to validate the code.
  8. Click OK to save the changes and exit the window.

Feedback