Adding a Document Query Data Provider Type - Reporting Dashboards - Foundation 23.1 - Foundation 23.1 - Ready - OnBase

From the Dashboard Viewer, click Administration from the bottom of the Dashboard Gallery screen, and then click the Create new Data Provider button from the Data Provider Administration ribbon of the Unity Client:

At the How would you like to create the data provider? page:

Click Create new Data Provider to create a completely new data provider.
Click Copy an existing Data Provider to use an existing data provider as the template for a new data provider. The process is the same as creating a completely new data provider except the options are pre-configured with the information from the data provider that was copied. The pre-configured options can be changed or edited to reflect the requirements of the new data provider, unless otherwise noted.
Click Convert reports from Report Services to use an export file from Report Services to create a custom SQL data provider.

If you clicked Create new Data Provider, the What would you like to name this data provider? page is displayed.

If you clicked Copy an existing Data Provider, the Select the data provider to copy from page is displayed. You can search for a data provider to copy by typing the name of the data provider into the Search bar in this page. Select the data provider to copy, then click Next. The What would you like to name this data provider? page is displayed.

Note:

When a data provider is copied, the options in the remaining pages are pre-configured with the information from the data provider that was copied. Unless otherwise noted, the pre-configured options can be changed or edited to reflect the requirements of the new data provider.

if you clicked Convert reports from Report Services, the Select Reports to Convert page is displayed. Click Browse to select a Report Services export file (.xml) to import. The file is imported as a Custom SQL data provider. Multiple Report Services export files can be added on this screen.

To edit the details of each individual import, double-click on the file in the list. The What would you like to name this data provider? page is displayed.

Type a name for the data provider in the Name field. The name should be unique and allow the data provider to be easily distinguished from other data providers.

Type a brief description of the data provider in the Description field. The description should briefly explain what the data provider is and what type of data a user can expect to retrieve from it.

Select Log data provider execution to include the elapsed time of data retrieval and runtime parameter information for this data provider in the History log. Data requests for the data provider are always logged in the history even if this option is deselected.

Click Next. Unless you are converting data from Report Services, the Select the type of data you would like to report on page is displayed. If you are converting data from Report Services, the Edit SQL query page is displayed.

Note:

If you copied an existing data provider this page is not displayed. You cannot change the data provider type for copied data providers.

Note:

Depending on the modules licensed for your system, one or more types of data providers may be available for configuration. This image only displays the basic data providers available to all Reporting Dashboards installations.

Select Document Query.

Click Next. The Select document types to be retrieved dialog box is displayed, which lists the Document Types selected for copied data providers.

Note:

If this is a new data provider or you do not have any Document Types configured, the Select Document Types dialog box is automatically displayed over the Select the document types to be retrieved dialog box.

Select Prompt users to select document types at runtime at the lower left of the Select document types to be retrieved dialog box to allow users to select the Document Types they have access to in OnBase to include in the results when the dashboard is accessed by them.

If Prompt users to select document types at runtime is selected, any previously added Document Types are removed and the Add and Remove buttons are disabled.

Tip:

If the Select Document Types dialog box was automatically displayed, click Cancel to close it and return to the Select document types to be retrieved dialog box.

To add Document Types if the Select Document Types dialog box is not displayed, click Add. The Select Document Types dialog box is displayed.

Only the Document Types you have access to are displayed. Pre-configured Document Types you do not have access to are disabled.

Note:

If Prompt users to select document types at runtime is selected, any previously added Document Types are removed and the Add and Remove buttons are disabled.

Tip:

To show only previously selected Document Types, select Only Show Selected Items at the bottom of the main pane. To find a specific Document Type, type the first few letters of its name or its full name in the Find... field and the list is filtered accordingly.

To select a Document Type, move the cursor over the row for that Document Type and select the checkbox that is displayed.

To remove a Document Type, deselect the checkbox beside the name of the Document Type.

Click OK at the Select Document Types dialog box to save your selections. The Select the document types to be retrieved dialog box is displayed, which lists the Document Types selected.

Note:

When the a dashboard that uses the configured data provider is accessed by a user, data for all configured Document Types is returned even if the user accessing the dashboard does not have access to those Document Types in OnBase.

To remove Document Types from the data provider, select the Document Type to remove and click Remove. You are not prompted to confirm this action.

Click Next. The Select options on how the data provider retrieves data dialog box is displayed.

Select the options to apply to this data provider:

Respect Security Keywords: Select this option to ensure the result returned will respect the Security Keyword settings of the user retrieving the data.
Allow the consolidation of parameters on a dashboard: Select this option 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.
Display all date/time columns in local time: Select this option to display date and time information in the user's local time

Click Next. The Add keywords to be returned by this data provider dialog box is displayed. Keyword Types that represent document properties, which are added automatically by the system to every document, are denoted with angle brackets >> before the Keyword Type name. For example, >> Content ID is the field for the Document handle in OnBase(the names can be changed during configuration).

Note:

For more information on document properties, see the S ystem Administration module reference guide.

To add Keyword Types, click Add. The Select Keyword(s) dialog box is displayed.

Note:

Keywords are automatically selected as display columns when they are added to a data provider.

Tip:

To show only previously selected Keyword Types, select Only Show Selected Items at the bottom of the main pane. To find a specific Keyword Type, type the first few letters of its name or its full name in the Find... field and the list is filtered accordingly.

To select a Keyword Type, move the cursor over the row for that Keyword Type and select the checkbox that is displayed.

To remove a Keyword Type, deselect the check box beside the name of the Keyword Type. Keyword Types that represent document properties are denoted with angle brackets >> before the Keyword Type name.

Note:

Security Keyword settings are respected by Reporting Dashboards.

Click OK at the Select Keyword(s) dialog box to save your selections. You are returned to the Select the keyword(s) to be displayed and/or used as parameter(s) dialog box.

To remove Keyword Types from the data provider, select the Keyword Type to remove and click Remove. You are not prompted to confirm this action.

To include the Keyword Type as a runtime parameter, select the Parameter checkbox next to the Keyword Type. Runtime parameters help you limit the data returned by the data provider.

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.

If the Parameter checkbox is selected you can configure additional options for the parameter:

Runtime: Select this option to allow the user to change the default value of the parameter when the data provider is used.
Required: If Runtime is selected, you can also select the Required option to force the user to enter a value for the Keyword Type before returning data for the data provider.
Multiple: Select this option to allow the user to select multiple values for the parameter if the parameter is a drop-down list.

Click Next. If Parameter was selected for any Keywords, the Provide default values for the runtime parameters dialog box is displayed. The data entry fields available in this dialog box depend on the Keywords that need to be configured.

The type of data entry fields depends on the Keyword Types that default values can be configured for. The character length of input values is limited to the length specified by the corresponding Keyword Type value.

For text fields, enter the default value and select a logical operator that defines how the value entered is compared to the value returned by the data provider. The data is used in the dashboard only if the result of the logical operator is true.

Logical Operator	Description
=	The value entered is the same as the value returned.
>	The value entered is greater than the value returned. This operator only applies to numeric data.
>=	The value entered is greater than or equal to the value returned. This operator only applies to numeric data.
<	The value entered is less than the value returned. This operator only applies to numeric data.
<=	The value entered is less than or equal to the value returned. This operator only applies to numeric data.
<>	The value entered is not the same as the value returned.

For date fields, enter the default dates in the From and To fields or click the calendar button to select a date from a graphical calendar.

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.

Click None to deselect all display columns or click All to select all display columns.

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, double-click the name in the list, and type the new name in the field provided. Click anywhere outside the field to save the changes.

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 Add. The Select Users dialog box is displayed. Only users and users groups with access to Reporting Dashboards are listed.

Tip:

To show only users, select Specific User from the drop-down list, and to show only User Groups, select User Group from the drop-down list. To find a specific user or User Group, type the first few letters of the name or the full name in the Find... field and the list is filtered accordingly. To show only previously selected users, select Only show selected items.

To grant access to the dashboard or report to a user or User Group, move the cursor over that user or User Group's row and select the check box that is displayed.

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 user selections.

CAUTION:

When any dashboard or report is accessed by a user, data for all configured items (such as Document Types or Workflow queues) is returned, even if the user accessing the dashboard or report does not have access to those items in OnBase.

To remove users or User Groups, select the users or User Groups to remove in the list and click Remove, or right-click the user's name and select Remove. You are not prompted to confirm this action.

Note:

Access for the user account that created the data provider cannot be removed or changed. The data provider creator always has full access to the data provider.

To change a user or User Group's access level, right-click the user's name in the list and select Full Control. A check mark will appear next to Full Control to indicate that user or User Group has Full Control privileges. If the check mark is not present, the user or User Group only has Execute Only privileges. Full Control allows the user to configure the settings for the data provider, including user access. Execute Only allows the user to use, but not configure, the data provider.

Note:

The owner is the user who created the data provider. Access cannot be changed for the owner.

Click Next. The Summary dialog box is displayed. Review the information in the main pane to confirm that the data provider is correctly configured. If not, click Previous to return to the various configuration dialog boxes so that changes can be made.

Click Finish. The data provider is saved and is available for use with dashboards.