Reporting Dashboards Data Provider Export - Unity Scheduler - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Premier - Essential

Unity Scheduler
Platform
OnBase
Product
Unity Scheduler
Release
Foundation 24.1
License
Standard
Premier
Essential

The Reporting Dashboards Data Provider Export task is used to export the contents of a Reporting Dashboards data provider to a Microsoft Excel file.

Note:

A Reporting Dashboards license and the Administrator Access Dashboard User Group privilege are required to create a Reporting Dashboards Data Provider Export task. For more information on Reporting Dashboards configurations, see the Reporting Dashboards documentation.

  1. Select Reporting Dashboards Data Provider Export from the drop-down list when prompted to select the type of task you want to create.
  2. Click Next.
  3. Select one of the following options to determine how the generated spreadsheet should be saved:

    Option

    Description

    Archive Document

    Archives the spreadsheet file into OnBase.

    From the drop-down list, select the Document Type the file should be archived to.

    To automatically assign Keyword Values to the stored document, select the Auto-populate keywords option. Continue the process to configure values as needed.

    Save to network location

    Saves the spreadsheet file to a specified location.

    Enter the desired file name for the spreadsheet in the File name field.

    Browse for or enter the location the spreadsheet should be saved to.

    Note:

    To ensure the file is always saved to the correct location, use a UNC path.

    When entering both the file name and location, click the Insert drop-down button to insert variables. These variables are added to the file name or location and dynamically updated at the time the file is saved:

    • %CD- Inserts the current date.

    • %CT- Inserts the current time.

    • %CN- Inserts the task creator's user name.

    • %CRN- Inserts the task creator's configured Real Name.

    • Note: The variable below relates to the Report Exportfeature and is only usable there.

      %R- Inserts a report's token that is followed with a number, indicating the order number of the report whose name is to be inserted.

    • Note: The variable below relates to the Data Provider Export feature and is only usable there.

      %DP- Inserts the name of the Data Provider name associated with the task. When followed with a number, inserts the name of that number of data provider. For example, "%DP2" inserts the name of the second data provider.

    Select the Overwrite existing file if it exists option to overwrite an existing file by the same name in the same location. If this option is not selected, no existing files are deleted.
  4. Click Next. If you selected to archive the document and auto-populate the document keywords, you are prompted to specify which values to auto-populate.

    If you did not select to auto-populate document keywords, proceed to step 9.

  5. From the Keyword drop-down list, select the Keyword Type whose value should be auto-populated.
  6. Enter the value that should be populated for the Keyword Type in the Value field. Click the Insert drop-down button to insert variables. These variables are added to the Keyword Value and are dynamically updated at the time of upload:

    Variable

    Description

    %CD

    Inserts the current date.

    %CT

    Inserts the current time.

    %CN

    Inserts the task creator's user name.

    %CRN

    Inserts the task creator's configured Real Name.

    %R
    Note: This variable relates to the Report Export feature and is only usable there.
    Inserts a report's token that is followed with a number, indicating the order number of the report whose name is to be inserted.
    %DP
    Note: This variable relates to the Data Provider Export feature and is only usable there.
    Inserts the name of the Data Provider name associated with the task. When followed with a number, inserts the name of that number of data provider. For example, "%DP2" inserts the name of the second data provider.
    Note:

    To avoid errors during task execution, ensure entered Keyword Values comply with the Keyword Type settings, such as the maximum length of the Keyword Value.

  7. Click Add. The Keyword Type and value are added to the list.
    To remove an added Keyword Type and value, select them, and click Remove.
  8. Continue adding Keyword Types and values as necessary.
  9. Click Next.
  10. Click Add to add the Data Providers that should be reported on.

    The Select Data Provider to Retrieve dialog box is displayed.

  11. Select a Data Provider by resting the cursor on the provider and clicking the corresponding check box.

    To only show the selected providers in the list, select the Only show selected items option.

    To search for a specific provider in the list, begin typing the name of the item in the Find field. The list is filtered as you type.

  12. Click OK.

    All selected providers are added to the list.

  13. To change the order of the Data Provider spreadsheets, select a provider and use the up or down arrow buttons to move the order of the provider up one place or down one place, respectively.

    To rename the spreadsheet of a Data Provider, double-click the name in the Sheet Name column and modify the name as necessary.

    To remove a Data Provider from being reported on, select the provider and click Remove.

  14. Click Next. If any of the Data Providers require input parameter values, those must be defined on the following screen. Click Next after defining those values.
  15. For each Data Provider spreadsheet, configure the display columns for the spreadsheet appropriately:
    1. Select the tab of the Data Provider spreadsheet you would like to configure.
    2. Select the Include the column headers in sheet option to include the column names in the spreadsheet.
    3. To change the order of a column, select it and use the up or down arrow buttons to move the order of the column up one place or down one place, respectively.
    4. To exclude a column from being included in the spreadsheet, deselect the Included check box for the column.
    5. To rename a column, double-click the Show Report Header name for the column and modify the name as necessary.
    6. To change the width of a column, double click the Width value for the column and modify it as necessary. The value for width represents the number of characters that can fit into the column header using the standard Excel font.
    7. Continue configuring display columns as necessary. Click Next when complete.
  16. To finish configuring the task, click Next and continue to Configuring Tasks.