Report administrators can edit the settings associated with a client-specific report in Report Gateway, including its name, description, platforms, data sources, and other details. Report admins can also edit the parameters associated with a client-specific report, or download or re-upload a report.
To manage the settings for a report, follow these steps:
1. Open the Setup menu.
2. Select Reports.
3. Click the report name that you want to edit.
Note
To filter the list of reports, type an entry in the search box. Matching results display as you type.
4. The Edit report settings page appears. Under the General tab, edit the following fields:
▪ Platforms—Select the platforms on which the report will be available.
▪ Data Sources—Select one or more data sources to be included.
▪ Data Sources from Report Definition—This field is not editable, but you can refer to it to see the primary data source and any secondary data sources used by the report. The platform and database are listed for the user that is currently logged in. If a database is not mapped, it appears in red and displays the words "not mapped."
▪ Report Name—Enter a unique name to identify the report.
▪ Short Name or ID—Enter a descriptive name to identify the report.
Note
MRI Software recommends that you create a naming convention for Report Gateway reports so they do not overlap standard MRI report names.
▪ Description—Enter a description to display under the report name on the report run-time options.
▪ Report API—For Letter or Form Merge reports, this field determines the source of the data for the report.
▪ API Template Field Mapping—For Letter or Form Merge reports, this field can be used to replace field names used by the API entered in the Report API field with the field names used by the resulting form. Field mappings are entered in the following format: { "ApiFieldName:FormFieldName" }. Multiple field mappings must be separated by commas.
Example
If the API entered in the Report API field contains the fields "last_name" and "first_name", but the PDF or Word document uses the field names "LAST" and "FIRST" instead, you would enter the following text in the API Template Field Mapping field to replace the API field names with the form field names: { "last_name":"LAST", "first_name":"FIRST" }
▪ Unused Data Page—For Form Merge reports, enter a list of pages to remove if they do not contain any data. Data in this field is entered in the format pageNumber:dataField1,dataField2. Multiple page expressions can be separated by a semicolon (;). For example, you could enter 3:AdditionalLastName,AdditionalFirstName;5:AdditionalIncome to remove pages 3 and 5 when the associated fields are empty.
▪ Optional Pages—Enter a list of pages to designate as optional. When a user runs this report, they can select the Include Instructional Pages check box to include these pages, or leave it unselected to exclude them. Pages are entered in a comma-delimited list that allows for ranges; for example, to designate pages 1, 5, 6, 7, and 9 as optional, enter 1,5-7,9 in this field.
Note
Adjusting this setting automatically adds the MRI_OptionalPages parameter on the Parameters tab for this report. On the Parameters tab, you can modify the caption of the check box ("Include Instructional Pages") by editing the Label field. The parameter is automatically removed if you clear this field.
This option is available for Form Merge reports only.
▪ Tags—Enter or select any tags to attach to the report. Tags help other users find relevant reports.
▪ Report Groups—Select one or more report groups for this report.
Note
You must be an authorization or system administrator to see the Report Groups field.
▪ Application—Select the MRI application to which this report belongs. This enables the report for filtering by application on the Reports page in MRI for the Web.
5. Under the Parameters tab, review or edit the following fields:
▪ Parameter name—The name of the report parameter.
▪ Parameter type—The parameter types, as specified when the parameter was created.
▪ Label—Enter a label to describe this parameter on the report viewer. This field is defaulted from the .rdl file, but you can edit it.
▪ Control type—Select the type of control to use for this parameter. This field may be defaulted and/or limited depending on the parameter type in the .rdl file.
▪ Show this parameter conditionally—Select this option to display this parameter conditionally based on the value of a previous parameter. Then, select the parameter and value which will trigger the current parameter.
Note
This option is not available on the first parameter of a report, or for parameters which cannot be blank.
▪ Default Value—Enter the default value for this parameter, if applicable.
Note
The default value is used system wide, across data sources.
▪ Parameter API—Select an existing API containing the values for this parameter, or enter the name of a new API you have developed.
Note
Some control types may not require an API to populate them. Additionally, some parameters may state "This parameter has predefined values that cannot be overwritten" in place of the Parameter API field, indicating that you cannot change the available values for this parameter.
▪ Query string parameters—Select one or more report parameters to send to the Parameter API as query string parameters. This option allows the Parameter API to depend on the values of multiple other parameters.
Note
This field is only available for parameters with a Parameter Type of multi-valued.
6. Click Save. You are returned to the Manage Reports page.
To download a report file in .rdl format, follow these steps:
1. Go to Setup > Reports.
2. Select the report name that you want to download. The Edit report settings page appears.
3. Under the General tab, click Download. The .rdf file is downloaded by your browser.
To re-upload a client-specific report, follow these steps:
1. Go to Setup > Reports.
2. Select the report name that you want to upload. The Edit report settings page appears.
3. Under the General tab, click Re-upload.
4. Click Choose File, browse to the report file that you want to upload, and then click Replace.
5. Follow the steps in the Managing Client-Specific Report Settings section above to edit the fields under the General and Parameter tabs.