Report Parameter Editor

<< Click to Display Table of Contents >>

Navigation:  Enterprise > Interface >

Report Parameter Editor

For widgets that use data reports, the Report Parameter Editor is a tool to modify the parameter values for a selected report. On the Widget Editor screen, clicking the Edit Ent-Report_Edit-icon icon will open the Report Parameter Editor for the selected report.

 

Depending on which permissions the user has for the selected report, the Report Parameter Editor will allow the following actions: Download, View, Save, and Save As. If a user has both edit and create report permissions, both the "Save" and "Save As" buttons will display. If a user has at least view permission for the report, they will be able to run or download the report output. A user that does not have any permissions will not be able to see anything about the report.

Download – To export the report output, click on the Download button to open a drop-down menu with download options. The following file types are available for download:

.txt – Tab-separated text file containing the tabular data.

.csv – Comma-separated, double-quote delimited text file containing the tabular data.

.xlsx – Microsoft Excel workbook containing the tabular data.

.kmz – Google Earth kmz file containing Placemarks for each location and a balloon pop-up with the tabular data for that location.

.shp – A .zip file containing the Esri Shapefile (locations as features) and other related files (*.dbf, *.prj, etc).

.pdf – A Portable Document Format (PDF) file displaying the tabular data.

View – The view button will run the report and display the output in a grid format.

Save – A user with edit permission for the opened report will see the Save button, and clicking on it will overwrite the current report with changes to the report name or any of the report parameters.

Save As – A user with create report permission will see the Save As button. The Save As option will create a new report of the same type as the original report, and will use the selected parameter values. Change the name of the existing report and select the Save As button. The new report name will be checked, and if it is not unique, the user will need to edit the report name to be able to save the report. Selecting the Save As button opens the Explorer Widget tree, allowing the user to select which folder to save the report. The user report is saved to the root folder when no folder is selected.

 

 

Note: Clicking either Download or View causes the report to execute immediately. When Enterprise is hosted as an Azure Web App, the execution is limited to 240 seconds. Thus, large reports that take longer than 240 seconds to run will timeout. The 240 second limit on web requests is designed by Microsoft as a reasonable limitation on web requests to prevent DDoS attacks and to ensure that any one site is not consuming all of the available resources. This is not an EQuIS limitation.

 

Best practices for EQuIS Enterprise in Azure Web Apps include:

1.Limit the parameters of a report such that it runs under 240 seconds.

2.Run these types of reports as EIAs. EIAs run outside of the Azure Web App and are not subject to the 230 second execution limitation.

3.Run the reports in EQuIS Professional.

4.Enable workflow agent WebJobAsync to allow the report execution to run as a background process.

 

Enterprise sites running in Windows IIS server environments are NOT affected by this Azure web request timeout and the execution time out can be set by editing the web.config file entry "system.web/httpRuntime".

 

 

 

Note: Download links are available in the Report Parameter Editor and will allow the user to download a report based on the selected parameters. If the report has a facility parameter, the download links will not be shown until after a facility is selected, to prevent empty report output. These download links do not require the report to be saved.

 

Report Parameters

 

The parameters are grouped in a tree structure and each group node can be expanded to show all parameters by clicking on the name of the group. The images below provide an example of the Report Parameter Editor for an Analytical Results II report and selection of the Location and Sample groups.

Ent-Report_Parameter_Editor_Screen_example

Ent-Report_Parameter_Editor_LocationTab_example

 

Many reports include facility as an input parameter. Use the Facility Chooser to select a facility.

 

Hover over a parameter to display a remark tooltip, if one is available. Parameters that have associated values are displayed in italics. The parameter values are listed next to the parameter name. If no value is shown, then no value has been set.

 

To edit a parameter value, click on the parameter to open a window displaying available values or options, such as a calendar tool. Select desired value(s). Selected values will be highlighted and will be displayed at the top of the frame. Individual selected values can be removed by click on the X to the right of the value. Click the Clear All button to remove all values.

 

Ent-Report_Parameter_Editor_LocationTab_example2

 

Note: The Report Parameter Editor will list parameter selections alphabetically unless the report is explicitly changed. To have selected rows be sorted non-alphabetically, set ST_REPORT_PARAMETER.DISPLAY_TYPE = 'MultiSelectNonAlpha'. This display type option is the default setting for the ARII-ALEII Crosstab Report, which allows the report parameter selections for the Crosstab Column Headers, Row Headers and Tabbed Data to stay in the order that they were selected.

 

 

Note: Some report parameter values may be a macro value. These values will have a message indicating that they are based on other data, and may change at any time. For these values, the actual value that is saved is a query. Usually they are the default value for the type of report. Changing this value to any other value and changing back to the initial display value, will not restore the query as the saved value. The parameter will still indicate that it is a changed value.

 

 

There are six different types of parameter values.

Text – When editing this type of parameter, a text box is displayed with the current parameter value, if set. Changing the text in the text box updates the parameter value.

List – When a list parameter is being edited, a list of possible values from which to choose will be displayed. The current value(s) will be highlighted in gray in the list and accompanied by a check box to the left of the value. Clicking on the check box in the list will select the value. The value can be cleared by un-checking the check box next to the value name in the drop-down list. Selected values will be displayed in the text box for the parameter.

Single-Select – This type of list parameter only allows a single value to be selected at a time. Clicking on a new value in the list will replace the current value.

Multi-Select – This type of list parameter allows the selection of multiple values. The values are displayed in the text box as a pipe ("|") delimited list. Clicking on a value in the list that is not currently selected will add that value to the selection. Clicking on a selected (highlighted) value will de-select it.

Yes/No – This type of parameter can only have a Yes or No value. To change the value, click on the drop-down and click on the check box next to either the Yes or No values.

Date – The default date value may be: (1) a static date that never changes, (2) a macro value based on other data and can change at any time, or (3) a relative dynamic date, such as "Today" or "First day of the Year", which will evaluate to the current representation of this relative date and may be a different date than the last time the report was run. If the value is other than a static date, a message will be displayed next to the value, indicating it is one of these types of values. When editing a date parameter, a text box and a calendar tool are displayed.
 
To select a static date, use the calendar tool or manually enter the date into the text box. Please note that the date format is specific and is based on the current culture as set in the browser. Changing the value in the text box will also update the calendar tool. The calendar shows the selected date highlighted with a solid rectangle. To select a different month or year, either use the scroll arrows until the desired month/year is displayed or click on the name of the month at the top of the control. This changes the calendar tool from the month view to the year view. Click the header again to display the decade view. Select the desired month/year combo to return to the month view to pick a specific date.

Month View

Ent-Report_Parameter_Editor-Calendar_example

Year View

Ent-Report_Parameter_Editor-Calendar_example_month

Decade View

Ent-Report_Parameter_Editor-Calendar_example_year

 

To set a relative dynamic date, select the Select dynamic date drop-down menu. Scroll through the relative date options and select the desired option. The calendar tool will automatically update to reflect the selected relative dynamic date.

Ent-Report_Parameter_Editor-Relative_Date_Menu

 

 

Sort Order

 

For grid reports, users can add one or more sort columns and define the sort order for each sort column. The "Sort Order" parameter is listed at the bottom of the report parameter tree.

Ent-Report_Parameter_Editor_SortOrder_Add

The "Add" button is displayed when the Sort Order parameter is selected. Click the Add button to open the form with a drop-down menu for selecting the report column to be sorted and a drop-down menu for selecting the sort order (ascending/descending).

Ent-Report_Parameter_Editor_SortOrder_example

After selecting the desired sort column, click the OK button. Sort columns are displayed with the column name and sort order ("ASC" for ascending and "DESC" for descending). Multiple sort columns can be added. Sort columns are displayed and saved in the same order that the user adds them. Once a sort column has been added, the "X" can be used to remove it. Users can reorder sort columns by clicking the up and down arrows to the right of the sort column name. In the example below, the SYS_LOC_CODE was added with a descending sort order and then the SYS_SAMPLE_CODE was added with an ascending sort order.

Ent-Report_Parameter_Editor_SortOrder_example2

Save the report with the sort order selections. The SortOrder is updated in ST_USER_REPORT.USER_REPORT_INFO and will display when the report is re-opened in the Report Parameter Editor.