正在开发报告

AEM提供了标准报告的选择,其中大多数报告基于报告框架。

使用框架,您可以扩展这些标准报告,或开发您自己的全新报告。 该报告框架与现有的CQ5概念和原则紧密集成,这样开发人员就可以将他们现有的CQ5知识作为开发报告的跳板。

对于随AEM提供的标准报告:

注意

教程创建您自己的报告——示例还显示了可以使用以下原则的数量。

您还可以参阅标准报告,查看其他实施示例。

注意

在下面的示例和定义中,使用以下记号:

  • 每行定义一个节点或属性,其中:

  • N:<name> [<nodeType>]

描述名称为<*name*>且节点类型为​<*nodeType*>的节点。

  • P:<name> [<propertyType]

描述名称为<*name*>且属性类型为<*propertyType*>的属性。

  • P:<name> = <value>

描述必须设置为<value>值的属性<name>

  • 缩进显示节点之间的层次依赖关系。
  • 分隔项 |表示列表可能的项目;例如,类型或名称:

例如,String|String[]表示该属性可以是String或String[]。

  • [] 描述数组;例如[] 字符串或查询定义中的节 点数组

除非另有说明,否则默认类型为:

  • 节点- nt:unstructured
  • 属性 - String

报告框架

报告框架遵循以下原则:

  • 它完全基于由CQ5 QueryBuilder执行的查询返回的结果集。

  • 结果集定义报告中显示的数据。 结果集中的每一行都对应于报表表格视图中的一行。

  • 可在结果集上执行的操作类似于RDBMS概念;主要​分组​和​聚合

  • 大多数数据检索和处理都是在服务器端完成的。

  • 客户单独负责显示预处理数据。 客户端只执行次要处理任务(例如,在单元格内容中创建链接)。

报告框架(由标准报告的结构说明)使用以下由处理队列提供的构件块:

chlimage_1-247

报告页

报告页:

  • 是标准CQ5页面。
  • 基于为报告](#report-template)配置的[标准CQ5模板。

报告库

reportbase组件构成任何报告的基础,如下所示:

  • 保存查询的定义,该定义提供数据的基础结果集。

  • 是一个经过调整的段落系统,它将包含添加到报表的所有列(columnbase)。

  • 定义哪些图表类型可用以及哪些当前处于活动状态。

  • 定义编辑对话框,该对话框允许用户配置报表的某些方面。

列基

每列都是 columnbase组件的一个实例,它:

  • 是段落,由相应报表的parsys(reportbase)使用。
  • 定义到基础结果集的链接;例如,定义此结果集中引用的特定数据以及如何处理它。
  • 包含其他定义;如可用的聚合和过滤器以及任何默认值。

查询和数据检索

查询:

  • 定义为 reportbase组件的一部分。

  • 基于CQ QueryBuilder

  • 检索用作报表基础的数据。 结果集(表)的每一行都绑定到由查询返回的节点。 然后,从此数据集提取单个列的特定信息。

  • 通常由以下组成:

    • 根路径。

      它指定要搜索的存储库的子树。

      为了帮助最大限度地降低对性能的影响,建议(尝试)将查询限制到存储库的特定子树。 根路径可以在报告模板中预定义,也可以由用户在配置(编辑)对话框中设置。

    • 一个或多个条件

      这些结果被强加以产生(初始)结果集;例如,节点类型限制或属性约束。

此处的关键点是,查询结果集中返回的每个单个节点都用于在报表上生成单行(因此为1:1关系)。

开发人员必须确保为报表定义的查询返回适合该报表的节点集。 但是,节点本身不需要保存所有必需的信息,这也可以从父节点和/或子节点派生。 例如,用于用户报告的查询根据节点类型(本例中为rep:user)选择节点。 但是,此报告中的大多数列不直接从这些节点获取其数据,而是从子节点profile获取数据。

处理队列

查询返回要作为行显示在报表上的数据集。 在将结果集中的每一行传输到客户机以在报告中显示之前,在几个阶段中处理(服务器端)。

这允许:

  • 从基础结果集提取和导出值。

    例如,它允许您通过计算两个属性值之间的差值,将两个属性值作为单个值进行处理。

  • 解析提取的值;这可以通过各种方式实现。

    例如,路径可以映射到标题(如各个​jcr:title​属性中更易于读取的内容)。

  • 在不同点应用过滤器。

  • 根据需要创建复合值。

    例如,由显示给用户的文本、用于排序的值和用于创建链接的附加URL(在客户端)组成。

处理队列的工作流

以下工作流表示处理队列:

chlimage_1-249

处理队列的阶段

详细步骤和元素包括:

  1. 使用值提取器将初始查询(reportbase)返回的结果转换为基本结果集。

    根据列类型自动选择值提取器。 它们用于从基础JCR查询读取值并从中创建结果集;之后,可再进行进一步处理。 例如,对于diff类型,值提取器读取两个属性,计算单个值,然后将其添加到结果集。 无法配置值提取器。

  2. 对于包含原始数据的初始结果集,应用初始过滤raw 阶段)。

  3. 值为预处理;定义为​apply​阶段。

  4. 对预 处理值执 ** 行过滤(分配给预处理阶段)。

  5. 值已解析;根据定义的resolver

  6. 对解析 值执行筛选( ** 分配给解析阶段)。

  7. 数据是分组和聚集的

  8. 通过将数组数据转换为(基于字符串的)列表来解析数组数据。

    这是一个将多值结果转换为可显示的列表的隐式步骤;它对于基于多值JCR属性的(未聚集)单元格值是必需的。

  9. 值再次预处理;定义为​afterApply​阶段。

  10. 数据已排序。

  11. 处理的数据被传送到客户端。

注意

返回基本查询结果集的初始在reportbase组件上定义。

处理队列的其他元素在columnbase组件上定义。

报告构建和配置

构建和配置报告时需要以下内容:

报告组件的位置

默认报告组件位于/libs/cq/reporting/components下。

但是,强烈建议您不要更新这些节点,而是在/apps/cq/reporting/components下创建您自己的组件节点,或者在更合适的/apps/<yourProject>/reports/components下创建组件节点。

其中(例如):

N:apps 
    N:cq [nt:folder]
        N:reporting|reports [sling:Folder]
            N:components [sling:Folder]

在此下面,您为报表创建根,在此下,报表基组件和列基组件:

N:apps 
    N:cq [nt:folder]
        N:reporting|reports [sling:Folder]
            N:components [sling:Folder]
                N:<reportname> [sling:Folder]
                        N:<reportname> [cq:Component]  // report base component
                        N:<columnname> [cq:Component]  // column base component

页面组件

报告页必须使用/libs/cq/reporting/components/reportpagesling:resourceType

自定义页面组件不应是必需的(在大多数情况下)。

报表基础组件

每个报告类型都需要从/libs/cq/reporting/components/reportbase派生的容器组件。

此组件充当整个报表的容器,并提供以下信息:

N:<reportname> [cq:Component]
    P:sling:resourceSuperType = "cq/reporting/components/reportbase"
    N:charting
    N:dialog [cq:Dialog]
    N:queryBuilder

查询定义

N:queryBuilder
    N:propertyConstraints
    [
        N:<name> // array of nodes (name irrelevant), each with the following properties:
            P:name
            P:value
    ]
    P:nodeTypes [String|String[]] 
    P:mandatoryProperties [String|String[]
  ]
  • propertyConstraints

    可用于将结果集限制为具有特定属性且具有特定值的节点。 如果指定了多个约束,则节点必须满足所有约束(AND操作)。

    例如:

    N:propertyConstraints
     [
     N:0
     P:sling:resourceType
     P:foundation/components/textimage
     N:1
     P:jcr:modifiedBy
     P:admin
     ]
    

    将返回上次由admin用户修改的所有textimage组件。

  • nodeTypes

    用于将结果集限制为指定的节点类型。 可以指定多个节点类型。

  • mandatoryProperties

    可用于将结果集限制为具有指定属性​all​的节点。 属性的值未被考虑在内。

所有选项都是可选的,并且可以根据需要进行组合,但您必须至少定义其中一个选项。

图表定义

N:charting
    N:settings
        N:active [cq:WidgetCollection]
        [
            N:<name> // array of nodes, each with the following property
                P:id   // must match the id of a child node of definitions 
        ]
    N:definitions [cq:WidgetCollection]
    [
        N:<name> // array of nodes, each with the following properties
            P:id
            P:type
            // additional, chart type specific configurations
    ]
  • settings

    保存活动图表的定义。

    • active

      由于可以定义多个设置,因此您可以使用它定义当前处于活动状态的设置。 这些节点由节点数组定义(这些节点没有强制命名约定,但标准报告通常使用01x),每个属性具有以下属性:

      • id

        活动图表的标识。 这必须与图表definitions中的一个的id匹配。

  • definitions

    定义可能可用于报表的图表类型。 将使用的definitions将由active设置指定。

    定义使用节点数组(通常也称为01x),每个属性具有以下属性:

    • id

      图表标识。

    • type

      可用的图表类型。 选择自:

      • pie
        饼图。仅从当前数据生成。

      • lineseries
        一系列线(表示实际快照的连接点)。仅从历史数据生成。

    • 其他属性可用,具体取决于图表类型:

      • 对于图表类型pie:

        • maxRadius ( Double/Long)

          饼图允许的最大半径;因此图表允许的最大大小(无图例)。 如果定义fixedRadius,则忽略。

        • minRadius ( Double/Long)

          饼图允许的最小半径。 如果定义fixedRadius,则忽略。

        • fixedRadius ( Double/Long)定义饼图的固定半径。

      • 对于图表类型lineseries:

        • totals ( Boolean)

          如果应当显示显示​Total​的附加行,则为true。
          默认: false

        • series ( Long)

          要显示的行数/序列数。
          默认:9(这也是允许的最大值)

        • hoverLimit ( Long)

          要显示弹出窗口的最大聚合快照数(每个水平线上显示的点,表示不同值),即当用户将鼠标悬停在图表图例中的不同值或相应标签上时。

          默认:35(即,如果当前图表设置的不同值超过35个,则不显示任何弹出窗口)。

          可以并行显示的弹出窗口数量限制为10个(当将鼠标悬停在图例文本上时,可显示多个弹出窗口)。

配置对话框

每个报告都可以有一个配置对话框,允许用户为报告指定各种参数。 当报表页面打开时,可通过​编辑​按钮访问此对话框。

此对话框是标准CQ 对话框,可以这样配置(有关详细信息,请参见CQ.Dialog)。

示例对话框如下所示:

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    jcr:primaryType="cq:Dialog"
    height="{Long}424">
    <items jcr:primaryType="cq:WidgetCollection">
        <props jcr:primaryType="cq:Panel">
            <items jcr:primaryType="cq:WidgetCollection">
                <title
                    jcr:primaryType="cq:Widget"
                    path="/libs/cq/reporting/components/commons/title.infinity.json"
                    xtype="cqinclude"/>
                <description
                    jcr:primaryType="cq:Widget"
                    path="/libs/cq/reporting/components/commons/description.infinity.json"
                    xtype="cqinclude"/>
                <rootPath
                    jcr:primaryType="cq:Widget"
                    fieldLabel="Root path"
                    name="./report/rootPath"
                    rootPath=""
                    rootTitle="Repository root"
                    xtype="pathfield"/>
                <processing
                    jcr:primaryType="cq:Widget"
                    path="/libs/cq/reporting/components/commons/processing.infinity.json"
                    xtype="cqinclude"/>
                <scheduling
                    jcr:primaryType="cq:Widget"
                    path="/libs/cq/reporting/components/commons/scheduling.infinity.json"
                    xtype="cqinclude"/>
            </items>
        </props>
    </items>
</jcr:root>

提供了多个预配置组件;可以在对话框中使用值为cqincludextype属性引用这些属性:

  • title

    /libs/cq/reporting/components/commons/title

    用于定义报表标题的文本字段。

  • description

    /libs/cq/reporting/components/commons/description

    文本区域可定义报表描述。

  • processing

    /libs/cq/reporting/components/commons/processing

    报表处理模式的选择器(手动/自动加载数据)。

  • scheduling

    /libs/cq/reporting/components/commons/scheduling

    为历史图表安排快照的选择器。

注意

引用的组件必须使用.infinity.json后缀进行包含(请参阅上面的示例)。

根路径

此外,还可以为报表定义根路径:

  • rootPath

    这会将报告限制在存储库的某个部分(树或子树),建议使用该部分进行性能优化。 根路径由每个报告页面的report节点的rootPath属性指定(在创建页面时从模板获取)。

    它可以由以下对象指定:

    • 报告模板(作为固定值或作为配置对话框的默认值)。
    • 用户(使用此参数)

列基组件

每个列类型都需要从/libs/cq/reporting/components/columnbase派生的组件。

列组件定义以下组合:

N:<columnname> [cq:Component]
    P:componentGroup
    P:jcr:title
    P:sling:resourceSuperType = "cq/reporting/components/columnbase"
    N:cq:editConfig [cq:EditConfig] // <a href="#events-and-actions">Events and Actions</a>
    N:defaults // <a href="#column-default-values">Column Default Values</a>
    N:definitions
      N:queryBuilder // <a href="#column-specific-query">Column Specific Query</a>
        P:property [String|String[]] // Column Specific Query
        P:subPath // Column Specific Query
        P:secondaryProperty [String|String[]] // Column Specific Query
        P:secondarySubPath // Column Specific Query
      N:data
        P:clientFilter [String] // <a href="#client-filter">Client Filter</a>
        P:resolver // <a href="#resolvers-and-preprocessing">Resolvers and Preprocessing</a>
        N:resolverConfig // Resolvers and Preprocessing
        N:preprocessing // Resolvers and Preprocessing
      P:type // <a href="#column-specific-definitions">Column Specific Definitions</a>
      P:groupable [Boolean] // Column Specific Definitions
      N:filters [cq:WidgetCollection] // Column Specific Definitions
      N:aggregates [cq:WidgetCollection] // Column Specific Definitions

另请参阅定义新报告

列特定查询

这定义在单个列中使用的特定数据提取(来自报告数据结果集)。

N:definitions 
    N:queryBuilder
        P:property [String|String[]] 
        P:subPath
        P:secondaryProperty [String|String[]]
        P:secondarySubPath
  • property

    定义用于计算实际单元格值的属性。

    如果属性定义为String[],则扫描(按顺序)多个属性以查找实际值。

    例如,在以下情况下:

    property = [ "jcr:lastModified", "jcr:created" ]

    相应的值提取器(此处控制)将:

    • 检查是否有jcr:lastModified属性可用,如果可用,请使用它。
    • 如果没有jcr:lastModified属性可用,则将改用jcr:created的内容。
  • subPath

    如果结果不在查询返回的节点上,subPath将定义属性的实际位置。

  • secondaryProperty

    定义另一个属性,该属性还必须用于计算实际单元格值;这将仅用于某些列类型(差异和可排序)。

    例如,对于工作流实例报表,指定的属性用于存储开始和结束时间之间的时间差的实际值(以毫秒为单位)。

  • secondarySubPath

    与subPath类似,当使用secondaryProperty时。

在大多数情况下,只使用property

客户端筛选器

客户端过滤器从服务器返回的数据中提取要显示的信息。

注意

在应用整个服务器端处理后,将执行此过滤器客户端。

N:definitions
    N:data
        P:clientFilter [String]

clientFilter 定义为一个JavaScript函数,该函数:

  • 作为输入,接收一个参数;从服务器返回的数据(因此完全预处理)
  • 作为输出,返回已过滤(已处理)的值;从输入信息提取或导出的数据

以下示例从组件路径中提取相应的页面路径:

function(v) {
    var sepPos = v.lastIndexOf('/jcr:content');
    if (sepPos < 0) {
        return v;
    }
    return v.substring(sepPos + '/jcr:content'.length, v.length);
}

分辨率和预处理

处理队列定义各种解析器并配置预处理:

N:definitions
    N:data
        P:resolver
        N:resolverConfig
        N:preprocessing
            N:apply
            N:applyAfter
  • resolver

    定义要使用的解析程序。 提供以下解析器:

    • const

      将值映射到其他值;例如,它用于将en等常量解析为其等效值English

    • default

      默认解析程序。 这是一个虚拟解析程序,它实际上不会解决任何问题。

    • page

      解析相应页面的路径值;更准确地说,是到相应的jcr:content节点。 例如,/content/.../page/jcr:content/par/xyz解析为/content/.../page/jcr:content

    • path

      通过选择性地附加子路径并从已解析路径上的节点属性(由resolverConfig定义)中获取实际值来解析路径值。 例如,/content/.../page/jcr:contentpath可解析为jcr:title属性的内容,这意味着页面路径解析为页面标题。

    • pathextension

      通过预挂路径并从已解析路径的节点的属性中获取实际值来解析值。 例如,值de可能以/libs/wcm/core/resources/languages等路径为前缀,该路径使用属性language中的值将国家/地区代码de解析为语言描述German

  • resolverConfig

    提供解析程序的定义;可用选项取决于所选的resolver:

    • const

      使用属性指定要解析的常量。 属性名称定义要解析的常数;属性的值定义已解析的值。

      例如,名称= 1和​ =One的属性将解析为1:1。

    • default

      没有可用的配置。

    • page

      • propertyName (可选)

        定义应用于解析值的属性的名称。 如果未指定,则使用默认值​jcr:title(页面标题);对于page解析程序,这意味着首先将路径解析为页面路径,然后进一步解析为页面标题。

    • path

      • propertyName (可选)

        指定应用于解析值的属性的名称。 如果未指定,则使用默认值jcr:title

      • subPath (可选)

        此属性可用于指定在解析值之前附加到路径的后缀。

    • pathextension

      • path (mandatory)

        定义要前置的路径。

      • propertyName (必填)

        定义实际值所在的已解析路径上的属性。

      • i18n (可选;类型布尔值)

        确定解析的值是否应为​国际化(即使用CQ5的国际化服务)。

  • preprocessing

    预处理是可选的,可以(单独)绑定到处理阶段​apply​或​applyAfter:

    • apply

      初始预处理阶段(处理队列的表示中的步骤3)。

    • applyAfter

      在预处理后应用(处理队列的表示中步骤9)。

解析器

解析器用于提取所需信息。 各种解析器的示例有:

康斯特

下面将将字符串New version created的常量值VersionCreated解析为。

请参阅/libs/cq/reporting/components/auditreport/typecol/definitions/data

N:data
    P:resolver=const
    N:resolverConfig
        P:VersionCreated="New version created"

页面

解析对应页面的jcr:content(child)节点上jcr:description属性的路径值。

请参阅/libs/cq/reporting/components/compreport/pagecol/definitions/data

N:data
    P:resolver=page
    N:resolverConfig
        P:propertyName="jcr:description"

路径

下面将解析jcr:title属性内容的/content/.../page路径,这意味着页面路径已解析为页面标题。

请参阅/libs/cq/reporting/components/auditreport/pagecol/definitions/data

N:data
    P:resolver=path
    N:resolverConfig
        P:propertyName="jcr:title"
        P:subPath="/jcr:content"

路径扩展

下面用路径扩展名/libs/wcm/core/resources/languages预留一个值de,然后从属性language中取值,将国家/地区代码de解析为语言描述German

请参阅/libs/cq/reporting/components/userreport/languagecol/definitions/data

N:data
    P:resolver=pathextension
    N:resolverConfig
        P:path="/libs/wcm/core/resources/languages"
        P:propertyName="language"

预处理

preprocessing定义可应用于以下任一项:

  • 原始值:

    原始值的预处理定义直接在apply和/或applyAfter上指定。

  • 值:

    如有必要,可以为每个聚合提供单独的定义。

    要指定聚合值的显式预处理,预处理定义必须驻留在相应的aggregated子节点(apply/aggregated, applyAfter/aggregated)上。 如果需要对不同聚合进行显式预处理,则预处理定义位于具有相应聚合名称的子节点上(例如apply/aggregated/min/max或其他聚合)。

您可以指定以下任一选项,以便在预处理过程中使用:

  • 查找并替
    换模式找到时,指定的模式(定义为常规表达式)将被另一个模式替换;例如,这可用于提取原始文件的子字符串。

  • 数据类型格式化程序

    将数值转换为相对字符串;例如,表示时间差1小时的值“”将解析为字符串,如1:24PM (1 hour ago)

例如:

N:definitions
    N:data
        N:preprocessing
            N:apply|applyAfter
                P:pattern         // regex
                P:replace         // replacement for regex
                // and/or
                P:format          // data type formatter

预处理——查找和替换模式

对于预处理,可以指定pattern(定义为常规表达式或正则表达式),它位于并随后被replace模式替换:

  • pattern

    用于定位子字符串的常规表达式。

  • replace

    将用作原始字符串的替换的字符串或字符串的表示形式。 通常,它表示由常规表达式pattern所定位的字符串的子字符串。

示例替换可以分为:

  • 对于具有以下两个属性的节点definitions/data/preprocessing/apply:

    • pattern: (.*)(/jcr:content)(/|$)(.*)
    • replace: $1
  • 以下字符串到达:

    • /content/geometrixx/en/services/jcr:content/par/text
  • 将分为四个部分:

    • $1 - (.*) - /content/geometrixx/en/services
    • $2 - (/jcr:content) - /jcr:content
    • $3 - (/|$) - /
    • $4 - (.*) - par/text
  • 并替换为由$1表示的字符串:

    • /content/geometrixx/en/services

预处理——数据类型格式化程序

这些格式化程序将数字值转换为相对字符串。

例如,这可用于允许minavgmax聚合的时间列。 作为min/ avg/ max聚合显示为​时间差(例如,10 days ago),它们需要数据格式化程序。 为此,datedelta格式化程序被应用于min/ avg/ max聚集值。 如果count聚合也可用,则它不需要格式化程序,原始值也不需要。

当前可用的数据类型格式化程序包括:

  • format

    数据类型格式化程序:

    • duration

      持续时间是两个定义日期之间的时间跨度。 例如,工作流操作的开始和结束,该操作耗时1小时,从2/13/11 11:23h开始,到1小时后的2/13/11 12:23h结束。

      它将数值(解释为毫秒)转换为持续时间字符串;例如,30000的格式为* 30s。*

    • datedelta

      Datadelta是过去某个日期到“现在”的时间跨度(因此,如果在以后某个时间点查看报告,则其结果会有所不同)。

      它将数值(解释为以天为单位的时间差)转换为相对日期字符串。 例如,1的格式设置为1天前。

以下示例为minmax聚合定义datedelta格式:

N:definitions
    N:data
        N:preprocessing
            N:apply
                N:aggregated
                    N:min
                        P:format = "datedelta"
                    N:max
                        P:format = "datedelta"

列特定定义

特定于列的定义定义了该列可用的过滤器和聚合。

N:definitions
    P:type
    P:groupable [Boolean]
    N:filters [cq:WidgetCollection] 
    [
        N:<name> // array of nodes (names irrelevant) with the following properties:
            P:filterType
            P:id
            P:phase
    ]
    N:aggregates [cq:WidgetCollection]
    [
        N:<name> // array of nodes (names irrelevant) with the following properties:
            P:text
            P:type
    ]
  • type

    以下选项可作为标准选项提供:

    • string

    • number

    • int

    • date

    • diff

    • timeslot

      用于提取聚合所需日期的部分部分(例如,按年分组以获取每年的聚合数据)。

    • sortable

      用于使用不同值(从不同属性取)进行排序和显示的值。
      此外, 以上任何一项均可定义为多值;例如,string[]定义字符串数组。

    值提取器由列类型选择。 如果某列类型有值提取器,则使用此提取器。 否则,使用默认值提取器。

    类型可以(可选)采用参数。 例如,timeslot:year从日期字段提取年份。 类型及其参数:

    • timeslot -这些值与相应的常量比较 java.utils.Calendar

      • timeslot:year - Calendar.YEAR
      • timeslot:month-of-year - Calendar.MONTH
      • timeslot:week-of-year - Calendar.WEEK_OF_YEAR
      • timeslot:day-of-month - Calendar.DAY_OF_MONTH
      • timeslot:day-of-week - Calendar.DAY_OF_WEEK
      • timeslot:day-of-year - Calendar.DAY_OF_YEAR
      • timeslot:hour-of-day - Calendar.HOUR_OF_DAY
      • timeslot:minute-of-hour - Calendar.MINUTE
  • groupable

    定义报表是否可以按此列进行分组。

  • filters

    筛选器定义。

    • filterType

      可用过滤器包括:

      • string

        基于字符串的筛选器。

    • id

      筛选器标识符。

    • phase

      可用阶段:

      • raw

        对原始数据应用过滤器。

      • preprocessed

        对预处理的数据应用过滤器。

      • resolved

        筛选器应用于已解析的数据。

  • aggregates

    聚合定义。

    • text

      聚合的文本名称。 如果未指定text,则将采用默认的聚合描述;例如,minimum将用于min聚合。

    • type

      聚合类型。 可用聚合包括:

      • count

        计算行数。

      • count-nonempty

        计算非空行数。

      • min

        提供最小值。

      • max

        提供最大值。

      • average

        提供平均值。

      • sum

        提供所有值的总和。

      • median

        提供中值。

      • percentile95

        取所有值的第95百分位。

列默认值

它用于定义列的默认值:

N:defaults
    P:aggregate

事件和操作

“编辑配置”定义监听器检测的必要事件,以及在这些事件发生后应用的操作。 有关背景信息,请参见组件开发简介

必须定义以下值,以确保满足所有必需的操作:

N:cq:editConfig [cq:EditConfig] 
    P:cq:actions [String[]] = "insert", "delete" 
    P:cq:dialogMode = "floating"
    P:cq:layout = "auto"
    N:cq:listeners [cq:EditListenersConfig]
        P:aftercreate = "REFRESH_INSERTED"
        P:afterdelete = "REFRESH_SELF"
        P:afteredit = "REFRESH_SELF"
        P:afterinsert = "REFRESH_INSERTED"
        P:aftermove = "REFRESH_SELF"
        P:afterremove = "REFRESH_SELF"

常规列

通用列是扩展,其中(大多数)列定义存储在列节点(而非组件节点)的实例上。

它们使用一个(标准)对话框,您可以为单个通用组件自定义该对话框。 此对话框允许报表用户在报表页面上定义通用列的列属性(使用菜单选项​列属性……)。)。

例如,用户报告​的​Generic​列;请参阅/libs/cq/reporting/components/userreport/genericcol

要使列成为通用列:

  • 将列definition节点的type属性设置为generic

    请参阅/libs/cq/reporting/components/userreport/genericcol/definitions

  • 在列的definition节点下指定(标准)对话框定义。

    请参阅/libs/cq/reporting/components/userreport/genericcol/definitions/dialog

    • 对话框的字段必须引用与相应组件属性相同的名称(包括其路径)。

      例如,如果要使通用对话框配置通用列的类型,请使用名称为./definitions/type的字段。

    • 使用UI/对话框定义的属性优先于在columnbase组件上定义的属性。

  • 定义编辑配置。

    请参阅/libs/cq/reporting/components/userreport/genericcol/cq:editConfig

  • 使用标准AEM方法定义(附加)列属性。

    请注意,对于在组件实例和列实例上定义的属性,列实例上的值优先。

    通用列的可用属性包括:

    • jcr:title -列名称
    • definitions/aggregates -聚合
    • definitions/filters -过滤器
    • definitions/type-列的类型(必须在对话框中定义,使用选择器/组合框或隐藏字段)
    • definitions/data/resolver 和( definitions/data/resolverConfig 但不是 definitions/data/preprocessing.../clientFilter)-解析程序和配置
    • definitions/queryBuilder -查询构建器配置
    • defaults/aggregate -默认聚合

    如果​用户报告​上的通用列有新实例,则使用对话框定义的属性将保留在以下位置:

    /etc/reports/userreport/jcr:content/report/columns/genericcol/settings/generic

报告设计

设计定义了可用于创建报告的列类型。 它还定义向其添加列的段落系统。

强烈建议您为每个报告创建单独的设计。 这确保了完全的灵活性。 另请参阅定义新报告

默认报告组件位于/etc/designs/reports下。

报告的位置取决于组件的位置:

  • /etc/designs/reports/<yourReport> 如果报告位于不同位置,则适合 /apps/cq/reporting

  • /etc/designs/<yourProject>/reports/<*yourReport*> 对于使用模式的报 /apps/<yourProject>/reports

必需的设计属性已注册到jcr:content/reportpage/report/columns(例如,/etc/designs/reports/<reportName>/jcr:content/reportpage/report/columns):

  • components

    报表上允许的任何组件和/或组件组。

  • sling:resourceType

    值为cq/reporting/components/repparsys的属性。

示例设计片段(取自组件报告的设计)为:

<!-- ... -->
    <jcr:content
        jcr:primaryType="nt:unstructured"
        jcr:title="Component Report"
        sling:resourceType="wcm/core/components/designer">
        <reportpage jcr:primaryType="nt:unstructured">
            <report jcr:primaryType="nt:unstructured">
                <columns
                    jcr:primaryType="nt:unstructured"
                    sling:resourceType="cq/reporting/components/repparsys"
                    components="group:Component Report"/>
            </report>
        </reportpage>
    </jcr:content>
<!-- ... -->

无需为各个列指定设计。 可在设计模式下定义可用列。

注意

建议不要对标准报告设计进行任何更改。 这是为了确保在升级或安装修补程序时不会丢失任何更改。

如果要自定义标准报告,请复制报告及其设计。

注意

在创建报告时,可以自动创建默认列。 模板中指定了这些值。

报告模板

每个报告类型都必须提供模板。 这些是标准CQ模板,可进行相应配置。

模板必须:

  • sling:resourceType设置为cq/reporting/components/reportpage

  • 指示要使用的设计

  • 通过sling:resourceType属性创建引用容器(reportbase)组件的report子节点

示例模板片段(取自组件报表模板)为:

<!-- ... -->
    <jcr:content
        cq:designPath="/etc/designs/reports/compreport"
        jcr:primaryType="cq:PageContent"
        sling:resourceType="cq/reporting/components/reportpage">
        <report
            jcr:primaryType="nt:unstructured"
            sling:resourceType="cq/reporting/components/compreport/compreport"/>
    </jcr:content>
<!-- .. -->

显示根路径(取自用户报表模板)的定义的示例模板片段是:

<!-- ... -->
    <jcr:content
        cq:designPath="/etc/designs/reports/userreport"
        jcr:primaryType="cq:PageContent"
        sling:resourceType="cq/reporting/components/reportpage">
        <report
            jcr:primaryType="nt:unstructured"
            rootPath="/home/users"
            sling:resourceType="cq/reporting/components/compreport/compreport"/>
    </jcr:content>
<!-- .. -->

默认报告模板位于/libs/cq/reporting/templates下。

但是,强烈建议您不要更新这些节点,而是在/apps/cq/reporting/templates下创建您自己的组件节点,或者在更合适的/apps/<yourProject>/reports/templates下创建组件节点。

例如(另请参见报表组件位置):

N:apps 
    N:cq [nt:folder]
        N:reporting|reports [sling:Folder]
            N:templates [sling:Folder]

在此下,您可以为模板创建根:

N:apps 
    N:cq [nt:folder]
        N:reporting|reports [sling:Folder]
            N:templates [sling:Folder]
                N:<reportname> [sling:Folder]

创建您自己的报告——一个示例

定义新报告

要定义新报告,您必须创建并配置:

  1. 报表组件的根。
  2. 报表库组件。
  3. 一个或多个列基组件。
  4. 报表设计。
  5. 报表模板的根。
  6. 报表模板。

为了说明这些步骤,以下示例定义了一个列表库内所有OSGi配置的报告;即sling:OsgiConfig节点的所有实例。

注意

复制现有报告,然后自定义新版本是一种替代方法。

  1. 为新报表创建根节点。

    例如,在/apps/cq/reporting/components/osgireport下。

    N:cq [nt:folder]
        N:reporting [sling:Folder]
            N:components [sling:Folder]
                N:osgireport [sling:Folder]
    
  2. 定义报表库。 例如,/apps/cq/reporting/components/osgireport下的osgireport[cq:Component]

    N:osgireport [sling:Folder]
        N:osgireport [cq:Component]
            P:sling:resourceSuperType [String] = "cq/reporting/components/reportbase"
            N:charting [nt:unstructured]
                N:settings [nt:unstructured]
                    N:active [cq:WidgetCollection]
                        N:0 [nt:unstructured]
                            P:id [String] = "pie"
                        N:1 [nt:unstructured]
                            P:id [String] = "lineseries"
                N:definitions [cq:WidgetCollections]
                    N:0 [nt:unstructured]
                        P:id [String] = "pie"
                        P:maxRadius [Long] = 180
                        P:type [String] = "pie"
                    N:1 [nt:unstructured]
                        P:id [String] = "lineseries"
                        P:type [String] = "lineseries"
            N:dialog [cq:Dialog]
                P:height [Long] = 424
                N:items [cq:WidgetCollection]
                    N:props [cq:Panel]
                        N:items [cq:WidgetCollection]
                            N:title [cq:Widget]
                                P:path [String] = "/libs/cq/reporting/components/commons/title.infinity.json"
                                P:xtype [String] = "cqinclude"
                            N:description [cq:Widget]
                                P:path [String] = "/libs/cq/reporting/components/commons/description.infinity.json"
                                P:xtype [String] = "cqinclude"
                            N:rootPath [cq:Widget]
                                P:fieldLabel [String] = "Root path"
                                P:name [String] = "./report/rootPath"
                                P:xtype [String] = "pathfield"
                            N:processing [cq:Widget]
                                P:path [String] = "/libs/cq/reporting/components/commons/processing.infinity.json"
                                P:xtype [String] = "cqinclude"
                            N:scheduling [cq:Widget]
                                P:path [String] = "/libs/cq/reporting/components/commons/scheduling.infinity.json"
                                P:xtype [String] = "cqinclude"
            N:queryBuilder [nt:unstructured]
                P:nodeTypes [String[]] = "sling:OsgiConfig"
    

    这定义了报表基础组件,它:

    • 搜索类型为sling:OsgiConfig的所有节点
    • 显示pielineseries图表
    • 为用户提供配置报告的对话框
  3. 定义您的第一列(列基)组件。 例如,/apps/cq/reporting/components/osgireport下的bundlecol[cq:Component]

    N:osgireport [sling:Folder]
        N:bundlecol [cq:Component]
            P:componentGroup [String] = "OSGi Report"
            P:jcr:title = "Bundle"
            P:sling:resourceSuperType [String] = "cq/reporting/components/columnbase"
            N:cq:editConfig [cq:EditConfig]
                P:cq:actions [String[]] = "insert", "delete"
                P:cq:dialogMode [String] = "floating"
                P:cq:layout [String] = "auto"
                N:cq:listeners [cq:EditListenersConfig]
                    P:aftercreate [String] "REFRESH_INSERTED"
                    P:afterdelete [String] "REFRESH_SELF"
                    P:afteredit [String] "REFRESH_SELF"
                    P:afterinsert [String] "REFRESH_INSERTED"
                    P:aftermove [String] "REFRESH_SELF"
                    P:afterremove [String] "REFRESH_SELF"
            N:defaults [nt:unstructured]
                P:aggregate [String] = "count"
            N:definitions [nt:unstructured]
                P:groupable [Boolean] = false
                P:type [String] = "string"
                N:queryBuilder [nt:unstructured]
                    P:property [String] = "jcr:path"
    

    它定义一个列基组件,它:

    • 搜索并返回它从服务器接收的值;在这种情况下,每个sling:OsgiConfig节点的属性jcr:path
    • 提供count聚合
    • 不可分组
    • 标题为Bundle(表中的列标题)
    • 位于sidekick组OSGi Report
    • 刷新指定事件
    注意

    在本示例中,没有N:dataP:clientFilter的定义。 这是因为从服务器收到的值是按1:1返回的——这是默认行为。

    这与定义相同:

    N:data [nt:unstructured]
    P:clientFilter [String] = "function(v) { return v; }"
    

    其中函数只返回它收到的值。

  4. 定义报表设计。 例如,/etc/designs/reports下的osgireport[cq:Page]

    N:osgireport [cq:Page]
        N:jcr:content [nt:unstructured]
            P:jcr:title [String] = "OSGi report"
            P:sling:resourceType [String] = "wcm/core/components/designer"
            N:reportpage [nt:unstructured]
                N:report [nt:unstructured]
                    N:columns [nt:unstructured]
                        P:components [String] = "group:OSGi Report"
                        P:sling:resourceType [String] = "cq/reporting/components/repparsys"
    
  5. 为新报表模板创建根节点。

    例如,在/apps/cq/reporting/templates/osgireport下。

    N:cq [nt:folder]
        N:reporting [sling:Folder]
            N:templates [sling:Folder]
                N:osgireport [cq:Template]
    
  6. 定义报表模板。 例如,/apps/cq/reporting/templates下的osgireport[cq:Template]

    N:osgireport [cq:Template]
        P:allowedPaths [String[]] = "/etc/reports(/.*)?"
        P:jcr:description [String] = "Use this report generator to create a new OSGi report."
        P:jcr:title [String] = "OSGi Report Template"
        P:ranking [Long] = 100
        P:shortTitle [String] = "OSGi Report"
        N:jcr:content [cq:PageContent]
            P:cq:designPath [String] = "/etc/designs/reports/osgireport"
            P:sling:resourceType [String] = "cq/reporting/components/reportpage"
            N:report [nt:unstructured]
                P:rootPath [String] = "/"
                P:sling:resourceType [String] = "cq/reporting/components/osgireport/osgireport"
        N:thumbnail.png [nt:file]
    

    这定义了一个模板:

    • 为生成的报告定义allowedPaths —— 在上述情况下,位于/etc/reports
    • 提供模板的标题和说明
    • 提供用于模板列表的缩略图图像(上面未列出此节点的完整定义——最简单的方法是从现有报表复制thumbnail.png实例)。

创建新报告的实例

现在可以创建新报表的实例:

  1. 打开​工具​控制台。

  2. 在左侧窗格中选择​报告

  3. 然后​新建……。 定义​标题​和​名称,从模板列表中选择新的报告类型(OSGi报告模板),然后单击​创建

  4. 您的新报表实例将显示在列表中。 多次单击此图标可打开。

  5. 从Sidekick中拖动组件(例如,OSGi Report​组中的​Bundle)以创建第一列,并开始报告定义

    注意

    由于此示例没有任何可分组列,因此图表将不可用。 要查看图表,请将groupable设置为true:

    N:osgireport [sling:Folder]
    N:bundlecol [cq:Component]
    N:definitions [nt:unstructured]
    P:groupable [Boolean] = true
    

配置Report Framework Services

本节介绍用于实现报告框架的OSGi服务的高级配置选项。

可以使用Web控制台的“配置”菜单查看这些组件(例如,http://localhost:4502/system/console/configMgr)。 与AEM合作时,有多种方法管理此类服务的配置设置;请参阅配置OSGi以了解更多详细信息和建议的做法。

基本服务(第CQ天报告配置)

  • 间区定义为创建时区历史数据。这是为了确保历史图表显示全球每个用户的相同数据。

  • Locale 定义要与时间区一起用于历 ​史数据的区域设置。区域设置用于确定特定于区域设置的某些日历设置(例如,一周的第一天是星期天还是星期一)。

  • 快照 路径定义存储历史图表快照的根路径。

  • 报告的 路径定义报告所在的路径。快照服务使用它来确定报表以实际为其拍摄快照。

  • 日快照定义每日快照拍摄的时间。指定的小时位于服务器的本地时区中。

  • 每小 时快照定义每小时拍摄快照的分钟数。

  • 行(最大) 定义每个快照存储的最大行数。应合理选择此值;如果数据过高,则会影响存储库的大小,如果太低,则数据可能不准确,因为历史数据的处理方式。

  • 假数据,如果启用,可使用选择器创建假历史 fakedata 数据;如果禁用,则使用选 fakedata 择器将引发异常。

    由于数据是假的,因此必须仅​**​用于测试和调试。

    使用fakedata选择器将隐式完成报告,因此所有现有数据都将丢失;数据可以手动还原,但这可能是一个耗时的过程。

  • 快照 用户定义可用于拍摄快照的可选用户。

    基本上,快照是为已完成报告的用户拍摄的。 可能存在以下情况(例如,在发布系统上,此用户不存在,因为其帐户尚未复制),您希望指定使用的备用用户。

    此外,指定用户可能会带来安全风险。

  • 强制使用快照,如果启用,则所有快照都将与在“快照”用户下指定的用 户一起拍摄。如果处理不正确,这可能会对安全造成严重影响。

缓存设置(Day CQ报告缓存)

  • 启用”允许您启用或禁用报告数据的缓存。启用报告缓存将在多个请求期间将报告数据保留在内存中。 这可能会提高性能,但会导致内存消耗增加,在极端情况下可能导致内存不足。
  • TTL 定义缓存报告数据的时间(以秒为单位)。数量越大,性能越高,但如果数据在时间段内发生变化,也可能返回不准确的数据。
  • Max entries定义要在任何时间缓存的最大报告数。
注意

每个用户和语言的报告数据可能不同。 因此,根据报告、用户和语言缓存报告数据。 这意味着2的​最大条目​值实际上缓存了以下任一数据:

  • 针对不同语言设置的两个用户的一个报告
  • 一个用户和两个报告

在此页面上