Enterprise Service Management Excel Reporting Add-In

Summary

The Enterprise Service Management (ESM) system offers a Microsoft Excel add-in which allows an authorized individual to import TDNext reports directly into Excel, thus allowing for enhanced analysis/reporting capabilities of the ESM reports. All functionality from Excel can now be applied to your ESM reports and information can be displayed any way prefered.

Body

Overview

The Enterprise Service Management (ESM) system offers a Microsoft Excel add-in which allows an authorized individual to import TDNext reports directly into Excel, thus allowing for enhanced analysis/reporting capabilities of the ESM reports. All functionality from Excel can now be applied to ESM reports and information can be displayed any way preferred.

Important
The Excel Reporting Add-In does not support Single Signon (SSO) authentication. If you want to use this feature, submit an Enterprise Service Management request to have your ESM account configured to support the use of this add-in.
Warning

The Excel Reporting Add-In is restricted to retrieving no more than 500,000 cells. If the report returns more than this the following error will be displayed.

"Error exporting grid to Excel: -4: You are attempting to export more than 500,000 cells, which is not permitted. Please add more specific filtering criteria."

If there is a business need to retrieve data containing more than 500,000 cells, consider breaking the report up into smaller logical groups such as by Fiscal Year, Academic Year, etc.

Tip

There are many strategies for creating effective Excel reports, which we won't go into here; however, it is strongly suggested the following practices are adopted when utilizing the TDReporting Add-in.

  • Each ESM Report should be on it's own Excel worksheet
  • Have one, or more, Results worksheets which references the ESM Report sheets and displays the data analysis

In this article:

What materials do I need?

  • Internet access
  • Web Browser
  • TDNext access
  • Access to desired ESM application
  • Access to desired ESM report(s)
  • Computer running Windows OS
  • TDReporting Excel Add-In
  • Microsoft Excel

Download & Install ESM Excel Reporting Add-In

  1. Login to ESM.
  2. Click Applications menu.
  3. Click Downloads.
  4. Under Excel Reporting Add-In click Download.
  5. A file named TDReportingExcelAddin.zip will be downloaded.
  6. Right-click the TDReportingExcelAddin.zip file and select Extract All...
  7. Open the TDReportingExcelAddin folder
  8. Double-click the setup.exe.
  9. If the Microsoft .NET Framework 4.8 (x86 and x64) licensing agreement prompt appears, click Accept.
    • Proceed with .NET Framework installation process.
  10. At the Microsoft Office Customization Installer prompt click Install.
    Microsoft Office Customization Installer prompt
  11. Once the Microsoft Office customization was successfully installed dialog window appears, click Close.
    Microsoft Office customization completed successfully dialog
  12. After the installation completes, proceed to the Configure TDReporting section below.

Configure TDReporting

  1. Open Microsoft Excel.
  2. Create a new Excel workbook.
  3. Click Add-ins.
    Microsoft Excel Add-ins tab highlighted
  4. In the TeamDynamix Reporting section, click Configure Settings.
    Microsoft Excel Add-ins TeamDynamix Reporting Configure Settings button highlighted
  5. In the TeamDynamix Reporting Options dialog box enter the following:
    • Web API URL: https://service.alaska.edu/TDWebAPI
    • Username: <Your UA Email Address>
    • Password: <Your ESM local password>
    • Click Do not track usage

    Microsoft Excel TeamDynamix Reporting Add-in configuration settings example
  6. Click Ok.

Select ESM Report

  1. Click Get Report.
  2. A list of all reports, across all applications, available to your identity will appear.
    • Scroll through the list and locate the desired report.Microsoft Excel TeamDynamix Reporting Get Report selection window
  3. Select the desired report.
    • Optionally, click Include Report Information on Worksheet. If this is selected the following information will be displayed on the sheet.
      • Report Name
      • Created By
      • Report Source
      • Report ID
      • Run Date
  4. Click Ok.
  5. Wait while Loading TeamDynamix report data is loaded.
    Microsoft Excel Add-ins Loading TeamDynamix report data progress bar example
  6. The active worksheet will be populated with the contents from the report.
    Microsoft Excel Add-in TeamDynamix Reporting Data example
Tip
When accessing multiple reports, create a new worksheet for each report. Set the name of the worksheet to provide some reference/association with the source ESM Report. It is recommended to do this and also use the Include Report Information on Worksheet option. That will provide reference information to the source report in the first few rows of the worksheet it is pulled into.
Microsoft Excel TD Reporting Add-in with report information on worksheet option selected

Refresh ESM Report Data

Once a connection has been made to an ESM report, the data can refreshed/updated at any time by doing the following.

Warning
When refreshing report data all data in the report is replaced.
  1. Click the Add-ins tab.
  2. Clicking Refresh Report.
    Microsoft Excel TeamDynamix Reporting Refresh Report button highlighted

Gotchas & Pitfalls

If you share an Excel workbook which contains ESM report data with another individual there are a few things to note:
  • The raw data in the source reports is viewable on the applicable worksheets.
  • The TDReporting add-in is not copied over with the Excel workbook.
  • If other individuals install the TDReporting add-in, the Report name, and ID will be displayed in the menu bar; however, your username and password is not copied.
  • Individuals, other than the workbook author, that have the TDReporting add-in installed that click on the Refresh Report button will receive the following Credentials not set message.

    Enterprise Service Management Excel TDReporting add-in credentials not set dialog message
    Individuals should refer to Configure TDReporting section.
  • Individuals who do not have access to one, or more, of the linked ESM Reports will receive the following notice when they click the Refresh Report button.

    Enterprise Service Management Excel TDReporting Add-In Could not get report data dialog message

Need additional help or have issues

For support, requests may be submitted anytime using the appropriate Enterprise Service Management form. Requests generate a Ticket which will be worked in order received and urgency by IT Employees with the knowledge and permissions to assist with the request.

For immediate assistance please review the Contact Us page for the appropriate support group.

Details

Details

Article ID: 1430
Created
Mon 2/20/23 3:05 PM
Modified
Thu 2/23/23 7:48 PM