Build a Workbench Report

Overview

This pages describes how to build a Workbench Report which can summarize data across subjects.  

A report is set up on the design tab of the Report Update page using text, formatting toolbars and including tables, files, and/or charts.  The HTML is generated and located on the HTML tab. 

Prerequisite

A workbench report will typically include a summary table of subject data, a summary chart of subject data, and/or the contents of an uploaded file. 

Prior to designing a Workbench report:

  1. Create a Data Set in the Workspace and include the variables that will be summarized

    If any encounter variables are included be sure to include "Interval (Categorical)" from the Encounter System Variables as encounter variables must be grouped by the interval

  2. Create a Data View using the variables from the Data Set and specifying the aggregation method and grouping, if applicable
  3. Create a Table specifying the format to apply to the Data View
  4. Optionally create a Chart using a Data View
  5. Optionally upload files that should be included in the Report

Steps

  • Enter static text by typing directly into the Design tab which is the default tab when the Report Update page is opened

    Do not paste formatted content as you may get unexpected results when the HTML is generated.  Either type or past unformatted text (e.g., from Notepad) and use the formatting buttons for best results

  • Format the text by using the formatting toolbar buttons on the Design tab
  • Alternately the HTML can be accessed and edited through the HTML tab

    HTML knowledge is not required to build a report, but the HTML is available as an option

  •  When more than one column is needed, it is best for formatting to create a table
    • Click on the drop down arrow to the right of the table icon to select your table size
    • Insert, delete or merge cells of a table by right clicking in the applicable cell of the table and selecting the desired action
    • When working with a table there are additional formatting options available at the bottom of the layout section
    • When you click in a cell of a table, the formatting options at the bottom will apply to that cell only
    • To apply formatting to a row, click a cell in that row then click on TR in the gray section towards the bottom of the layout
    • To apply formatting to the table, click a cell in the table then click on TABLE in the gray section towards the bottom of the layout. 

      When a table is created a blank space is placed into each cell.  When that extra space is used with a variable it can affect the layout (for example, the variable may be slightly higher or lower then the other text in that row.  If that happens delete the extra space.

    • To specify a table, chart, or file in the report use the following format:  [[#EntityCode]]  where EntityCode is the code of the table, chart or file 

 To apply formatting to static text use the formatting buttons.  To apply formatting to variables use the Layout tab of the Variable Update window.