Reports Using Text Based Filters (url aware) In Rest APIs

Last Updated: 03/28/2018 Introduced in Version: 2.0

This tutorial demonstrates how to use text based Filters as URL parameter for Service call in Reports.

Example:

We begin with creating a simple Report. In the Designer Folder we click Create Report > Create Report from the Folder Actions Panel.

 

2016-12-19_142611

 

Then, we Name Report and click Create to proceed to the Report Designer.

 

2016-12-19_142943

 

In the Report Designer we add Account Data Source…

 

2016-12-19_143329

 

And desirable columns to the Report. In this example we add Account Id and Email Address.

 

2016-12-19_143655

 

Next, we add Email Address Contains Filter from Data Filters > Field Filters > Email Address category in the Toolbox.

 

2016-12-19_144044

 

With this Filter selected, we navigate to its Settings. Then, we select Runtime Editable option from Runtime Behavior dropdown. This completes our Report. We save and close Report Designer.

 

2016-12-19_144228

 

Back in the Designer Folder we locate a Thumbnail for our Report. Then, from Action menu on the Thumbnail we select Run [Advanced] > Integration > View Integration Details.

 

2016-12-19_144429

 

On the Integration Details Page we Setup Report to Run As UI/Form, we set the Embed Type to Direct url, and the display type to HTML. Then, we click Generate UI Code for testing in the further steps in this tutorial.

 

2016-12-27_083013

 

Paste generated URL into the browser and click Return on the keyboard…

Service call returns us an Html file with Report data. We should see all Portal Accounts because we did not provide a value for the Filter parameter in the URL.

 

2016-12-27_083334

 

We use our URL again but this time we provide Filter parameter with “admin” value…

Service call returns an Html file with filtered data…

 

2016-12-27_083559

 

 

Additional Resources