Managing User Reports and Report Parameter Files

<< Click to Display Table of Contents >>

Navigation:  Professional > Reports > How To >

Managing User Reports and Report Parameter Files

There are two options for saving report parameters in EQuIS Professional: User Reports and report parameter files.  

 

User Reports are saved to the database and may be opened when accessing the database from any location (given proper user permissions) including from EQuIS Enterprise. The User Reports toolbar provides easy access to existing User Reports, and options to save and delete User Reports. Report parameter files are external (*.xml) files that are saved locally to your hard drive, so they can only be accessed by you or shared with others for future use.

 

User Reports

 

User reports can be saved to the database for any published report. These are especially helpful for running reports in Enterprise or scheduling recurring reports using EIAs.

 

Save a User Report

 

1.User reports can only be saved for published reports. If your User Report toolbar is greyed out, this means that the base report is not published to the database. If that is the case, you will need to first publish the base report to the database.

2.Select the input parameters.

3.Enter the name of the User Report.

4.Click the User Report Save button located to the right of the report name field. A message will appear indicating success.

5.Select OK.

 

SaveUserReportSuccess

 

Once the User Report is saved, the name will display and the report will be available in the User Report drop-down list.

 

manage_user_reports

 

If the user changes any parameter(s) in the currently loaded User Report, that User Report name will be removed from display, since it is no longer representative of the selected parameters.

 

When a parameter of the base report (class type or dll reports) of a User Report has a macro default/Value (starting with $) and users do not click on it or change the value of the parameter when creating a User Report, the param_value from the parameter in the saved User Report is the macro defaultValue. If the user does click on it or change the value of the parameter during creation of a User Report, the selected or changed value of the parameter, rather than the macro defaultValue, is saved in the param_value of the User Report.

 

Update Existing User Report

 

1.Select the report from the User Report drop-down list.

2.Note or copy the exact name.

3.Edit the parameters as desired.

4.Manually enter the name of the existing report back in the User Reports name field.

5.Click the User Report Save button, located to the right of the report name field.

 

Delete User Report

 

1.Select the User Report from the drop-down menu.

2.Click Delete to remove the User Report from the display list and delete it from the EQuIS Database.

 

Make User Report use Excel Template File in Output

 

1.Navigate to the desired Excel Template file on your computer, save and take note of the file name (e.g. ARII_B30_template.xlsm).

2.Enter your Excel template name (e.g. ARII_B30_template.xlsm which will be used for a particular Analytical Results II (ARII)) User Report) into ST_USER_REPORT.XLT.

3.Upload the template file into the DT_FILE table of EQuIS Professional via the Docs&Photos Form.

4.Open the ARII Report and load the User Report.

5.Run the ARII Report and export the results to an Excel file, which will be generated from ARII_B30_template.xlsm.

 

Report Parameter Files

 

Report parameter files are external (*.xml) files stored locally for future use. User Report parameters can be saved as a *.xml file and opened in any database. The top report toolbar provides easy access to existing local report parameter files, and options to load and save new files (see image below).

 

manage_report_param_files

 

Save Report Parameter Files

 

1.Select input parameters.

2.Click Save.

3.Enter the file name when prompted.

4.Review the directory location and change, if desired.

5.Click Save.

 

Once the report parameters are saved, the name will display and it will be available in the Parameter files drop-down list for this report (see screenshot above). The list populates from the Current Working Folder as defined in EQuIS Professional Options (default = .Documents\My EQuIS Work\[database]\facility_name]); parameter files saved elsewhere are not available from the drop-down menu.

 

If the user changes any parameter(s) in the currently loaded parameter file, that file name will be removed from display, since it is no longer representative of the selected parameters.

 

Update Existing Report Parameter Files

 

1.Select the report from the Parameter files drop-down menu. Alternatively, use the Load selections button (folder icon) to the left to open a file from a directory other than the Current Working Folder for EQuIS Professional. Note the Load option is not currently linked to the Parameter files menu, so the field clears when this option is used to open parameter files.

2.Note or copy the exact name.

3.Edit parameters as desired.

4.Manually enter the name of the existing report back in the Parameter files field.

5.Click Save.

 

Revision History: In version 7.0, the revision below has been completed.

After users modify certain User Report parameters by manually typing a new value and then directly clicking on the Save selections to database as User Report button to save the change, the message, "The report '...' has been saved successfully" is displayed in a pop-up window. The change to the parameter is actually not saved and users will find this out when reloading the user report. The issue is fixed (Case 132098).

Troubleshooting

Foreign Key Constraint Error

If you receive an error message that begins with "The INSERT statement conflicted with the FOREIGN KEY constraint" when attempting to save a user report, this means that the published version of the base report (the report you are creating a user report from) needs to be updated. To correct this error you will need to republish the base report, and then you will be able to save your user report.

Parse Error

Some users may encounter an error message that begins with the following text:

System.ApplicationException ---> System.Runtime.Serialization.SerializationException: Parse Error, no assembly associated with Xml Key NewDataSet

This error indicates that you are attempting to use a saved User Report or a report parameter file created in one report in a different report. This includes reports created in a crosstab or graph report which should not be opened in the base report as this action will trigger the error above. To avoid this error, only use User Reports or report parameter files in the reports they were created in.