Creating a New Data Provider - Reporting Dashboards - Foundation 23.1 - Foundation 23.1 - Ready - OnBase

Select New Data Provider.

Click Next.

The What would you like to name this data provider? dialog box is displayed.

Enter a name for the Data Provider in the Name field.

Enter a description for the Data Provider in the Description field.

Sselect the Log data provider execution option to enable logging for the data provider.

Click Next.

The Select the type of data you would like to report on dialog box is displayed.

Select the Custom SQL Query option.

Click Next.

The Edit SQL Query dialog box is displayed.

Type or paste the SQL query into the data-entry field provided. For SQL syntax, parameterizations, and macros specific to Reporting Dashboards, see About the Custom SQL Query Data Provider.

CAUTION:

SQL statements should only be edited or written by a certified database administrator. Poorly constructed SQL statements may return unexpected results or could cause the client to close unexpectedly. Queries that are not written with the index schemas and data distributions in mind can become long-running queries that consume substantial database server resources and adversely affect the performance of the entire system. In extreme cases, data could also be removed from the database or otherwise corrupted.

Tip:

As a best practice, all SQL queries created for use with Reporting Dashboards should be first run in a profiler by a certified database administrator, to review the database optimizer access plan. This analysis needs to be performed against the live database or a database of similar size, with similar data distribution, for all tables involved in the query. The DBA should verify that the query is well formed and not I/O intensive. The data access plans should also be documented to provide a baseline in case database performance degrades at a later time.

Select the Display all date/time columns in local time option to convert all dates and times to display in the local time for the user.

Click Next after ensuring that the SQL entered is valid.

Tip:

To reduce the processing requirements of Reporting Dashboards, it is a best practice to configure required runtime parameters for every Data Provider, or configure parameters with default values to be used if a value is not entered.

Note:

If there are any errors with the runtime parameters, these are displayed in the yellow warning pane above the parameters list. The Next button is not enabled until all errors are corrected.

The Configure input parameters dialog box is displayed if parameters need to be configured.

Select Allow the consolidation of parameters on a dashboard to treat the same parameters from different data providers as one parameter in the Input Parameters dialog box.

Note:

In order to be consolidated, parameters must share the same data provider type, parameter ID, and have the same reverse-fill sources.

Select Allow using default values at runtime to allow the parameters to be filled with a default value if the user does not explicitly select or enter a value.

Select Always prompt for parameter values at runtime to prompt for parameters even if default values have been configured.

To configure an input parameter, select it in the parameters list and click the gear icon. Any input parameter that has not been configured will have a red exclamation point (!) before it.

The Edit SQL Parameter dialog box is displayed.

Type a user-friendly name for the parameter in the Caption field. This is how the user will know what the parameter is for. The caption is limited to 60 characters.

Select the data type of the parameter from the Data Type drop-down list. The data type must be valid for the SQL parameter being configured (for example, do not use Numeric9 as the data type when the SQL parameter being configured contains letters).

Note:

The Date Time Range data type is only valid after a SQL BETWEEN clause.

Select Allow dynamic logical operator in order to allow the logical operator (for example <, >, =) used to evaluate this parameter to be changed. Dynamic logical operators allow for the comparison of values in a method chosen by the user. By default, the selected logical operator is used when the data provider is accessed.

Note:

If Allow dynamic logical operator and Allow multiple selection are both selected, the only logical operators available are IN and NOT IN, which allow the user to search for values within (when using IN) or not within (when using NOT IN) the parameter.

Select Allow wildcard operators to allow Contains, Begins with, and Ends with operators to be used to evaluate this parameter. This option can only be selected if Allow dynamic logical operator is also selected.

Note:

Queries that search for terms using the Ends with operator need to ensure that trailing spaces are taken into account. Use the RTRIM function in the SQL query to remove trailing spaces.

To configure the runtime parameter to use a drop-down list, select the list type from the Value select list drop-down list. This list includes configured global select lists.

Note:

The data type of the Value select list must match the data type of the runtime parameter.

To create a new select list to add to the Value select list drop-down list, or to edit an existing select list already available in the Value select list drop-down list, follow these additional steps:

Click the add/edit button at the right of the Value select list drop-down list.

Select New to add a new select list.

If you are editing an existing select list, make sure the select list you want to edit is selected in the Value select list drop down, then click the add/edit button and select Edit.

The Manage Select Lists dialog box is displayed.
If this is a new select list, the Select List Name dialog box is displayed over the Manage Select Lists dialog box.
Type a name for the select list in the field provided. This is the name that is displayed in the Value select list drop-down list on the Edit SQL Parameter dialog box.
Click OK. The new select list is added and selected, but requires list values before it can be used.

In the right pane, select a source of the values from the Select list source drop-down list.

The list source options available include the following:

List Source	Description
Manually enter values	Type the values for the select list in the grid that is displayed. The Label is how the item is displayed in the drop-down list and the Value is the value that is included in the data query. To add a new value, press the Enter key. A new blank row is added to the grid. To change an existing Label or Value, select it in the grid and type the new value. Note: Manually entered values are limited to 255 characters.
Get values from a SQL query	Enter the SQL used to build the label/value pairs for the drop-down list from the data that is returned. To validate the SQL entered, click Validate SQL at the bottom of the data-entry field. The SQL statement entered must return exactly two columns, one for the Label and the other for the Value(the Label is how the item is displayed in the drop-down list and the Value is the value that is included in the data query).

List Source

Description

Manually enter values

Type the values for the select list in the grid that is displayed. The Label is how the item is displayed in the drop-down list and the Value is the value that is included in the data query. To add a new value, press the Enter key. A new blank row is added to the grid. To change an existing Label or Value, select it in the grid and type the new value.

Note:

Manually entered values are limited to 255 characters.

Get values from a SQL query

Enter the SQL used to build the label/value pairs for the drop-down list from the data that is returned. To validate the SQL entered, click Validate SQL at the bottom of the data-entry field. The SQL statement entered must return exactly two columns, one for the Label and the other for the Value(the Label is how the item is displayed in the drop-down list and the Value is the value that is included in the data query).

CAUTION:

SQL statements should only be edited or written by a certified database administrator. Poorly constructed SQL statements may cause reports to return unexpected results or could cause Reporting Dashboards to close unexpectedly, and queries that are not written with the index schemas and data distributions in mind can become long-running queries that consume substantial database server resources and adversely affect the performance of the entire system. In extreme cases, data could also be removed from the database or otherwise corrupted.

Click Close. You are returned to the Edit SQL Parameter dialog box.
Select the list from the Value select list drop-down list.

Note:
The data type of the select list must match the data type of the runtime parameter.

Type a brief description of the data the parameter represents in the Help Text field. This text is displayed when a user hovers the cursor over the parameter name in the output display. The help text is limited to 255 characters.

To use a drop down menu for a parameter, select a value list from the Value select list drop down menu

If there are no lists to select, or you require a new one, click the pencil button to configure select lists for use with the Data Provider.
The Manage Select Lists dialog box is displayed.
If any select lists have been created, search for them in the Search local select list field and select them. Additionally, any previously configured global select lists can be selected by clicking the Global Select Lists drop down and clicking them.
To create a new select list, click the Create New

The Create New Select List dialog box is displayed.
Enter a name for the select list in the Select List Name field
Select the list source from the Select List Source drop down menu. The available options include Manually enter values or Get values from a SQL Query.
Click OK to return to the Manage Select List dialog box.
If Manually enter values was selected, click on the select list and the following dialog box is displayed. Click the + button. Enter the Label and Value on the lines. Click the checkmark button to save the line. Click the garbage can button to remove a line. Click the + button to add more values to the list.
If Get values from a SQL Query was selected, click on the select list and the following dialog box is displayed. Enter the SQL query in the field and click Validate SQL to validate it.
Once all select lists are created and validated, click OK to return to the Edit SQL Parameter.

Select the list from the Value select list.

Select Restrict user input to select list values to restrict user input for the parameter to only the options in the drop-down list. If this option is deselected, users can type a value for the parameter or select it from the drop-down list.

Select Allow multiple selection to allow users to select more than one value from the drop-down list. If this option is deselected, users can only select one value from the select list. This option is only available if Restrict user input to select list values is also selected.

Select Input required to require users to enter a value for that parameter. This option is selected by default, but can be deselected if a parameter is optional.

Click OK on the Edit SQL Parameter dialog box to save the configuration and return to the Configure input parameters dialog box.

Click Next. The Choose the display columns for the data provider dialog box is displayed.

Note:

If the Restrict user input to select list values option was selected in the Edit SQL Parameter dialog box, you are required to select a default value for the select list prior to selecting display columns for the data provider. Select a value from the drop-down select menu and click Next. The Choose the display columns for the data provider dialog box is displayed.

The display columns available depend on the data provider type being configured. If the data provider being configured allowed you to pre-select the display columns available, only the display columns selected earlier in the configuration process are available.

Select a display column to include it in the results, or deselect it to hide it.

Note:

In order for users to be able to open a document directly from a dashboard, the system Keyword Type Document ID must be included as a display column.

If you want to select all the availabel columns, click the All Fields checkbox.

Tip:

A preview of the type of data that is returned with the display columns selected is displayed in the preview pane at the right of the list of display columns. If the data returned is not acceptable, select different display columns or click Previous to reconfigure previous aspects of the data provider.

To reorder the display columns, drag-and-drop the column headings in the preview pane to put them in the desired order.

To rename a display column, hover over the name in the list, and click the pencil icon that appears next to the name. Click the name and type in the changes. Click the checkmark to save the name..

Note:

Display column names must not be blank or end with a space.

Click Next. The Who should have access to the data provider? dialog box is displayed.

To grant access to a new user, click the + icon. The Select Users dialog box is displayed. Only users and users groups with access to Reporting Dashboards are listed. By default, all users and User Groups are listed. The icons to the right of the search field can be used to limit this to only users or only groups.

To grant access to the dashboard or report to a user or User Group, select the check box that is displayed next to the name of that user or User Group.

To remove a user or User Group's access, deselect the check box beside their name.

Note:

Access cannot be changed for the owner.

Click OK to save your selections and return to the Who should have access to this data provider? dialog box.

In the Who should have access to this data provider? dialog box, select the level of access for each user or User Group. The levels include Full Control, which allows the uer to access and edit the data provider, or Execute Only, which allows the user to use the Data Provider but not edit it.

Click Next

The Summary dialog box is displayed.

If the summary appears correct, click Finish to save the Data Provider.