Versions Compared

Old Version 34

changes.mady.by.user David Palacios

Saved on

compared with

New Version Current

changes.mady.by.user David Palacios

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

1Listed options under Report Design Manager page.
2

This type of renderer should always be a default output option for any user-defined report.

3Expected output

Delimited Text Report Renderer

The Report Designs section has two types of Delimited Text Report Renderer: CSV Report Renderer and TSV Report Renderer and they share the following characteristics:

  • Both handle multiple data set definitions. If only one Data Set Definition is being used then the final output will be a cvs, tsv or a user-defined file extension file. In case that the Report Definition has more than one data set, then the output will be a zip containing all of the delimited text files (csv, tsv or user-defined) for each data set (see examples below).
  • The user can easily change what delimiters should be used when rendering the data. Please keep reading to learn more about this.

CSV Report Renderer

This comma-separated value renderer will allow you to export the data of your report to a flat file suitable for importing into Excel, SAS or another external analysis tool. The main characteristics of this renderer are:

...

a flat file suitable for importing into Excel, SAS or another external analysis tool. The main characteristics of this renderer are:

  • It allows you to change the filename extension of the final file.
  • Even when the output is pre-configured to be a comma-separated value file, the user can change both the field delimiter and text delimiter (see examples below).
1Select the CSV option from the drop-down list and click on the Add another button.
2

On the configuration page, only the description field is optional.

The filename extension, field delimiter and text delimiter fields have default values.

3If you run your report, the new added design will appear as an output option of the Report Definition you previously linked it to and it will be added to the list displayed on the Report Designs Manager page as well.
4Running the same report used earlier in the Default Web Renderer example, the expected output should be a file with csv extension containing columns separated by a comma and with a text delimiter which is the closing quotation mark (the text delimiter is the character that follows a field, in this example the field is composed of the opening quotation mark and the word: type).
5Now let's say you would like your fields to be separated by a dash, then you would have to modify the field delimiter like this:
6Then the expected output file is a character-separated value (the character is a dash).Image Removedvalue (the character is a dash).Image Added
7In case that your report has more than one Data Set Definition, then the output will be a zip of delimited text files (csv files for this example).Image Added

TSV Report Renderer

There’s not much difference between the CSV  and TSV (tab-separated value) renderers, both share the same characteristics. The main discrepancy is that the user cannot change the field delimiter value which always will be a Tab. The filename extension and the text delimiter are the only fields that can be modified.

1The Field Delimiter value will always be a Tab.
2If you run your report, the new added design will appear as an output option of the Report Definition you previously linked it to and

it will be added to the list displayed on the Report Designs Manager page as well.



3The expected output is a file with tsv extension and the columns are separated by a tab with a text delimiter which is the closing quotation mark (the text delimiter is the character that follows a field, in this example the field is composed of the opening quotation mark and the word: type).
4In case that your report has more than one Data Set Definition, then the output will be a zip of delimited text files (tsv files for this example).Image Added

HTML Report Renderer

It is a very basic renderer that produces an HTML file that contains the data of your report. Its main characteristics are:

...

SectionConfiguration and Access InformationExamples
Expressions
NameConfigurationComments
PrefixDefault is #This value is required
SuffixDefault is #This value is required

Both will help to identify in the template pieces of text that are expected to be replaced with data.

If you stick  with the default values, then everything that is between the # character will be replaced:

#myDataset.myValue#

You can change to the Suffix and Prefix to be an character, for example the $ character, then you should be able to access your data in your template this way:

$myDataset.myValue$

Repeating Sections

The output data of your report might have rows and columns of information instead of just having one single value. If this is your case, then you should configure Repeating Sections to access all of your rows and/or columns.

As a side note, if the data of your report has a lot of rows and columns, might be possible that the XLS Report Renderer  is more suitable for you.

The following options literally mean if a sheet | row | column should be repeated in a template.

NameConfigurationComments
SheetNumber of the sheet to be repeated.This option should be a number and not the name of the sheet.
RowNumber or range of numbers separated with a dash that indicates the rows to be repeated. 
ColumnNumber or range of numbers separated with a dash that indicates the columns to be repeated. 
DatasetName of the Data Set the sheet | row | column option should work with.if you work with any of the options above, you should explicitly indicate which Data Set should be used to render and which sheet for the row and column options.

For the following examples let's assume that our report output the following table using the encountersByType key as name for the Data Set Definition:

Option NameWhat we wantWhat our template should haveWhat our configuration should haveWhat to expect
SheetA sheet for each type of Encounter.
RowOne row in our template for each row in the output data.

We only want to repeat the row number 5, if we want to repeat also the heading of the row ( Type and Num ) then we should indicate this in our configuration by typing 4-5 instead of 5.

Notice that along with the row number we should indicate the sheet number, even if we don't want the output shown in the sheet example.

ColumnOne column in our template for each type.
Designing Properties

You can define any key-value property that your template might need.

NameConfigurationComments
KeyTo identify the property.In the template you can access any property by suffixing its key to the word "property".
ValueValue for the property defined. 
What we wantWhat our template should haveWhat our configuration should haveWhat to expect
Define a property named "customReportTitle" that contains a title for my report.
Miscellaneous
  • About Indicator Data Set Definition:
    • if If the output data of your report contains only a single Data Set Definition of type Indicator then its values can be accessed via its indicator number. For example: #1.A#.
    • But if the report contains multiple Data Set Definitions then indicator values must be prefixed with the Data Set Definition name.  For example: #myDataSet.1.A#

    • Since Reporting 0.7.2.2 you can specify the number of trailing digits. Assume an Indicator Data Set Definition whose output is single value(5 for this example):

      AddOutput
      #1.A|0#5
      #1.A|1#5.0
      #1.A|2#5.00
      #1.A|3#5.000
  • Parameters:

    • Every parameter to the report is available by its name prefixed with the word "parameter". Additionally, if this parameter is of type date you can formatted the output by adding a Java date and time patterpattern String:

      AssumeIn the templateExpected output
      A date whose key value is "endDate" is asked to the user.
      		Without any format:
      With a Java date and time patterpattern:

  • Contextual information:

    VariableDescription
    #context.generatedBy#Contains the name of the user who generated the report. In some setups, this will be the default scheduled program user.
    #context.generationDate#Contains the date on which the report was generated and can be formatted as a parameter of type date.

     

     

...