Adding a WorkView Data Provider Type - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Premier - OnBase/WorkView/Foundation-24.1/WorkView/WorkView-Data-Provider/Adding-a-WorkView-Data-Provider-Type - 2025-10-15

WorkView

Platform
OnBase
Product
WorkView
Release
Foundation 24.1
License
Premier
ft:locale
en-US

The WorkView data provider type returns data associated with a configured WorkView filter.

The following instructions are for creating a data provider that can be used in dashboards or reports. You can also add a data provider to a new dashboard during the dashboard creation process. See the Reporting Dashboards documentation for information on how to add a data provider during dashboard creation.

Note:

For a WorkView filter to be available as a source for a data provider, Reporting Dashboards much be configured as a module association for that filter. For more information on configuring module associations, see Configuring Module Associations.

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

  1. 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:
  2. 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.

  3. 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.

  4. 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.
  5. 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.
  6. 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.
  7. 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:

    The data providers available depend on the modules licensed for your system. The Custom SQL Query and Document Query data provider types are available to all systems with Reporting Dashboards.

  8. Select WorkView.
  9. Click Next. The Configure Query page is displayed.
  10. From the Select Source drop-down list, select the filter you want to associate with the data provider.
  11. Select the check boxes next to the Display Column items you would like to display in the data provider. You can select All to select all the check boxes or you can select None to deselect all of the check boxes. You can also search for a specific column with the Search... field. If you want to view only the columns that have been selected, select the Only show selected items check box.
  12. Click Next.
  13. The Choose the display columns for the data provider page displays a preview of the data the selected filter will return. You can remove, reorder, and/or rename display columns from the data provider in this page.
  14. Click Next. The Who should have access to this data provider? page is displayed.
  15. If you want to grant rights to additional users to access the data provider, click Add.
  16. Select the users that you want to grant access rights to the data provider. You can use the Find... field to find specific users. You can select Only show selected items to display only the users you have granted rights to.
  17. Click OK.
  18. Click Next.
  19. Click Finish.