開發報表 developing-reports

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
Developing

建立對象：

Developer

CAUTION

AEM 6.4已結束延伸支援，本檔案不再更新。如需詳細資訊，請參閱技術支援期. 尋找支援的版本此處.

AEM提供標準報表其中大部分以報告架構為基礎。

使用架構，您可以擴充這些標準報表，或開發您自己的全新報表。報表架構與現有CQ5概念和原則緊密整合，讓開發人員可以將其現有的CQ5知識作為開發報表的跳板。

對於隨AEM傳送的標準報表：

這些報表是在報表架構上建置：
下列報告以個別原則為基礎，因此無法延伸：

NOTE

教學課程建立您自己的報表 — 範例也說明可使用下列原則的數量。

您也可以參考標準報表，以查看其他實作範例。

NOTE

在下列範例和定義中，會使用下列標籤法：

每行定義一個節點或一個屬性，其中：
- N:<name> [<nodeType>]
  
  說明名稱為 <*name*> 和節點類型 <*nodeType*>.
- P:<name> [<propertyType]
  
  說明名稱為 <*name*> 和屬性類型 <*propertyType*>.
- P:<name> = <value>
  
  說明屬性 <name> 的值 <value>.
縮進顯示節點之間的分層依賴關係。
以分隔的項目 |表示可能的項目清單；例如，類型或名稱：

例如 String|String[] 表示屬性可以是字串或字串[].
[] 描述陣列；例如字串[] 或節點陣列，如查詢定義.

除非另有說明，否則預設類型為：

節點 — nt:unstructured
屬性 - String

報告架構 reporting-framework

報告框架遵循下列原則：

它完全以CQ5 QueryBuilder執行的查詢所傳回的結果集為基礎。
結果集定義報表中顯示的資料。結果集中的每一列都對應於報表表格檢視中的一列。
可在結果集上執行的操作類似於RDBMS概念；主要分組和聚合.
大多數資料檢索和處理都是在伺服器端完成的。
用戶端需自行負責顯示預先處理的資料。只有次要的處理工作（例如在儲存格內容中建立連結）會在用戶端執行。

報表架構（由標準報表的結構圖示）使用下列建置區塊，由處理佇列饋送：

chlimage_1-248

報表頁面 report-page

報表頁面：

是標準CQ5頁面。
以為報表設定的標準CQ5範本.

報表庫 report-base

此 reportbase 元件構成任何報表的基礎：

保留查詢提供資料的基礎結果集。
是經過調整的段落系統，將包含所有欄( columnbase)新增至報表。
定義可用的圖表類型和當前活動的圖表類型。
定義編輯對話方塊，讓使用者設定報表的某些方面。

列基 column-base

每欄都是 columnbase 元件即：

是段落，由parsys使用( reportbase)。
定義連結至基礎結果集;即定義此結果集中引用的特定資料及其處理方式。
保留其他定義；例如可用的匯總和篩選，以及任何預設值。

查詢與資料檢索 the-query-and-data-retrieval

查詢：

定義為 reportbase 元件。
是根據 CQ QueryBuilder.
擷取用作報表基礎的資料。結果集（表）的每一行都與查詢返回的節點綁定。的特定資訊個別欄然後會從此資料集中擷取。
通常包含：
- 根路徑。
  
  這會指定要搜索的儲存庫的子樹。
  
  為了有助於將效能影響降至最低，建議（嘗試）將查詢限制在儲存庫的特定子樹。根路徑可在報表範本或由配置（編輯）對話框.
- 一或多個條件.
  
  這些規定是為了產生（初始）結果集；例如，節點類型限制或屬性限制。

這裡的關鍵點是，查詢結果集中返回的每個單一節點都用於在報表上產生單一列（因此為1:1關係）。

開發人員必須確保為報表定義的查詢會傳回適用於該報表的節點集。但是，節點本身並不需要保留所有所需資訊，這也可以從父節點和/或子節點派生。例如，用於使用者報表根據節點類型選擇節點(在本例中為 rep:user)。但是，此報表中的大部分欄不會直接從這些節點取得資料，而是從子節點取得資料 profile.

處理佇列 processing-queue

此查詢傳回要在報表上顯示為列的資料集。結果集中的每一列都會經過處理（伺服器端），位於幾個階段，則會傳送至用戶端以顯示在報表上。

這允許：

從基礎結果集中提取和導出值。

例如，它可讓您透過計算兩個屬性值之間的差異，將兩個屬性值視為單一值處理。
解析提取的值；這可以以多種方式完成。

例如，路徑可對應至標題（如各自較人類看得懂的內容中） jcr:title 屬性)。
在不同點套用篩選。
視需要建立複合值。

例如，由顯示給使用者的文字、要用於排序的值，以及用於建立連結的其他URL組成（在用戶端上）。

處理佇列的工作流程 workflow-of-the-processing-queue

下列工作流程代表處理佇列：

chlimage_1-249

處理佇列的階段 phases-of-the-processing-queue

其中詳細步驟和元素包括：

轉換由初始查詢(reportbase) 值提取器輸入基本結果集。

根據欄類型. 它們用於從基礎JCR查詢中讀取值，並從中建立結果集；之後，可以應用進一步處理。例如，對於 diff 類型，值提取器讀取兩個屬性，計算單個值，然後將其添加到結果集中。無法配置值提取器。
對於包含原始資料的初始結果集，初始濾波 (原始階段)。
值為 preprocessed;定義為套用階段。
篩選 (指派給 preprocessed 階段)，則會對預先處理的值執行。
值會解析；根據定義解析器.
篩選 (指派給 已解析 階段)，則會對解析的值執行。
資料是分組和匯總.
將陣列資料轉換為（字串型）清單，即可加以解析。

這是將多值結果轉換為可顯示的清單的隱式步驟；根據多值JCR屬性的儲存格值需要此變數。
值再次 preprocessed;定義為 afterApply 階段。
資料已排序。
處理的資料被傳輸到客戶機。

NOTE

傳回基礎資料結果集的初始查詢會在 reportbase 元件。

處理佇列的其他元素會定義於 columnbase 元件。

報告建構與設定 report-construction-and-configuration

建立和設定報表需要下列項目：

a 報表元件定義的位置
a reportbase 元件
一個或多個， columnbase 元件
a 頁面元件
a 報告設計
a 報表範本

報表元件的位置 location-of-report-components

預設報告部分持有於 /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

頁面元件 page-component

報表頁面必須使用 sling:resourceType of /libs/cq/reporting/components/reportpage.

自訂的頁面元件在大部分情況下不應是必要的。

報表基礎元件 report-base-component

每個報表類型都需要從衍生的容器元件 /libs/cq/reporting/components/reportbase.

此元件可作為整個報表的容器，並提供下列資訊：

此查詢定義.
安（可選）對話框來設定報表。
任何圖表已整合至報表。

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

查詢定義 query-definition

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操作）。

例如：

code language-none
`N:propertyConstraints [ N:0 P:sling:resourceType P:foundation/components/textimage N:1 P:jcr:modifiedBy P:admin ]`

會全部傳回 textimage 上次由修改的元件 admin 使用者。

nodeTypes

用於將結果集限制為指定的節點類型。可以指定多個節點類型。
mandatoryProperties

可用於將結果集限制為具有 all 指定屬性的。屬性的值不會納入考量。

所有項目皆為選用項目，且可視需要加以組合，但您至少必須定義其中一個項目。

圖表定義 chart-definitions

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
  
  由於可定義多個設定，因此您可以使用此設定來定義目前使用中的設定。這些節點由一系列節點定義(這些節點沒有強制命名慣例，但標準報告通常使用 0, 1… x)，每個都有下列屬性：
  - id
    
    活動圖表的標識。這必須符合圖表其中一個的id definitions.
definitions

定義報表可能可用的圖表類型。此 definitions 將由指定 active 設定。

定義是使用節點陣列來指定(通常稱為 0, 1… x)，且每個都具有下列屬性：
- id
  
  圖表標識。
- type
  
  可用圖表的類型。選擇：
  - pie
    圓形圖。僅從目前資料產生。
  - lineseries
    一系列線（代表實際快照的連結點）。僅從歷史資料產生。
- 其他屬性可用，取決於圖表類型：
  - 圖表類型 pie:
    - maxRadius ( Double/Long)
      
      餅圖允許的最大半徑；因此，圖表允許的最大大小（無圖例）。若 fixedRadius 已定義。
    - minRadius ( Double/Long)
      
      餅圖允許的最小半徑。若 fixedRadius 已定義。
    - fixedRadius ( Double/Long)定義圓形圖的固定半徑。
  - 圖表類型 lineseries:
    - totals ( Boolean)
      
      若另有一行顯示總計應顯示。
      預設: false
    - series ( Long)
      
      要顯示的行/系列數。
      預設值： 9 （這也是允許的上限）
    - hoverLimit ( Long)
      
      要為其顯示彈出窗口的聚合快照的最大數量（顯示在每條水準線上的點，表示不同值），即當用戶將滑鼠移到圖表圖例中的不同值或相應標籤上時。
      
      預設值： 35 （亦即，如果目前圖表設定適用超過35個不同值，則完全不會顯示快顯視窗）。
      
      另外有10個快顯視窗的限制，可同時顯示（當將滑鼠移到圖例文字上時，可顯示多個快顯視窗）。

配置對話框 configuration-dialog

每個報表都可以有設定對話方塊，讓使用者可為報表指定各種參數。您可以透過編輯按鈕。

此對話方塊是標準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>

提供數個預先設定的元件；可在對話方塊中參考，使用 xtype 值為的屬性 cqinclude:

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

用於為歷史圖表安排快照的選擇器。

NOTE

所參考的元件必須包含在 .infinity.json 尾碼（請參閱上例）。

根路徑 root-path

此外，還可為報表定義根路徑：

rootPath

這會將報表限制在存放庫的特定區段（樹狀或子樹狀），這是效能最佳化建議的報表。根路徑由 rootPath 屬性 report 節點（建立頁面時從範本取用）。

可由下列項目指定：
- the 報表範本（作為固定值或作為配置對話框的預設值）。
- 使用者（使用此參數）

列基元件 column-base-component

每個欄類型都需要衍生自的元件 /libs/cq/reporting/components/columnbase.

欄元件定義下列組合：

此列特定查詢設定。
此解析器和預處理.
此欄特定定義 (例如篩選器和匯總； definitions 子節點)。
欄預設值.
此用戶端篩選從伺服器返回的資料中提取要顯示的資訊。
此外，列元件必須提供 cq:editConfig. 來定義事件和動作必填。
的設定一般欄.

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

另請參閱定義新報表.

列特定查詢 column-specific-query

這會定義特定資料擷取(從報表資料結果集)，以用於個別欄。

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

property

定義用於計算實際儲存格值的屬性。

如果屬性定義為字串[] 會掃描多個屬性（依序）以尋找實際值。

例如，在下列案例中：

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

對應的值提取器（此處控制）將：
- 檢查是否有jcr:lastModified屬性可用，如果有，請使用它。
- 如果沒有jcr:lastModified屬性可用，則將改用jcr:created的內容。
subPath

如果結果未位於查詢返回的節點上， subPath 會定義屬性的實際位置。
secondaryProperty

定義第二個屬性，該屬性也必須用於計算實際儲存格值；這將僅用於某些列類型（diff和sortable）。

例如，在「工作流實例報告」中，指定的屬性用於儲存開始時間和結束時間之間時間差的實際值（以毫秒為單位）。
secondarySubPath

類似於subPath，當 secondaryProperty 中所有規則的URL區段。

在大多數情況下，僅 property 中指定的規則。

用戶端篩選 client-filter

客戶端篩選器從伺服器返回的資料中提取要顯示的資訊。

NOTE

此篩選器會在套用完整個伺服器端處理後，在clientside執行。

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);
}

解析器和預處理 resolvers-and-preprocessing

此處理佇列定義各種解析器並配置預處理：

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)。例如， path of /content/.../page/jcr:content 可解析為 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 中所有規則的URL區段。
  - subPath (可選)
    
    此屬性可用來指定要在解析值之前附加至路徑的尾碼。
- pathextension
  - path （強制）
    
    定義要前置的路徑。
  - propertyName （強制）
    
    定義實際值所在的解析路徑上的屬性。
  - i18n （可選）類型布林值)
    
    決定解析的值是否應 國際化 (即使用 CQ5的國際化服務)。
preprocessing

預處理為選用，可以（個別）系結至處理階段套用或 applyAfter:
- apply
  
  初始預處理階段(表示處理佇列的步驟3)。
- applyAfter
  
  預處理後套用(表示處理佇列的步驟9)。

解析器 resolvers

解析器用於提取所需資訊。各種解析器的範例包括：

康斯特

下列項目將解析 VersionCreated 至字串 New version created.

請參閱 /libs/cq/reporting/components/auditreport/typecol/definitions/data.

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

Page

解析對應頁面之jcr:content(child)節點上jcr:description屬性的路徑值。

請參閱 /libs/cq/reporting/components/compreport/pagecol/definitions/data.

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

路徑

以下程式碼會解析 /content/.../page 至 jcr:title 屬性，這表示頁面路徑會解析為頁面標題。

請參閱 /libs/cq/reporting/components/auditreport/pagecol/definitions/data.

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

路徑擴充功能

下列項目會前置值 de 具有路徑擴展 /libs/wcm/core/resources/languages，然後從屬性中取用值 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

此 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

預處理 — 查找和替換模式 preprocessing-find-and-replace-patterns

對於預處理，您可以指定 pattern (定義為規則運算式或regex)，則會定位並取代 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

前置處理 — 資料類型格式化程式 preprocessing-data-type-formatters

這些格式化程式會將數值轉換為相對字串。

例如，這可用於允許 min, avg 和 max 匯總。 As min/ avg/ max 匯總會顯示為時差 (例如 10 days ago)，則需要資料格式化程式。對於此，a datedelta formatter被應用到 min/ avg/ max 匯總值。若 count 匯總也可用，因此不需要格式化程式，原始值也不需要。

目前可用的資料類型格式化程式包括：

format

資料類型格式化程式：
- duration
  
  持續時間是兩個定義日期之間的時間範圍。例如，工作流程動作的開始和結束(從2/13/11 11:23h開始，一小時後在2/13/11 12:23h結束)花了1小時。
  
  它會將數值（解譯為毫秒）轉換為持續時間字串；例如， 30000 格式為* 30s.*
- datedelta
  
  Datadelta是過去某個日期到「現在」的時間範圍（因此，如果稍後時間檢視報表，結果會不同）。
  
  它會將數值（以天為單位解譯為時間差）轉換為相對日期字串。例如，1的格式為1天前。

以下範例定義 datedelta 格式 min 和 max 匯總：

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

欄特定定義 column-specific-definitions

欄的特定定義會定義該欄可用的篩選器和匯總。

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個百分位數。

欄預設值 column-default-values

這可用來定義欄的預設值：

N:defaults
    P:aggregate

aggregate

有效 aggregate 值與的值相同 type 在 aggregates (請參閱欄特定定義（定義 — 篩選器/匯總） )。

事件和動作 events-and-actions

「編輯配置」定義偵聽器偵測的必要事件，以及這些事件發生後要套用的動作。請參閱元件開發簡介以了解背景資訊。

必須定義下列值，以確保滿足所有必要動作：

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-columns

一般欄是擴充功能，其中（大部分）欄定義儲存在欄節點（而非元件節點）的例項上。

它們會針對個別一般元件使用您自訂的（標準）對話方塊。此對話方塊可讓報表使用者定義報表頁面上一般欄的欄屬性（使用功能表選項） 列屬性……)。

例如一般欄 使用者報表;請參閱 /libs/cq/reporting/components/userreport/genericcol.

要使列成為泛型：

設定 type 欄的屬性 definition 節點到 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

報表設計 report-design

設計會定義哪些欄類型可用於建立報表。它還定義了添加列的段落系統。

強烈建議您為每個報表建立個別設計。這可確保完全的彈性。另請參閱定義新報表.

預設報告部分持有於 /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>
<!-- ... -->

不需要指定個別欄的設計。可在設計模式中定義可用列。

NOTE

建議您不要對標準報表設計進行任何變更。這是為了確保您不會在升級或安裝Hotfix時遺失任何變更。

如果您想自訂標準報表，請複製報表及其設計。

NOTE

建立報表時，可自動建立預設欄。這些在範本中指定。

報表範本 report-template

每種報表類型都必須提供範本。這些是標準的 CQ範本可依此設定。

範本必須：

設定 sling:resourceType to cq/reporting/components/reportpage
指明要使用的設計
建立 report 引用容器的子節點( reportbase)元件 sling:resourceType 屬性

範本片段範例（取自元件報表範本）為：

<!-- ... -->
    <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]

建立您自己的報表 — 範例 creating-your-own-report-an-example

定義新報表 defining-your-new-report

若要定義新報表，您必須建立並設定：

報表元件的根。
報表庫元件。
一個或多個列基元件。
報表設計。
報表範本的根。
報表範本。

為了說明這些步驟，以下範例定義了一份報告，其中列出儲存庫內的所有OSGi設定；即， sling:OsgiConfig 節點。

NOTE

複製現有報表，然後自訂新版本是另一種方法。

為新報表建立根節點。

例如，在 /apps/cq/reporting/components/osgireport.

code language-xml
`N:cq [nt:folder] N:reporting [sling:Folder] N:components [sling:Folder] N:osgireport [sling:Folder]`

定義報表庫。例如 osgireport[cq:Component] 在 /apps/cq/reporting/components/osgireport.

code language-xml

code language-xml
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"

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
同時顯示 pie 和 lineseries 圖表
提供對話方塊供使用者設定報表

定義第一列（列基）元件。例如 bundlecol[cq:Component] 在 /apps/cq/reporting/components/osgireport.

code language-xml

code language-xml
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"

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"

這會定義一個列基元件，該元件包括：

搜尋並傳回從伺服器收到的值；在此案例中，屬性 jcr:path 每 sling:OsgiConfig 節點
提供 count 匯總
無法分組
有標題 Bundle （表格內的欄標題）
是sidekick組 OSGi Report
在指定事件中刷新

note note

NOTE

在此範例中， N:data 和 P:clientFilter. 這是因為從伺服器收到的值是以1:1為基礎傳回的 — 這是預設行為。

這與定義相同：

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

其中，函式只會傳回其收到的值。

定義報表設計。例如 osgireport[cq:Page] 在 /etc/designs/reports.

code language-xml

code language-xml
`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"`

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"

為新報表範本建立根節點。

例如，在 /apps/cq/reporting/templates/osgireport.

code language-xml
`N:cq [nt:folder] N:reporting [sling:Folder] N:templates [sling:Folder] N:osgireport [cq:Template]`

定義報表範本。例如 osgireport[cq:Template] 在 /apps/cq/reporting/templates.

code language-xml

code language-xml
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]

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例項）。

建立新報表的例項 creating-an-instance-of-your-new-report

現在可以建立新報表的例項：

開啟工具控制台。
選擇報表在左窗格中。
然後 新…… 的上界。定義標題和名稱，請選取新的報表類型( OSGi報表範本)，然後按一下建立.
您的新報表例項會出現在清單中。按兩下以開啟。

拖曳元件(在此範例中，捆綁在 OSGi報表 group)建立第一欄和啟動報表定義.

note note

NOTE

由於此示例沒有任何可分組的列，因此圖表將不可用。要查看圖表，請設定 groupable to true:

code language-none
`N:osgireport [sling:Folder] N:bundlecol [cq:Component] N:definitions [nt:unstructured] P:groupable [Boolean] = true`

設定報表架構服務 configuring-the-report-framework-services

本節說明實作報表架構之OSGi服務的進階設定選項。

您可以使用Web主控台的「設定」功能表來檢視這些項目(例如 http://localhost:4502/system/console/configMgr)。使用AEM時，有數種方法可管理這類服務的組態設定；請參閱配置OSGi 以取得詳細資訊和建議的實務。

基本服務(Day CQ Reporting Configuration) basic-service-day-cq-reporting-configuration

時區定義為建立的時區歷史資料。這是為了確保歷史圖表為全球每位使用者顯示相同的資料。
地區定義要與時區的URL。區域設定用於確定某些特定於區域設定的日曆設定（例如，一週的第一天是星期日還是星期一）。
快照路徑 定義儲存歷史圖表快照的根路徑。
報表路徑 定義報表所在的路徑。快照服務將使用此功能來確定要為其實際拍攝快照的報表。
每日快照 定義每日快照拍攝時的每天小時。指定的小時位於伺服器的本地時區。
每小時快照 定義每小時快照拍攝時的每小時分鐘。
列數（最大值） 定義了每個快照所儲存的最大行數。應合理選擇此值；如果太高，則會影響儲存庫的大小，如果太低，資料可能不準確，因為歷史資料的處理方式。
假資料，若已啟用，則可使用 fakedata 選取器；如果已停用，請使用 fakedata 選取器會擲回例外狀況。

由於資料是假的，它必須僅限用於測試和偵錯。

使用 fakedata 選取器會以隱含方式完成報表，因此所有現有資料都會遺失；資料可以手動還原，但這可能會是個耗時的程式。
快照用戶 定義可用於拍攝快照的可選用戶。

基本上，快照是為已完成報告的用戶拍攝的。在某些情況下（例如，在發佈系統上，此使用者不存在，因為其帳戶尚未復寫），您會想要指定一個使用的後援使用者。

此外，指定使用者可能會帶來安全風險。
強制快照用戶，如果啟用，則所有快照都將使用 快照用戶. 如果處理不正確，可能會對安全性造成嚴重影響。

快取設定(Day CQ Reporting Cache) cache-settings-day-cq-reporting-cache

啟用可讓您啟用或停用報表資料的快取。啟用報表快取，會在數個請求期間將報表資料保留在記憶體中。這可能會提高效能，但會導致記憶體消耗增加，在極端情況下，可能會導致記憶體不足。
TTL 會定義快取報表資料的時間（以秒為單位）。數字越高，效能越好，但若資料在某個時段內變更，則可能也會傳回不正確的資料。
登入次數上限 定義任何時候要快取的報表數上限。

NOTE

每個使用者和語言的報表資料可能不同。因此，系統會根據報表、使用者和語言快取報表資料。這表示 登入次數上限 值 2 實際上快取資料，

使用不同語言設定的兩個使用者，一個報表
一個使用者和兩個報表

recommendation-more-help

2315f3f5-cb4a-4530-9999-30c8319c520e