External Excel Query via API (Office 365 and Other Supported Excel Versions)

Overview

Paradigm gives you the freedom to import your report to an external data visual analytics platform such as Excel to help your business or institution make more meaning and see data from your perspective. This is also very helpful in complying to your reporting requirements as an institution, and to the government. This knowledge article will help you generate External Excel reports with data from Paradigm via an external connection.

Complexity: MEDIUM to EXPERT


Navigation

Workflow

Other Helpful How to Guides in Excel


Assumptions

  • Excel report has been saved and tested in Report Builder;

  • Report parameters have been pre-determined in a report builder report;

  • An understanding of how these reports work in Excel; and

  • Supported version: Microsoft Office Professional 2016/2019, Microsoft Office Professional Plus 2016/2019, Microsoft Office 365.

 

Key Terms and Concepts

The report connection will by default use the logic as defined by the filter clauses within Report Builder. For example, if there is a check on a specific program ID then that check will be applied to the results of the report data returned to Excel.


Excel

Excel is a software program from Microsoft that is part of the Microsoft Office suite of productivity software developed by Microsoft. Excel is capable of creating and editing spreadsheets.


Pivot tables

Pivot tables are a table of statistics that summarise the data of a more extensive table (such as from a database, spreadsheet, or business intelligence program). This summary might include sums, averages, or other statistics, which the pivot table groups together in a meaningful way.


Query

A request to a server (typically a database) for information.


Parameter

A single part of the information is sent as part of a query to differentiate it from other requests. If a query is “Please supply me with a student” a parameter might be “named Robert”.


Domain name

In a URL the domain name is what is immediately after HTTPS:// and before the next forward slash /. For example, in https://example.edu.net.au/php/student_summary.php. The domain name is example.edu.net.au.


 


Workflow

 

 

step 1 Get the Report in Paradigm

 

step 1 Load Existing Saved Report in Paradigm


1,2,3 Reports > Report Builder > Go to the SAVED REPORT DESCRIPTIONS Form.

4 Choose the report from the Global Reports or Private Reports drop-down list.

5 Click the LOAD REPORT button.

 


 

step 2 Copy the URL from the Excel Web Query field


6 Once the required report has been loaded, scroll down to the bottom of the page and look for the SAVE REPORT Form.

 

INFO: In scrolling down the page. You can click the (minus) sign on each form [the location is circled on the upper right part of the screenshot below] before the SAVE REPORT Form. Clicking the (minus) sign will hide temporarily the contents of each form, you can click the (plus) sign later if you need to view the contents of a specific form again. An example would be checking the FILTER CLAUSES Form back to edit/update/modify the values and conditions before you generate the report.

 

7 Go to the Excel Web Query URL: field, enter the “Domain Name (see the definition of this term in the “Key Terms and Concepts” section above) of your institution just before the /php content, see the below example.

Copy the entire content of the Excel Web Query URL field. In the example below, copy: “https://example.edu.net.au/php/external_report_builder_call_httpauth.php?report_id=10000”.

 

 

 

step 3 Proceed to step 2 Get the Data to Excel instructions.

 

step 2 Get the Data to Excel

 

step 1 Get the Data to Excel – Open the MS EXCEL application.


 

NOTE: For MS EXCEL 2019, other standalone version higher that 2016, and MS OFFICE 365 refer to the instructions under the “how to Enable the From Web (Legacy) menu in Excel” section below on how to display or access the From Web (Legacy) menu in the ribbon.

 

1 Choose the Data menu from the Ribbon Bar.

2 If you don’t see the From Web menu in the ribbon, click the Get Data menu > From Other Sources > From Web.

 

INFO: If you are using MS EXCEL 2019, other standalone version higher that 2016, and MS OFFICE 365, after enabling the From Web (Legacy) menu, you should be using it instead of the From Web menu found in the ribbon by default. (The same as the sample screenshot below which is an Excel 2019 Version).

 

 

3 Paste into the address field the content / API URL of the Excel Web Query URL field sourced from Report Builder, and click Go. After clicking the Go button on the right of the address bar, with the new link on it, a Windows Security window will appear prompting you to enter your Paradigm Username and Password.

 

4 Enter your Paradigm credentials [Username and Password].

 

 

5Click the Import button, once the page has been loaded.

 


 

 

 

step2 After clicking the Import button, Excel will ask you where to put the data, you have the option to use the Existing worksheet or to create a New worksheet.

 

 

 

 

 

 

how to Enable the From Web (Legacy) menu in Excel

 

 

step 1 Enable the From Web (Legacy) Data options in Excel.

There are two ways you can enable or see the From Web (Legacy) menu in Excel:


1.1 You can add it to the Legacy Wizards menu by following the steps below. You can refer to this article from Microsoft for more details on https://support.microsoft.com/en-us/office/data-import-and-analysis-options-3ea52160-08bc-45ac-acd9-bc4a11bcc2a2.

Choose File > Options > Data > Show legacy data import wizards section > Check From Web (Legacy) > Click OK.

 

 

1.2 However, if you want to add the From Web (Legacy) menu as a new group in the ribbon bar, for easy access, you can follow the steps below in customising your ribbon bar with the legacy menu on it:

1 Choose File > Options > Customize Ribbon.

2 Look for the From Web (Legacy) command, select it.

3 Select which Tab you want it to appear, ideally you should select the Data Tab on the right.

4 To create a new section in the ribbon where the legacy menu will be added, you need to create a new group first, and in creating a new group, you either right click on Data or click the New Group button.

5 Select your newly created group.

6 Click the Add>> button.

7 Click OK.

Your From Web (Legacy) menu will now be added in the ribbon. You can refer to this Microsoft article on how to https://support.microsoft.com/en-us/topic/customize-the-ribbon-in-office-00f24ca7-6021-48d3-9514-a31a460ecb31 .

 


 

step 2 Now that the From Web (Legacy) menu is added to the ribbon, select it to start importing data from Paradigm to Excel. Follow the same steps above, in the “ step 2 Get the Data to Excel” section in getting the data to Excel.

 

step 3 After all the data has been imported to Excel, convert the data to a table. If there is more than one result, you may need to split the initial column by clicking the icon in the column header.

 

 

 

Other Helpful How to Guides in Excel



 

 

Related Pages