Sviluppo di rapporti developing-reports

Questi rapporti si basano sul framework di reporting:

• Report componente
• Report attività pagina
• Report utente
• Report di istanze flusso di lavoro

Le seguenti relazioni si basano su singoli principi e pertanto non possono essere estese:

• Utilizzo disco
• Verifica stato
• Report di workflow

È interamente basato su set di risultati restituiti da una query eseguita dal QueryBuilder CQ5.

Il set di risultati definisce i dati visualizzati nel rapporto. Ogni riga del set di risultati corrisponde a una riga nella vista a tabella del rapporto.

Le operazioni disponibili per l'esecuzione nel set di risultati sono simili a concetti RDBMS; principalmente raggruppamento e aggregazione.

La maggior parte del recupero e dell’elaborazione dei dati viene effettuata lato server.

Il cliente è l’unico responsabile della visualizzazione dei dati preelaborati. Solo le attività di elaborazione minori (ad esempio, la creazione di collegamenti nel contenuto delle celle) vengono eseguite sul lato client.

Mantiene la definizione della query che fornisce il set di risultati sottostante dei dati.

È un sistema paragrafo adattato che contiene tutte le colonne ( columnbase) aggiunte al report.

Definisce quali tipi di grafico sono disponibili e quali sono attualmente attivi.

Definisce la finestra di dialogo Modifica, che consente all'utente di configurare alcuni aspetti del report.

È definito come parte del componente reportbase.

È basato su CQ QueryBuilder.

Recupera i dati utilizzati come base del rapporto. Ogni riga del set di risultati (tabella) è associata a un nodo come restituito dalla query. Le informazioni specifiche per singole colonne vengono quindi estratte da questo set di dati.

Di solito è costituito da:

• Un percorso di directory principale.

  Specifica la sottostruttura del repository in cui eseguire la ricerca.

  Per ridurre al minimo l’impatto sulle prestazioni, è consigliabile (provare a) limitare la query a una sottostruttura specifica dell’archivio. Il percorso principale può essere predefinito nel modello di report o impostato dall'utente nella finestra di dialogo Configurazione (Modifica).

• Uno o più criteri.

  Questi vengono imposti per produrre il set di risultati (iniziale); includono, ad esempio, restrizioni sul tipo di nodo o vincoli di proprietà.

Estrazione e derivazione dei valori dal set di risultati sottostante.

Ad esempio, ti consente di elaborare due valori di proprietà come un singolo valore calcolando la differenza tra i due.

Risoluzione dei valori estratti; questa operazione può essere eseguita in vari modi.

Ad esempio, è possibile mappare i percorsi a un titolo (come nel contenuto leggibile dalla persona della rispettiva proprietà jcr:title).

Applicazione di filtri in vari punti.

Se necessario, create i valori composti.

Ad esempio, costituito da un testo visualizzato dall’utente, da un valore da utilizzare per l’ordinamento e da un URL aggiuntivo utilizzato (sul lato client) per la creazione di un collegamento.

propertyConstraints

Limita il set di risultati ai nodi con proprietà specifiche con valori specifici. Se sono specificati più vincoli, il nodo deve soddisfare tutti (operazione AND).

Ad esempio:

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

Restituisce tutti i textimage componenti modificati per ultimi dall'utente admin.

nodeTypes

Utilizzato per limitare il set di risultati ai tipi di nodo specificati. È possibile specificare più tipi di nodo.

mandatoryProperties

Limita il set di risultati ai nodi che hanno tutti le proprietà specificate. Il valore delle proprietà non è considerato per.

settings

Contiene le definizioni per i grafici attivi.

• active

  Poiché è possibile definire più impostazioni, è possibile utilizzarle per definire quali sono attualmente attive. Questi sono definiti da un array di nodi (non esiste alcuna convenzione di denominazione obbligatoria per questi nodi, ma i report standard utilizzano spesso 0, 1. x), ciascuno con la seguente proprietà:

  • id

    Identificazione dei grafici attivi. Deve corrispondere all'ID di uno dei grafici definitions.

definitions

Definisce i tipi di grafico potenzialmente disponibili per il report. definitions da utilizzare è specificato dalle impostazioni active.

Le definizioni vengono specificate utilizzando un array di nodi (di nuovo spesso denominati 0, 1). x), ciascuno con le seguenti proprietà:

• id

  Identificazione del grafico.

• type

  Tipo di grafico disponibile. Seleziona da:

  • pie
    Grafico a torta. Generato solo dai dati correnti.

  • lineseries
    Serie di linee (punti di collegamento che rappresentano gli snapshot effettivi). Generato solo da dati storici.

• Sono disponibili proprietà aggiuntive, a seconda del tipo di grafico:

  • tipo di grafico pie:

    • maxRadius ( Double/Long)

      Raggio massimo consentito per il grafico a torta, quindi dimensione massima consentita per il grafico (senza legenda). Ignorato se fixedRadius è definito.

    • minRadius ( Double/Long)

      Raggio minimo consentito per il grafico a torta. Ignorato se fixedRadius è definito.

    • fixedRadius ( Double/Long)
      Definisce un raggio fisso per il grafico a torta.

  • tipo di grafico lineseries:

    • totals ( Boolean)

      True se deve essere visualizzata una riga aggiuntiva che mostra il totale.
      predefinito: false

    • series ( Long)

      Numero di righe/serie da visualizzare.
      predefinito: 9 (anche questo è il massimo consentito)

    • hoverLimit ( Long)

      Numero massimo di istantanee aggregate (punti visualizzati su ogni linea orizzontale, che rappresentano valori distinti) per le quali devono essere visualizzati i popup. ovvero quando l'utente passa il mouse su un valore distinto o su un'etichetta corrispondente nella legenda del grafico.

      impostazione predefinita: 35 (ovvero, non vengono visualizzati popup se sono applicabili più di 35 valori distinti per le impostazioni correnti del grafico).

      Esiste un limite aggiuntivo di dieci pop-up che possono essere visualizzati in parallelo (è possibile visualizzare più pop-up quando si passa il mouse sui testi delle legende).

title

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

Campo di testo per definire il titolo del rapporto.

description

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

Area di testo per definire la descrizione del rapporto.

processing

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

Selettore per la modalità di elaborazione del rapporto (caricamento manuale/automatico dei dati).

scheduling

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

Selettore per la pianificazione di snapshot per il grafico cronologico.

rootPath

Questo limita il report a una determinata sezione (albero o sottoalbero) dell’archivio, consigliata per l’ottimizzazione delle prestazioni. Il percorso principale è specificato dalla proprietà rootPath del nodo report di ogni pagina del report (ricavato dal modello al momento della creazione della pagina).

Può essere specificato da:

• il modello di report (come valore fisso o predefinito per la finestra di dialogo di configurazione).
• utente (utilizzando questo parametro)

property

Definisce la proprietà da utilizzare per calcolare il valore effettivo della cella.

Se una proprietà è definita come String[], vengono analizzate più proprietà (in sequenza) per trovare il valore effettivo.

Ad esempio, se è presente:

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

L’estrattore di valore corrispondente (che si trova qui sotto controllo):

• Verifica se è disponibile una proprietà jcr:lastModified e, in tal caso, utilizzarla.
• Se non è disponibile alcuna proprietà jcr:lastModified, viene utilizzato il contenuto di jcr:created.

subPath

Se il risultato non si trova nel nodo restituito dalla query, subPath definisce dove si trova la proprietà.

secondaryProperty

Una seconda proprietà che deve essere utilizzata per calcolare il valore effettivo della cella. Questa definizione viene utilizzata solo per alcuni tipi di colonna (differenze e ordinamento).

Ad esempio, se è presente il rapporto Istanze flusso di lavoro, la proprietà specificata viene utilizzata per memorizzare il valore effettivo della differenza di tempo (in millisecondi) tra l'ora di inizio e l'ora di fine.

secondarySubPath

Simile a subPath, quando si utilizza secondaryProperty.

resolver

Definisce il risolutore da utilizzare. Sono disponibili i seguenti risolutori:

• const

  Associa i valori ad altri valori; ad esempio, viene utilizzato per risolvere costanti come en nel relativo valore equivalente English.

• default

  Il resolver predefinito. Questo è un risolutore fittizio che in realtà non risolve nulla.

• page

  Risolve un valore di percorso nel percorso della pagina appropriata; più precisamente, nel nodo jcr:content corrispondente. Ad esempio, /content/.../page/jcr:content/par/xyz è risolto in /content/.../page/jcr:content.

• path

  Risolve un valore di percorso aggiungendo facoltativamente un percorso secondario e prendendo il valore effettivo da una proprietà del nodo (come definito da resolverConfig) nel percorso risolto. Ad esempio, è possibile risolvere path di /content/.../page/jcr:content nel contenuto della proprietà jcr:title, ciò significherebbe che un percorso di pagina viene risolto nel titolo della pagina.

• pathextension

  Risolve un valore anteponendo un percorso e prendendo il valore effettivo da una proprietà del nodo nel percorso risolto. Ad esempio, un valore de potrebbe essere preceduto da un percorso come /libs/wcm/core/resources/languages, prendendo il valore dalla proprietà language, per risolvere il codice paese de nella descrizione della lingua German.

resolverConfig

Fornisce le definizioni per il resolver. Le opzioni disponibili dipendono da resolver selezionato:

• const

  Utilizzare le proprietà per specificare le costanti per la risoluzione. Il nome della proprietà definisce la costante da risolvere; il valore della proprietà definisce il valore risolto.

  Ad esempio, una proprietà con Name= 1 e Value =One risolve 1 in 1.

• default

  Nessuna configurazione disponibile.

• page

  • propertyName (facoltativo)

    Definisce il nome della proprietà da utilizzare per la risoluzione del valore. Se non viene specificato, viene utilizzato il valore predefinito jcr:title (titolo della pagina). Per il risolutore page, ciò significa che prima il percorso viene risolto nel percorso della pagina, quindi ulteriormente risolto nel titolo della pagina.

• path

  • propertyName (facoltativo)

    Specifica il nome della proprietà da utilizzare per la risoluzione del valore. Se non viene specificato, verrà utilizzato il valore predefinito jcr:title.

  • subPath (facoltativo)

    Questa proprietà può essere utilizzata per specificare un suffisso da aggiungere al percorso prima che il valore venga risolto.

• pathextension

  • path (obbligatorio)

    Definisce il percorso da anteporre.

  • propertyName (obbligatorio)

    Definisce la proprietà nel percorso risolto in cui si trova il valore effettivo.

  • i18n (facoltativo; tipo booleano)

    Determina se il valore risolto deve essere internazionalizzato (ovvero, utilizzando i servizi di internazionalizzazione di CQ5).

preprocessing

La preelaborazione è facoltativa e può essere associata (separatamente) alle fasi di elaborazione apply o applyAfter:

• apply

  Fase di pre-elaborazione iniziale (passaggio 3 nella rappresentazione della coda di elaborazione).

• applyAfter

  Applica dopo la preelaborazione (passaggio 9 nella rappresentazione della coda di elaborazione).

valore originale:

La definizione di pre-elaborazione per il valore originale è specificata direttamente in apply e/o applyAfter.

valore allo stato aggregato:

Se necessario, è possibile fornire una definizione distinta per ciascuna aggregazione.

Per specificare la pre-elaborazione esplicita per i valori aggregati, le definizioni di pre-elaborazione devono trovarsi su un rispettivo nodo figlio aggregated ( apply/aggregated, applyAfter/aggregated). Se è richiesta una preelaborazione esplicita per aggregati distinti, la definizione di preelaborazione si trova su un nodo figlio con il nome del rispettivo aggregato (ad esempio, apply/aggregated/min/max o altri aggregati).

trova e sostituisci pattern
Quando viene trovato, il pattern specificato (definito come espressione regolare) viene sostituito da un altro pattern; ad esempio, questo può essere utilizzato per estrarre una sottostringa dell’originale.

formattatori del tipo di dati

Converte un valore numerico in una stringa relativa; ad esempio, il valore "che rappresenta una differenza temporale di un'ora viene risolto in una stringa come 1:24PM (1 hour ago).

pattern

Espressione regolare utilizzata per individuare una sottostringa.

replace

Stringa, o rappresentazione della stringa, utilizzata come sostituzione della stringa originale. Spesso rappresenta una sottostringa della stringa che si trova nell'espressione regolare pattern.

Per il nodo definitions/data/preprocessing/apply con le due proprietà seguenti:

• pattern: (.*)(/jcr:content)(/|$)(.*)
• replace: $1

Stringa in arrivo come:

• /content/geometrixx/en/services/jcr:content/par/text

Suddiviso in quattro sezioni:

• $1 - (.*) - /content/geometrixx/en/services
• $2 - (/jcr:content) - /jcr:content
• $3 - (/|$) - /
• $4 - (.*) - par/text

E sostituito con la stringa rappresentata da $1:

• /content/geometrixx/en/services

format

Formattatore tipo di dati:

• duration

  La durata è l’intervallo di tempo tra due date definite. Ad esempio, l’inizio e la fine di un’azione del flusso di lavoro che ha richiesto un’ora, a partire dalle 11:23h del 2/13/11 e con termine un’ora dopo alle 12:23h del 2/13/11.

  Converte un valore numerico (interpretato come millisecondi) in una stringa di durata; ad esempio, 30000 è formattato come * 30s.*

• datedelta

  L’intervallo di tempo tra una data passata e "ora" è quindi diverso (se il rapporto viene visualizzato in un momento successivo).

  Converte il valore numerico (interpretato come differenza temporale in giorni) in una stringa di data relativa. Ad esempio, 1 è stato formattato come un giorno fa.

type

Di seguito sono riportate le opzioni standard disponibili:

• string

• number

• int

• date

• diff

• timeslot

  Utilizzato per estrarre parti di una data necessarie per l’aggregazione (ad esempio, raggruppare per anno per ottenere i dati aggregati per ogni anno).

• sortable

  Utilizzato per valori che utilizzano valori diversi (come estratti da proprietà diverse) per l’ordinamento e la visualizzazione.

Inoltre, qualsiasi valore di cui sopra può essere definito come multivalore; ad esempio, string[] definisce un array di stringhe.

L'estrattore di valore viene scelto dal tipo di colonna. Se per un tipo di colonna è disponibile un estrattore di valore, viene utilizzato tale estrattore. In caso contrario, viene utilizzato il valore di default dell'estrattore.

Un tipo può (facoltativamente) accettare un parametro. Ad esempio, timeslot:year estrae l'anno da un campo data. Tipi con i relativi parametri:

• timeslot - I valori sono paragonabili alle costanti corrispondenti di 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

Definisce se il report può essere raggruppato per questa colonna.

filters

Definizioni dei filtri.

• filterType

  I filtri disponibili sono:

  • string

    Un filtro basato su stringhe.

• id

  Identificatore del filtro.

• phase

  Fasi disponibili:

  • raw

    Il filtro viene applicato ai dati non elaborati.

  • preprocessed

    Il filtro viene applicato ai dati preelaborati.

  • resolved

    Il filtro viene applicato ai dati risolti.

aggregates

Definizioni aggregate.

• text

  Nome testuale dell’aggregato. Se text non è specificato, verrà utilizzata la descrizione predefinita dell'aggregato. Ad esempio, minimum viene utilizzato per l'aggregato min.

• type

  Tipo aggregato. Gli aggregati disponibili sono:

  • count

    Conta il numero di righe.

  • count-nonempty

    Conta il numero di righe non vuote.

  • min

    Fornisce il valore minimo.

  • max

    Fornisce il valore massimo.

  • average

    Fornisce il valore medio.

  • sum

    Fornisce la somma di tutti i valori.

  • median

    Fornisce il valore mediano.

  • percentile95

    Utilizza il 95° percentile di tutti i valori.

aggregate

I valori aggregate validi sono gli stessi di type in aggregates (vedi Definizioni specifiche delle colonne (definizioni - filtri / aggregati) ).

Impostare la proprietà type del nodo definition della colonna su generic.

Vedi /libs/cq/reporting/components/userreport/genericcol/definitions

Specifica una definizione di finestra di dialogo (standard) sotto il nodo definition della colonna.

Vedi /libs/cq/reporting/components/userreport/genericcol/definitions/dialog

• I campi della finestra di dialogo devono fare riferimento agli stessi nomi della proprietà del componente corrispondente, incluso il relativo percorso.

  Ad esempio, se desideri che il tipo della colonna generica possa essere configurato tramite la finestra di dialogo, utilizza un campo con il nome ./definitions/type.

• Le proprietà definite tramite l'interfaccia utente/la finestra di dialogo hanno la precedenza su quelle definite nel componente columnbase.

Definisci la configurazione di modifica.

Vedi /libs/cq/reporting/components/userreport/genericcol/cq:editConfig

Utilizza metodologie AEM standard per definire proprietà di colonna (aggiuntive).

Per le proprietà definite sia sulle istanze del componente che su quelle della colonna, il valore sull’istanza della colonna ha la precedenza.

Le proprietà disponibili per una colonna generica sono:

• jcr:title - nome colonna
• definitions/aggregates - aggregati
• definitions/filters - filtri
• definitions/type- il tipo di colonna (deve essere definito nella finestra di dialogo, utilizzando un selettore/casella combinata o un campo nascosto)
• definitions/data/resolver e definitions/data/resolverConfig (ma non definitions/data/preprocessing o .../clientFilter) - il resolver e la configurazione
• definitions/queryBuilder - configurazione del generatore di query
• defaults/aggregate - aggregato predefinito

Se esiste una nuova istanza della colonna generica nel report utente, le proprietà definite nella finestra di dialogo vengono mantenute in:

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

/etc/designs/reports/<yourReport> è adatto se il report si trova in /apps/cq/reporting

/etc/designs/<yourProject>/reports/<*yourReport*> per i report che utilizzano il pattern /apps/<yourProject>/reports

components

Qualsiasi componente e/o gruppo di componenti consentito nel rapporto.

sling:resourceType

Proprietà con valore cq/reporting/components/repparsys.

imposta sling:resourceType su cq/reporting/components/reportpage

indicare il progetto da utilizzare

crea un nodo figlio report che fa riferimento al componente contenitore ( reportbase) con la proprietà sling:resourceType

Il fuso orario definisce il fuso orario per il quale vengono creati i dati storici. In questo modo, il grafico cronologico mostrerà gli stessi dati per ogni utente in tutto il mondo.

Impostazioni locali definisce le impostazioni locali da utilizzare con Fuso orario per i dati storici. Le impostazioni internazionali vengono utilizzate per determinare alcune impostazioni di calendario specifiche delle impostazioni internazionali, ad esempio se il primo giorno della settimana è domenica o lunedì.

Percorso snapshot definisce il percorso principale in cui vengono archiviati gli snapshot per i grafici cronologici.

Percorso dei report definisce il percorso in cui si trovano i report. Viene utilizzato dal servizio snapshot per determinare i report per i quali eseguire effettivamente le snapshot.

Snapshot giornalieri definisce l'ora di ogni giorno in cui vengono eseguiti gli snapshot giornalieri. L'ora specificata si trova nel fuso orario locale del server.

Snapshot orari definisce il minuto di ogni ora in cui vengono eseguiti gli snapshot orari.

Righe (max) definisce il numero massimo di righe archiviate per ogni snapshot. Questo valore dovrebbe essere scelto in modo ragionevole. Se è troppo alta, influisce sulle dimensioni dell’archivio; se è troppo bassa, i dati potrebbero non essere accurati a causa del modo in cui vengono gestiti i dati storici.

Dati falsi, se abilitata, è possibile creare dati storici falsi utilizzando il selettore fakedata. Se disabilitata, l'utilizzo del selettore fakedata genera un'eccezione.

Poiché i dati sono falsi, è necessario utilizzarli solo a scopo di test e debug.

L'utilizzo del selettore fakedata termina il report in modo implicito, quindi tutti i dati esistenti vengono persi. I dati possono essere ripristinati manualmente, ma questo processo può richiedere tempo.

Utente snapshot definisce un utente facoltativo che può essere utilizzato per creare snapshot.

In pratica, vengono create istantanee per l'utente che ha terminato il report. In alcuni casi (ad esempio, in un sistema di pubblicazione in cui l’utente non esiste in quanto l’account non è stato replicato) puoi specificare un utente di fallback da utilizzare in alternativa.

Inoltre, la specifica di un utente potrebbe comportare un rischio per la sicurezza.

Applica utente snapshot, se attivato, tutti gli snapshot vengono creati con l'utente specificato in Utente snapshot. Questo potrebbe avere un grave impatto sulla sicurezza se non viene gestito correttamente.