Adding a Plan Review Data Provider Type - Electronic Plan Review - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Electronic Plan Review

Platform
OnBase
Product
Electronic Plan Review
Release
Foundation 23.1
License
Standard
Essential
Premier

The Plan Review data provider type returns data on Plan Review projects. This can include data on a project's name and location information, its status, reviewer due dates, etc.

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 Plan Review.
  9. Click Next. The Configure Query dialog box is displayed.
  10. Select Query Project from the Select Source drop-down list. The Display Columns and Input Parameters lists are populated with columns and parameters related to the selected source.
  11. Select one or more display columns from the Display Columns list to include it in the results or deselect it to hide it.
    Click None to deselect all display columns or click All to select all display columns.
  12. Select one or more input parameters from the Input Parameters list to be used to limit the values returned to the dashboard.
    Click None to deselect all input parameters or click All to select all input parameters.
  13. Click Next. The Provide default values for the input parameters dialog box is displayed.

    Depending on your selection in the previous dialog box, the following values may be available:

    Option

    Description

    Due Date

    Specify a default date range for the due date to be used to retrieve projects for display in the dashboard. Projects whose due date falls within the specified range will be displayed in the dashboard.

    Reviewer Due Date

    Specify a default date range for the reviewer due date to be used to retrieve projects for display in the dashboard. Projects whose reviewer due date falls within the specified range will be displayed in the dashboard.

    Start Date

    Specify a default date range for the start date to be used to retrieve projects for display in the dashboard. Projects whose start date falls within the specified range will be displayed in the dashboard.

    Status

    Specify a default date range for the project status to be used to retrieve projects for display in the dashboard. Projects whose status matches the specified criteria will be displayed in the dashboard.

  14. Click Next. The Choose the display columns for the data provider dialog box is displayed.
  15. 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 Workflow object directly from a dashboard, the corresponding ID Keyword 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.

  16. To reorder the display columns, drag-and-drop the column headings in the preview pane to put them in the desired order.
  17. To rename a display column, double click it in the list and type the new name in the field provided. Click anywhere outside the field to save the changes.
  18. Click Next. The Who should have access to the data provider? dialog box is displayed.
  19. To grant access to a new user, click Add. The Select Users dialog box is displayed. Only users and users groups with access to Plan Review 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.

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

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

  22. To remove users or user groups, 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 the full access to the data provider.

  23. To change a user's access level, right-click the user's name in the list and select Full Control:
    • If the user currently has Execute Only access, they are granted Full Control.

    • If the user currently has Full Control, their access level is reduced to Execute Only.

    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.

  24. 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.
  25. Click Finish. The data provider is saved and is available for use with dashboards.