Introduction

This article provides guidance to creating an HTML document in the Format as HTML ProClosedThe Format as HTML Pro tool is used to create a task step that produces single or multiple HTML documents. You can choose to create the HTML template from scratch or import a pre-existing template. Recordsets and other task step properties can also be used to populate the HTML document to product dynamic content documents. These documents can then be consumed and then delivered by Output or Execute task steps. tool using a single recordset input. For a detailed description of how to handle multiple input recordsets, see How to use Multiple Recordsets in Format as HTML Pro.

As the Format as HTML Pro tool has been designed for users with a moderate-to-advanced level of knowledge of HTML, this article does not go into detail about creating the HTML document; however, specific BPA Platform-related information is provided.

Creating the Task Step

Note: This procedure assumes you have a task with an existing step capable of outputting a recordset that can be consumed by the Format as HTML Pro tool. For a list of tools outputting to or consuming from this tool, refer to the product help (Format as HTML Pro Technical Summary).

The Format as HTML Pro tool does not require any global configuration; it can be immediately added to a task.

To add a new Format as HTML Pro step to an existing task, do the following:

  1. Open the relevant task (if creating a new task, see How to Create a Basic Task).
  2. Either:
Click and drag the Format as HTML Pro icon from the Task Browser to the task Design area.
From the task's Design tab, right-click on empty space and select New > Format > Format as HTML Pro.
  1. In the General tab, Name your task step.
  2. Go to the Data tab and configure the format of the data sources. If your interface does not show the Data tab, your task does not contain steps capable of outputting a recordset; you can go straight to the Design tab to create the HTML document there.
    1. Drag the relevant recordset to the Structure pane.
    2. Highlight the new recordset and select the relevant document output from the Document Generations Options pane.
    3. If generating a New Document when column changes or wanting to add sub-totals per group, you must have a group node. Group nodes control which records are returned; rather than saying "here is my data, group it" (recordset node as the parent to the group node), group nodes work in the opposite manner by saying "group the following data by these columns" (group node as the parent to the recordset). Right-click the newly added recordset to convert it to a group node.
    4. Rename the group node to a meaningful name so you can see its function at a glance.
    5. Because we converted the recordset node to a group, we now need to re-add the original recordset back to the data structure to ensure its records are available to the document, grouped accordingly. Drag it to the Structure as a child node to the group node.
    6. If sub-totals are required, these are added to the group node if one exists — the logic behind it being that a sub-total is generated for each group. If not using a group node, then you add the sub-total to the parent recordset. Right-click the required node and select Add Subtotals.
    7. If grand totals are required, you convert a recordset to the grand totals template — add another recordset as a child node to the group node if using one, or the parent recordset. Convert the new node to the grand total template.
    8. At this point, you can adjust the data displayed in the final HTML document in terms of removing unwanted columns or changing column headers. Highlight the recordset node and use the tools at the bottom of the interface to adjust
    9. Finally, you must ensure a relationship exists between each node to ensure the data is extracted correctly. Highlight each child node in turn and from the Relationship tab, ensure a link exists between the parent and child node's keys.

    For more information about the features and functionality available in the Data tab, refer to the product help (Introducing the Data Tab).

  3. Go to the Design tab to create the HTML template. The design area is a completely free-form area, allowing you to use any valid HTML elements as required. To use the recordset data you have constructed, drag required recordset nodes into the design area.
  4. Go to the Options tab and select the relevant error handling options for this task step.

  5. Click  to save the task step.