Adding or editing a custom Jasper report
Setting the report header information
Setting up the report criteria
Setting the available report output formats
Localizing the text for the report
Poetic allows you to set up your own custom reports in addition to the reports Poetic provides. Poetic's custom reports use the Jasper reporting tool. The reports are added to the list of Poetic reports on the Reports menu.
When you create the report, Poetic, creates a security setting for you to control access to the report. You must then use the security maintenance function to provide access to the report.
For the report criteria, you assign survey questions to the report.
For other text used for the report, Poetic automatically creates a list with the same name as the report. The list automatically includes values for the page titles, browser titles, and help text for the criteria and results pages. You can then add values for other localizable text in the report.
Each output format (HTML, PDF, etc.) that is available must have a Jasper report template (.jrxml) assigned to it. Each output format can also have a plugin class assigned to it.
On the Search Reports page:
The Report Maintenance page for the report displays.
To configure general information about the report, including the name and category:
| Report name | In the Report name field, type a unique identifier for the report. The identifier is a text string in all caps with the words separated by underscores. For example, MY_EVENT_REPORT.
After you save the report, you cannot edit the name. The name is saved into the REPORT_INFO table as the value of SECURITY_RESOURCE_NAME. Poetic also creates a security setting named for the name. So for our example, if the report name is MY_EVENT_REPORT, the security setting that controls the report is also MY_EVENT_REPORT. Poetic does not enable the security setting for any security role. You must use the security maintenance function to determine who can run the report. For information on configuring security settings, see Assigning security settings to security roles. Poetic also adds a list value to the reports list (REPORT_NAME). The list value uses the name as the list value code. You use this list value to localize the display name on the Reports menu. For information on customizing and localizing list values, see Editing and localizing list values. Finally, Poetic uses this value to create a list with the same name as the report. This list contains all of the text needed for the report, including:
The above items use the same list value code in all of the report lists. The list can also include any other localizable text used by the report. You will need to get the appropriate list value codes from the report template or the developer. |
| Display name | The default display name for the report. This is what displays on the Reports menu. This is also the default list value description for the report when it is added to the REPORT_NAME list. |
| Category | From the Category dropdown, select the report category the report belongs to. Each category becomes a section on the Standard tab of the Reports menu. |
| Max rows for download | In the Max rows for download field, type the maximum number of rows to include in a downloaded version of the report. |
| Description | In the Description field, type a longer description of the report and the how it is intended to be used. |
| Active | To make the report available to users based on the security setting, check the Active check box. |
| Can be scheduled | To allow users to schedule the report to run automatically, check the Can be scheduled check box. |
You can select up to 10 survey questions to use as the available criteria for the report. For each question:
To remove a question, click the Clear link for that row.
For information on configuring survey questions, see Adding and editing survey questions.
Each output format requires a JRXML template. It is recommended that you use a separate template for each format. The template for each format must be loaded into Poetic.
To upload a template:
The Template File Name column is updated to display the name of the file you uploaded.
To download a template to a file, click Download Template.
To allow users to select the output format, check the Active check box. At least one format must be active.
In the Plugin Class Name column, if you are using a custom plugin:
When you save a new custom Jasper report, Poetic creates a new list. The list name is the same as the report name (for example, MY_EVENT_REPORT).
This list is used to localize the text associated with the report. When the list is first created, Poetic automatically adds the following list value codes:
| CRITERIA.BROWSERTITLE | The browser title for the report criteria page. |
| CRITERIA.PAGETITLE | The page title for the report criteria page. |
| CRITERIA.HELPTEXT | The help text for the report criteria page. |
| RESULT.BROWSERTITLE | The browser title for the report results page, if the report is displayed on an HTML page. |
| RESULT.PAGETITLE | The page title for the report results page, if the report is displayed on an HTML page. |
| RESULT.HELPTEXT | The help text for the report results page, if the report is displayed on an HTML page. |
You can also add list values for other localizable text in the report. You will need to get the list value codes from the developer who generated the report template or plugin code.
To edit and localize the text for these values, click the Localize report text link at the top of the page. The link does not display when you create a new report, only when you edit an existing report.