19.6. Assembling a Report

This section describes how to assemble your captured image and text data into a report interactively, within a batch run, or manually using the JavaScript interface.

19.6.1. Interactive Report Assembly

Follow these steps to assemble your report using the report generator GUI:

  1. Click on the HTML Report Assembler button.  

    Result: The HTML Report Assembler window appears, as shown:

    Figure 19.3:  HTML Report Assembler Window

    HTML Report Assembler Window

    Click on the buttons and thumbnail images in the left panel to add components to your report. The larger panel on the right is your work area, displaying the components that you have chosen to include in the report.


  2. Assemble the components of your report.

    Click on the buttons and thumbnail images in the left panel to add your captured images and text, and other components, as follows:

    Button or FieldPurpose
    TEXTInserts a text area allowing you to type HTML-formatted text into your report.
    HTML FILEInserts a specified existing HTML file.
    IMAGEInserts a specified image file (in PNG, JPG, JPEG or GIF format). The report assembler copies the image to your specified report directory and inserts a thumbnail image in the work-area panel.
    DYNAMIC DATAInserts a text area allowing you to type commands, the results of which appear in your report. The dynamic data becomes part of the HTML code written to the log file. The report generator also writes the ansys::report::interpdynamicdata command to the log file; the command must process the HTML code in order for the results of the command(s) to appear in your report.
    REPORT HEADINGInserts a specified title, author name and subtitle, and includes the current date. The heading component always appears at the top of your report.
    REPORT IMAGESInserts any or all of your captured images and animations. Move the mouse pointer over a thumbnail to see the caption that you assigned to the corresponding image or animation when you captured it. Click on any thumbnail image to insert the image or animation that it represents into your report.
    REPORT TABLESInserts a captured data table. A button appearing in this field is labeled with the first 15 characters of the caption that you assigned to the corresponding table when you captured it. Move the mouse pointer over a button to see the caption that you assigned to the corresponding table when you captured it. Click on a button to insert the table that it represents into your report.
    REPORT LISTSInserts a captured raw-data output listing. A button appearing in this field is labeled with the first 15 characters of the caption that you assigned to the corresponding listing when you captured it. Move the mouse pointer over a thumbnail to see the caption that you assigned to the corresponding listing when you captured it. Click on a button to insert the listing that it represents into your report.
  3. Preview and clean up your report, as follows:

    To perform this editing task ...Do this:
    Preview your reportClick on this button in the toolbar:
    Delete a report componentSelect (click on) the component that you want to delete, then click on this button in the toolbar:
    Change the order of the report componentsSelect (click on) the component that you want to move. Click on either of these buttons to move the component up or down, respectively:

    If your report contains a heading, it remains fixed at the top of the report.

    Change the caption of a report componentClick on the caption field that you want to change to place the cursor within the text. Type your changes directly into the field.
    Prevent Microsoft Internet Explorer (IE) from splitting a component between two pages during printingCheck the box labeled Insert page break for Microsoft IE for the appropriate component. This feature is especially useful after you have printed an initial draft of your report from within IE and determined how your printed report looks.

  4. Save your work.

    Select File> Save periodically (or File> Save and Close to save your report and close the report assembler window).

19.6.2. Batch Report Assembly

Issue the *CREATE command in batch mode to open and append HTML tags to your report file. By default, the report assembler uses the *CREATE command to write the report to the log file.

19.6.3. Report Assembly Using the JavaScript Interface

For maximum flexibility and usefulness, the report generator employs JavaScript, a coding language for Web browsers supported by Microsoft Internet Explorer and Netscape Navigator. JavaScript allows easy encapsulation of data and access to that data.

The report generator creates JavaScript functions (in form) as you capture image and text data. Therefore, rather than using the report generator's built-in report assembler, you can use the JavaScript functions to manually assemble your HTML-based report.

19.6.3.1. Inserting an Image

The following example JavaScript code creates an image in the HTML report that you are assembling. If the specified image is not available, your report will contain a message indicating the problem.

<script LANGUAGE="JavaScript1.2" SRC="ansysImages.js"> </script>
<script>
imgName('imgCaption');
</script>

Following is an explanation of the JavaScript code:

<script LANGUAGE="JavaScript1.2" SRC="ansysImages.js"> </script>

Loads the ansysImages.js file to provide the images. You must include this line of code at least once in your HTML document and before calling the imgName function. Typically, this line appears in the <HEAD> section of an HTML document.

<script>

The HTML tag to begin JavaScript code.

imgName

A unique image name as it appears in the ansysImages.js file.

imgCaption

The caption to display for the image. This value is a string and must be enclosed in single quotation marks. It can include HTML tags around the text as well. If not specified, the function uses the default image caption.

</script>

The HTML tag to end JavaScript code.

19.6.3.2. Inserting an Animation

The following example JavaScript code creates an animation sequence in the HTML report that you are assembling. If the specified animation is not available, your report will contain a message indicating the problem.

<script LANGUAGE="JavaScript1.2" SRC="ansysAnimations.js"> </script>
<script>
animName('animCaption',animTime, 'animDirect');
</script>

Following is an explanation of the JavaScript code:

<script LANGUAGE="JavaScript1.2" SRC="ansysAnimations.js"> </script>

Loads the ansysAnimations.js file to provide the animation sequences. You must include this line of code at least once in your HTML document and before calling the animName function. Typically, this line appears in the <HEAD> section of an HTML document.

<script>

The HTML tag to begin JavaScript code.

animName

A unique animation name as it appears in the ansysAnimations.js file.

animCaption

The caption to display for the animation sequence. This value is a string and must be enclosed in single quotation marks. It can include HTML tags around the text as well. If not specified, the function uses the default animation caption.

animTime

The time delay (in milliseconds) between each display of an individual image in the animation sequence. This value is limited by the capabilities of your computer hardware; therefore, a value lower than 500 typically has little effect on the animation. If not specified, the function assumes the default value of 500.

animDirect

The direction of play, as follows:

forward

After displaying the last individual image of the animation sequence, the function repeats the animation from the beginning (that is, starting with the first image and incrementing).

back

After displaying the last individual image of the animation sequence, the function repeats the animation in the opposite direction (that is, starting with the prior image and decrementing). After displaying the first image again, the animation repeats in the forward direction.

If not specified, the function assumes the default value of back.

</script>

The HTML tag to end JavaScript code.

19.6.3.3. Inserting a Data Table

The following example JavaScript code creates a data table in the HTML report that you are assembling. If the specified table is not available, your report will contain a message indicating the problem.

<script LANGUAGE="JavaScript1.2" SRC="ansysTables.js"> </script>
<script>
tableName('tableCaption');
</script>

Following is an explanation of the JavaScript code:

<script LANGUAGE="JavaScript1.2" SRC="ansysTables.js"> </script>

Loads the ansysTables.js file to provide the data table. You must include this line of code at least once in your HTML document and before calling the tableName function. Typically, this line appears in the <HEAD> section of an HTML document.

<script>

The HTML tag to begin JavaScript code.

tableName

A unique data table name as it appears in the ansysTables.js file.

tableCaption

The caption to display for the table. This value is a string and must be enclosed in single quotation marks. It can include HTML tags around the text as well. If not specified, the function uses the default table caption.

</script>

The HTML tag to end JavaScript code.

19.6.3.4. Inserting a Listing

The following example JavaScript code creates an output listing in the HTML report that you are assembling. If the specified listing is not available, your report will contain a message indicating the problem.

<script LANGUAGE="JavaScript1.2" SRC="ansysListings.js"> </script>
<script>
listingName('listingCaption');
</script>

Following is an explanation of the JavaScript code:

<script LANGUAGE="JavaScript1.2" SRC="ansysListings.js"> </script>

Loads the ansysListings.js file to provide the listing. You must include this line of code at least once in your HTML document and before calling the listingName function. Typically, this line appears in the <HEAD> section of an HTML document.

<script>

The HTML tag to begin JavaScript code.

listingName

A unique listing name as it appears in the ansysListings.js file.

listingCaption

The caption to display for the listing. This value is a string and must be enclosed in single quotation marks. It can include HTML tags around the text as well. If not specified, the function uses the default listing caption.

</script>

The HTML tag to end JavaScript code.


Release 18.2 - © ANSYS, Inc. All rights reserved.