Report and system administrators can upload a client-specific report to Report Gateway.
Note
If you need to add multiple client-specific reports, you may choose to upload them as a single package for convenience. Refer to the Upload package option on the Reports screen.
A single report file must be in Report Definition Language (.rdl) format. A client-specific report package must be a .zip archive containing .rdl files and other report metadata such as descriptions and tags.
The .rdl files must use the 2010 schema. To confirm this, examine the second line of the .rdl file. You should see '2010' in the report definition as follows: xmlns="http://schemas.microsoft.com/sqlserver/reporting/2010/01/reportdefinition"
Do not use MRI_ as a prefix for any parameters or other items within a .rdl file.
Be aware of what is included in your data source information in a .rdl file, so no passwords or other sensitive details are exposed.
MRI Software recommends that you use source control to store your .rdl files or otherwise manage them in a controlled manner so they are not overwritten or renamed unintentionally.
You cannot combine data from multiple data sources within a single report.
The report developer can determine whether to enforce entity class and site restrictions. This functionality is not provided by the Report Gateway platform; it is handled within individual reports. Entity class and site restrictions are enforced in all MRI-provided reports.
To upload a client-specific report, follow these steps:
1. Go to Admin Settings > Reports.
2. Click Add Report. The Add a Report page appears.
3. Under Upload Report File, click Choose File, and then browse to the report file that you want to upload.
4. Under Report Settings, complete the following fields:
▪ Platforms—Select the platforms on which the report will be available.
Note
Reports can only be associated with platforms of the same platform type.
▪ Data Source—Select one or more data sources to be included.
▪ 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.
▪ 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. Click Set up parameters. If the report has run-time options, the Report Settings page appears. The parameters are listed on the left, with the first parameter selected and its details displayed on the right.
Note
If the report does not have any run-time options, you are returned to the Manage Reports page.
6. For each parameter, under Parameter control, complete the following fields:
▪ 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.
7. For each parameter, under Available values, complete the following fields:
▪ 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 modify the available values for this parameter.
8. Click Save. You are returned to the Manage Reports page, and the new report is included in the list.