Apex · REST

How to schedule a report from an apex class

In this blog, I am going to take you through the process of how to schedule a report from apex class. While I was working on my last project I came across a scenario where I need to schedule a report from the apex. This blog takes you through the simplest way possible to achieve this requirement.

Using analytics REST API we can do the following things :

  1. Create, update and retrieve the Salesforce Report and Dashboard.
  2. Modify and schedule trends in Analytics report snapshot.
  3. Retrieve a list of dataset versions.
  4. Retrieve a list of dependencies for an application.

In order to schedule a report first, we need to understand ‘reports’ namespace.

Reports namespace contain a number of classes through which we can avail the same level of data access as in case of using Salesforce Reports and DashBoards REST API.

There are two ways of running a report through apex.

  1. Synchronously
  2. Asynchronously

Synchronous Way of running  reports:

If you want to run reports synchronously we have to use ReportManager class. In this, we need to use runreport() Method. The Return type of this report must be ReportResult class. This class contains results after running a report.

Check the below code for running report synchronously.

public class ScheduleReport {

public ScheduleReport(){

list reportList=[select id, name from report where name='DemoReport’'];

// To get the report Id.

string reportId=(string) reportList.get(0).get('Id');

//To Run the report.

reports.ReportResults reportResult=reports.ReportManager.runReport(reportId, true);

system.debug('reportResult--->'+reportResult);

}

}
 

Asynchronously way of running reports:

If you want to run reports asynchronously we have to use ReportManager class similar to Synchronous way of running reports. Here you need to use runAsyncReport() method instead of runReport() method.

Advantages of running reports Asynchronously:

  1. We can lower the risk of reaching the timeout limit when we run reports.
  2. Salesforce API timeout limit does not apply for asynchronous runs.
  3. Salesforce Reports and dashboards API can handle higher number of asynchronous run requests at a time.

Check the below code to Schedule a report Asynchronously

public class ScheduleReport {

public ScheduleReport(){

list reportList=[select id, name from report where name='DemoReport’'];

string reportId=(string) reportList.get(0).get('Id');

Reports.ReportInstance instance = Reports.ReportManager.runAsyncReport(reportId, true);

System.debug('Asynchronous instance: ' + instance);

}

}
 

Now we need to write a schedulable class to schedule our report.

Below is the code for schedule class.

global class ScheduleReportClass implements Schedulable{

global void Execute(SchedulableContext context){

ScheduleReport sch=new ScheduleReport();

}

}
 

Let us consider a scenario where I need to schedule a report every weekday at 1PM.

Below is the code for scheduling

ScheduleReportClass sch=new ScheduleReportClass();
string cronExp='0 0 13 ? * MON-FRI';
system.schedule('schedule report', cronExp, sch);

 

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s