Versions Compared

Old Version 15

changes.mady.by.user Ellen Ball

Saved on

compared with

New Version 16

changes.mady.by.user Ellen Ball

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

1. Define your Period Indicator Report, and make .  Make note of the numbers that you give to each Indicator indicator in your the report.  To the right, you will see that we have created a sample report with indicators numbered 1, 1.A, 1.B, and 1.C.  Running this report with the default "Indicator Web Report" view, confirms that this report runs and produces correct numbers for each of our our numbered indicators.

2.  Once you have configured your report, and know the names of each of your parameters and numbers of each of your indicators, you can build your the Excel-based template.  This involves a couple of steps.  In the first image to the right, we have used sample numbers to create the report in Excel in exactly the format in which we want it to appear.  We incorporate fonts, colors, borders, calculations, and even graphs which are calculated off our or indicator numbers when generated.

...

4.  In the Report Designs page, click on "Add Another" and you will get a dialog pop-up which will enable you to upload your design as seen in the first image to the right.  The fields should be completed as follows:

  • Name:  Whatever you provide here will be  is the display name of the Output Format you can choose when you run the report.  See below.
  • The Report Definition you choose should be  is the Report Definition that you just created
  • The Renderer Type should  should be an ExcelTemplateRenderer
  • For "Resource Files", you should upload your Excel Template here.
  • Save this.

...

  • | Image Modified Image Modified |

5.  Return to the "Run a Report" page, and choose the report that you just created.  You should now see the Excel template that you just uploaded available in the list of "Output Formats".  Running the report and choosing this format should produce an Excel Report output like the one shown to the right.


Available replacement values

...

  • Indicator Values:
      If
    • Only one DataSetDefinition:  If the report contains only a single DataSetDefinition (i.e. PeriodIndicatorReports), indicator values can be accessed via it's indicator number.  For example, #1.A#.
    • *Multiple DataSetDefinitions:  *If the report contains multiple DataSetDefinitions, indicator values must be prefixed with the DataSetDefinition name.  For example, #firstDataSet.1.A#
  • Parameters:
    • Every Parameter to the Report is available by it's name prefixed with "parameter.".  For example, #parameter.startDate#.
    • Date parameters may be formatted by passing a pipe-separated Java Date Format String.  For example #parameter.startDate|dd/MMM/yyyy#.
  • Design Properties:
    • Every Design property is available by it's name prefixed with "property.".  For example, #property.reportTitle#"
  • Additional Miscellaneous (including Contextual Information: )
    • #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 (can be formatted in the same was as a Date Parameter described above)