Adding a Document Imaging Query (Time to Process) Data Provider Type - Reporting Dashboards - Foundation 23.1 - Foundation 23.1 - Ready - OnBase

Adding a Document Imaging Query (Time to Process) Data Provider Type - Reporting Dashboards - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - external

Reporting Dashboards

Platform

OnBase

Product

Reporting Dashboards

Release

Foundation 23.1

License

Retrieves the time-to-process data for batch Document Imaging processes, based on users or User Groups.

Tip:

For complete details on Document Imaging processes and how they relate to processing queues, see the Document Imaging module reference guide.

The Create Data Provider Wizard is used to create new data providers. To create a new data provider:

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 Imaging Query - Time to Process.
Click Next. The Provide default values for the input parameters dialog box is displayed.
Select the type of data to return from the Select Report Type drop-down list. This is the default value used when the data is returned for a dashboard.

The report types retrieve the time-to-process data for Document Imaging batch processes, based on users or User Groups.

Tip:
For complete details on Document Imaging processes and how they relate to processing queues, see the Document Imaging module reference guide.
Select Allow Report Type to be selected at runtime to allow the user accessing the dashboard to change the report type when the dashboard is accessed.
Select how to filter the user or User Group list from the Filter results by User or User Group drop-down list:
- By User
- By User Group
- Current User
- All Users
The Select User or User Group list is populated based on the filter selected.
If By User or By User Group is used as the filter, select from the Select User or User Group list the users or User Groups to limit the results returned to.

To select specific users or User Groups, hold down the Ctrl key and select each user or User Group to include in the results.

To select a range of users or User Groups, click the first user or User Group to include, then hold down the Shift key and select the last user or User Group in the range. The users or User Groups selected, and all users or User Groups between them, are included in the results.
Select Allow User or User Group to be selected at runtime to allow the user accessing the dashboard to change the users or User Groups included in the results when the dashboard is accessed.
Enter a default date range to return data for in the Select Date Range fields. These are the default values used when the data is returned for a dashboard.

You can manually type the From and To dates, or click the arrows at the right end of each field to select a date for that field from a graphical calendar.

To select both From and To dates from a single graphical calendar, click the calendar button at the right end of the To field.
Select Allow Date Range to be selected at runtime to allow the user accessing the dashboard to change the date range when the dashboard is accessed.
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.