Salesforce 报表开发

Salesforce提供了强大的报表功能，支持表格、摘要、矩阵以及结合共四种形式，本文探讨在站在开发的角度要如何理解报表。

一：查询报表基本信息
报表在Sales force中是Report对象，基本的查询语句可以获取一些报表的基本信息

select id,Name,CreatedById,CreatedBy.Username,LastModifiedDate,FolderName from Report

二：在Apex类中运行报表

Salesforce分别提供了runReport(同步)以及runAsyncReport(异步)两种方式运行报表

//同步方法：
Reports.ReportResults results = Reports.ReportManager.runReport(reportId,true);
//异步方法
Reports.ReportInstance instance = Reports.ReportManager.runAsyncReport(m.id, true);

我们写一段静态代码来执行打印报表数据

String reportId = '报表id';
Reports.ReportResults  results = Reports.ReportManager.runReport(reportId,true);
System.debug('===========报表运行结果========>>');
System.debug(results);

需要注意的有两点

• 没选中任何列的情况下运行报错
• 结合报表不支持

没有选中任何列的报表指的如下图所示

 

运行结果：reports.MetadataException: 无法运行报表，因为它尚未选择任何列。确保通过用户界面向报表添加字段作为列

至少需要添加一个字段到该报表，之后隐藏详细记录，即可实现同样的效果。

如果报表类型是结合报表，运行上述代码回提示错误

在避开上述两个易出现的问题后，就能成功用apex方法执行一个报表并得到它的返回值results了。

Results返回值是一个JSON串，ReportResults对象，包含属性

• allData：标识
• factMap:Map<坐标,数据>存放数据的map
• groupingsAcross：横向分组字段
• groupingsDown：纵向分组字段
• hasDetailRows：是否有数据
• reportExtendedMetadata：表头
• reportMetadata：其他信息

实际返回值结构如下

Reports.ReportResults[ 2         //public Boolean getAllData()
        //true, indicates that all report results are returned.
        //false, indicates that results are returned for the same number of rows as in a report run in Salesforce.
        allData=true,
        //public MAP<String,Reports.ReportFact> getFactMap()
        factMap={},//对象，无序键值对
        //public Reports.Dimension getGroupingsAcross()
        //Returns a collection of column groupings, keys, and values.
        groupingsAcross=Reports.Dimension[],
        //public Reports.Dimension getGroupingsDown()
        //Returns a collection of row groupings, keys, and values
        groupingsDown=Reports.Dimension[],
        //public Boolean getHasDetailRows()
        //Returns information about whether the fact map has detail rows
        //true, indicates that the fact map returns values for summary-level and record-level data.
        //false, indicates that the fact map returns summary values.
        hasDetailRows=true,
        //public Reports.ReportExtendedMetadata getReportExtendedMetadata()
        //Returns additional, detailed metadata about the report, including data type and label information for groupings and summaries.
        reportExtendedMetadata=Reports.ReportExtendedMetadata[],
        //public Reports.ReportMetadata getReportMetadata()
        //Returns metadata about the report, including grouping and summary information
        reportMetadata=Reports.ReportMetadata[]
    ]

其中factMap以无序键值对的形式存储了所有报表数据，groupingsAcross和groupingsDown存储了报表的横纵字段信息，reportExtendedMetadata记录了包括报表横纵分组信息在内的相关信息，reportMetadata则记录了表格类型，分组长度等信息。

1.查看报表类型

Reports.ReportMetadata metadata = results.getReportMetadata();
String reportType = '' + metadata.getReportFormat();
if(reportType == 'TABULAR'){
     System.debug('该报表为表格类型');
}
if(reportType == 'SUMMARY'){
     System.debug('该报表为摘要类型');
}
if(reportType == 'MATRIX'){
     System.debug('该报表为矩阵类型');
}

2.报表数据获取

factMap最多支持2*2的矩阵类型，在表格数据的展示上如上表所示，数据显示格式  *_*!*_*

其中，如果遇到小计/总计的数据，对应的点用T(Total)进行标识，比如最后横纵交汇的点就是T!T

3.报表分组信息的获取

Reports.ReportExtendedMetadata extended_metadata = results.getReportExtendedMetadata();

Reports.ReportExtendedMetadata[
    //public MAP<String,Reports.AggregateColumn> getAggregateColumnInfo()
    //Returns all report summaries such as Record Count, Sum, Average, Max, Min, and custom summary formulas. Contains values for each summary that is listed in the report metadata.
    aggregateColumnInfo={},//汇总信息
    //public MAP<String,Reports.DetailColumn> getDetailColumnInfo()
    //Returns a map of two properties for each field that has detailed data identified by its unique API name. The detailed data fields are also listed in the report metadata.
    detailColumnInfo={},//详细信息
    //public MAP<String,Reports.GroupingColumn> getGroupingColumnInfo()
    //Returns a map of each row or column grouping to its metadata. Contains values for each grouping that is identified in the groupingsDown and groupingsAcross lists.
    groupingColumnInfo={}//分组字段
]

横纵向的两个分组字段信息可以从groupingColumInfo中获取，包括了字段的类型，名称，标签以及分组级别

4.每个分组下对应显示的字段

Reports.Dimension dim_Across = results.getGroupingsAcross();
List<Reports.GroupingValue> list_gr = dim_Across.getGroupings();
System.debug('横向' + list_gr);
Reports.Dimension dim_Down = results.getGroupingsDown();
List<Reports.GroupingValue> list_gr_down = dim_Down.getGroupings();
System.debug('纵向' + list_gr_down);

5.其他报表信息查询

Reports.ReportMetadata metadata = results.getReportMetadata();

Reports.ReportMetadata提供了关于报表的所有信息，比如报表的id，Name，报表类型，汇总字段，行列分组以及汇总信息依据。我们甚至可以用来修改报表的汇总信息条件。尤为重要的是其提供了groupingsAcross数组，从而能确定报表的分组排列方式，下面是我抽取的一段JSON数据，可以看到报表的分组形式横向分别是订单类型(ORDER_TYPE)，订单所有人(ORDER_OWNER)，纵向分组是订单状态(ORDER_STATUS)，订单等级(Order.DeliveryLevel__c)。

 groupingsAcross=(Reports.GroupingInfo[
        dateGranularity=NONE,
        name=ORDER_TYPE,
        sortAggregate=null,
        sortOrder=ASCENDING
    ],
    Reports.GroupingInfo[
        dateGranularity=NONE,
        name=ORDER_OWNER,
        sortAggregate=null,
        sortOrder=ASCENDING
    ]),
    groupingsDown=(Reports.GroupingInfo[
        dateGranularity=NONE,
        name=ORDER_STATUS,
        sortAggregate=null,
        sortOrder=ASCENDING
    ],
    Reports.GroupingInfo[
        dateGranularity=NONE,
        name=Order.DeliveryLevel__c,
        sortAggregate=null,
        sortOrder=ASCENDING
    ]),

Salesforce提供了强大的报表功能，但是作为开发者也应该了解其内部的数据存储，希望本文对你能有所帮助。如有错漏，欢迎指正，有问题可以留言。