Defining Interview Reports

Overview

Onyx can print reports about the interview to give to participant. The Onyx page includes a Print Reports button.  You must define the PDF files that will be printed.

Creating Custom Reports (PDF)

You should create a report in each of the languages that are required by your organization. At runtime, Onyx populates a dropdown list of the available report languages based on the report files that you have defined.

This procedure requires a single license for Acrobat Professional to prepare the report.

To create a PDF report

Repeat this procedure to create a PDF report for each language required by your organization.

1. Create a report in one of your required languages, using Microsoft Word or any tool of your choice.
2. Convert the form to PDF using a PDF converter.
3. Save the PDF using a name that includes the appropriate language code (and optionally, a country code). For example: ParticipantReport_en.pdf for the English version. See How to name report files below.
4. Edit the PDF using Adobe Acrobat Professional to include a text field wherever you want information to be supplied automatically by Onyx (for example, participant and interviewer information--see the table below).
   1. Set each field to read-only.
   2. Rename each field so it can be automatically completed by Onyx (see the table below; for example: Participant.fullName).
   3. Apply formatting to all fields that require it (using Acrobat field formatting; for example: date formatting).
   4. Select ADVANCED -> ENABLE USAGE RIGHTS IN ACROBAT READER in the top menu.
5. Save the PDF file.

How to name report files

The filenames of PDF reports must conform to this configurable naming scheme:

     basename_language_country.pdf

where,

• basename is a configurable prefix for the filename (ParticipantReport by default). It can be configured in the WEB-INF/config/jade/module-config.properties file in your project
• language is the two-letter ISO Language Code (ISO-639-1) code for the form's language (example: en for English, fr for French). See http://www.loc.gov/standards/iso639-2/php/code_list.php.
• country (optional) is a two-letter ISO Country Code (ISO-3166).  See http://www.iso.org/iso/english_country_names_and_code_elements.

Examples of valid report filenames:

• ParticipantReport_en.pdf

• ParticipantReport_fr.pdf

• ParticipantReport_fr_CA.pdf

Where to put report files

By default, the PDF files for reports should be located in the WEB-INF/config/jade/resources directory. Based on the report files in the resources directory, Onyx "discovers" the available languages and displays them at runtime. No further configuration is required.

You can change the resources directory by modifying this line in the WEB-INF/config/marble/module-config.properties file:

How to get Onyx to complete form fields automatically

At runtime, Onyx can complete fields in your reports automatically. The mapping between fields in the PDF file for the report and Onyx variables is defined in WEB-INF/config/jade/module-config.properties.  For a list of the Onyx variables that you can use in your report, see To view a list of Onyx variables.

Here is the field-to-variable mapping for the onyx-demo application:

Search Onyx Documentation