Rapporten ontwikkelen

AEM biedt een selectie van standaardrapporten waarvan de meeste zijn gebaseerd op een rapportagekader.

Met behulp van het framework kunt u deze standaardrapporten uitbreiden of uw eigen, volledig nieuwe rapporten ontwikkelen. Het rapportagekader sluit nauw aan bij de bestaande CQ5-concepten en -beginselen, zodat ontwikkelaars hun bestaande kennis van CQ5 kunnen gebruiken als springplank voor het opstellen van rapporten.

Voor de standaardrapporten die bij AEM worden geleverd:

OPMERKING

De zelfstudie Uw eigen rapport maken - Een voorbeeld laat ook zien hoeveel van de onderstaande principes kunnen worden gebruikt.

U kunt ook naar de standaardrapporten verwijzen om andere voorbeelden van implementatie te zien.

OPMERKING

In de volgende voorbeelden en definities wordt de volgende notatie gebruikt:

  • Elke regel definieert een knooppunt of een eigenschap waarbij:

    • N:<name> [<nodeType>]

      Beschrijft een knoop met de naam van <*name*> en knooptype van <*nodeType*>.

    • P:<name> [<propertyType]

      Beschrijft een bezit met de naam van <*name*> en een bezitstype van <*propertyType*>.

    • P:<name> = <value>

      Beschrijft een eigenschap <name> die moet worden ingesteld op de waarde van <value>.

  • De inspringing toont de hiërarchische gebiedsdelen tussen de knopen.

  • Items gescheiden door | een lijst van mogelijke artikelen; bijvoorbeeld typen of namen:

    bijv. String|String[] betekent dat het bezit of Koord of Koord[] kan zijn.

  • [] een array weergeeft; zoals [] Stringor een array van knooppunten zoals in de Query Definition.

Tenzij anders vermeld zijn de standaardtypes:

  • Knooppunten - nt:unstructured
  • Eigenschappen - String

Rapportagekader

Het rapportagekader werkt aan de volgende beginselen:

  • Het is volledig gebaseerd op resultaatreeksen die door een vraag zijn teruggekeerd die door CQ5 wordt uitgevoerd QueryBuilder.

  • De resultaatreeks bepaalt de gegevens die in het rapport worden getoond. Elke rij in de resultaatreeks beantwoordt aan een rij in de tabelmening van het rapport.

  • De verrichtingen beschikbaar voor uitvoering op de resultaatreeks lijken op concepten RDBMS; primair groepering en aggregatie.

  • De meeste gegevensherwinning en verwerking worden gedaan serverzijde.

  • De klant is alleen verantwoordelijk voor de weergave van de vooraf verwerkte gegevens. Alleen kleine verwerkingstaken (bijvoorbeeld het maken van koppelingen in celinhoud) worden aan de clientzijde uitgevoerd.

Het rapportagekader (geïllustreerd door de structuur van een standaardrapport) gebruikt de volgende bouwstenen, die door de verwerkingswachtrij worden gevoed:

chlimage_1-248

Pagina rapporteren

De rapportpagina:

Basis rapporteren

De reportbase component vormt de basis van om het even welk rapport aangezien het:

  • Houdt de definitie van query die de onderliggende resultaatreeks gegevens levert.

  • Is een aangepast alineasysteem dat alle kolommen ( columnbase) zal bevatten die aan het rapport worden toegevoegd.

  • Bepaalt welke grafiektypes beschikbaar zijn en die momenteel actief zijn.

  • Bepaalt de Edit dialoog, die de gebruiker toestaat om bepaalde aspecten van het rapport te vormen.

Kolombasis

Elke kolom is een geval van columnbase component die:

  • Is een paragraaf, die door parsys ( reportbase) van het respectieve rapport wordt gebruikt.
  • Bepaalt de verbinding aan onderliggend resultaatreeks; Hiermee worden de specifieke gegevens gedefinieerd waarnaar in deze resultaatset wordt verwezen, en hoe deze worden verwerkt.
  • bevat aanvullende definities; zoals de beschikbare aggregaten en filters, samen met standaardwaarden.

De vraag en het Terugwinnen van Gegevens

De query:

  • Is gedefinieerd als onderdeel van de reportbase component.

  • Is gebaseerd op CQ QueryBuilder.

  • Haalt de gegevens op die als basis voor het rapport worden gebruikt. Elke rij van de resultaatreeks (lijst) is gebonden aan een knoop zoals teruggekeerd door de vraag. Specifieke informatie voor individuele kolommen wordt dan gehaald uit deze gegevensreeks.

  • Bestaat gewoonlijk uit:

    • Een hoofdpad.

      Hiermee wordt de substructuur van de gegevensopslagruimte aangegeven die moet worden doorzocht.

      Om de invloed op de prestaties tot een minimum te beperken, is het raadzaam om de query te (proberen) beperken tot een specifieke subboomstructuur van de repository. Het wortelweg kan of vooraf bepaald in rapportmalplaatje of geplaatst door de gebruiker in de dialoog van de Configuratie (geeft uit).

    • Een of meer criteria.

      Deze worden opgelegd om de (oorspronkelijke) resultaatreeks te produceren; ze omvatten bijvoorbeeld beperkingen op het knooppunttype of eigenschapbeperkingen.

Het belangrijkste punt hier is dat elke enige knoop die in de resultaatreeks van de vraag wordt teruggekeerd wordt gebruikt om één enkele rij op het rapport (zo een 1:1 verhouding) te produceren.

De ontwikkelaar moet ervoor zorgen dat de vraag die voor een rapport wordt bepaald een knoop terugkeert die aangewezen voor dat rapport wordt geplaatst. Nochtans, te hoeven de knoop zelf niet alle vereiste informatie te houden, kan dit ook uit ouder en/of kindknopen worden afgeleid. Bijvoorbeeld, selecteert de vraag die voor Rapport van de Gebruiker knopen wordt gebruikt die op het knooptype (in dit geval rep:user) worden gebaseerd. Nochtans, nemen de meeste kolommen op dit rapport hun gegevens niet direct van deze knopen, maar van de kindknopen profile.

Wachtrij verwerken

query keert een resultaatreeks gegevens terug die als rijen op het rapport moeten worden getoond. Elke rij in de resultaatreeks wordt verwerkt (server-kant), in verscheidene fasen, alvorens wordt overgebracht naar de cliënt voor vertoning op het rapport.

Hierdoor is het mogelijk:

  • Waarden extraheren en afleiden van de onderliggende resultatenset.

    U kunt bijvoorbeeld twee eigenschapswaarden als één waarde verwerken door het verschil tussen de twee waarden te berekenen.

  • Oplossen van geëxtraheerde waarden; dit kan op verschillende manieren gebeuren .

    Paden kunnen bijvoorbeeld worden toegewezen aan een titel (zoals in de meer leesbare inhoud van de desbetreffende jcr:title-eigenschap).

  • Filters toepassen op verschillende punten.

  • Indien nodig samengestelde waarden maken.

    Bijvoorbeeld bestaande uit een tekst die aan de gebruiker wordt getoond, een waarde die voor het sorteren en een extra URL moet worden gebruikt die (op de cliëntkant) voor het creëren van een verbinding wordt gebruikt.

Workflow van de verwerkingswachtrij

De volgende workflow vertegenwoordigt de verwerkingswachtrij:

chlimage_1-249

Fases van de Verwerkingswachtrij

Waar de gedetailleerde stappen en elementen zijn:

  1. Transformeert de resultaten die door aanvankelijke vraag (reportbase) zijn teruggekeerd in de basisresultaatreeks gebruikend waardeextractors.

    De extractoren van de waarde worden automatisch gekozen afhankelijk van kolomtype. Deze worden gebruikt voor het lezen van waarden van de onderliggende JCR-query en het maken van een resultaatset op basis daarvan. waarna verdere verwerking kan worden toegepast. Voor het type diff leest de waardeextractor bijvoorbeeld twee eigenschappen en berekent deze de enkele waarde die vervolgens aan de resultatenset wordt toegevoegd. De waarde-extractors kunnen niet worden geconfigureerd.

  2. Op die aanvankelijke resultaatreeks, die ruwe gegevens bevat, wordt aanvankelijke filtratie (raw fase) toegepast.

  3. Waarden zijn preprocessing; zoals gedefinieerd voor de apply fase.

  4. Filteren (toegewezen aan de ** vooraf verwerkte fase) wordt uitgevoerd op de vooraf verwerkte waarden.

  5. Waarden worden opgelost; volgens de gedefinieerde oplosser.

  6. Filteren (toegewezen aan de ** opgeloste fase) wordt uitgevoerd op de opgeloste waarden.

  7. Gegevens zijn gegroepeerd en geaggregeerd.

  8. Arraygegevens worden omgezet in een (op tekenreeks gebaseerde) lijst.

    Dit is een impliciete stap die een multi-waarderesultaat in een lijst omzet die kan worden getoond; deze is vereist voor (niet-geaggregeerde) celwaarden die zijn gebaseerd op JCR-eigenschappen met meerdere waarden.

  9. Waarden worden opnieuw preprocessing; zoals gedefinieerd voor de afterApply fase.

  10. Gegevens worden gesorteerd.

  11. De verwerkte gegevens worden naar de client overgedragen.

OPMERKING

De eerste query die de resultaatset van de basisgegevens retourneert, wordt gedefinieerd voor de component reportbase.

Andere elementen van de verwerkingsrij worden bepaald op columnbase componenten.

Constructie en configuratie van rapport

Het volgende is nodig om een rapport te construeren en te vormen:

Locatie van rapportcomponenten

De standaardrapporteringscomponenten worden gehouden onder /libs/cq/reporting/components.

Het wordt echter ten zeerste aanbevolen deze knooppunten niet bij te werken, maar uw eigen componentknooppunten te maken onder /apps/cq/reporting/components of, indien van toepassing, /apps/<yourProject>/reports/components.

Waar (als voorbeeld):

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

Onder dit creeert u de wortel voor uw rapport en onder dit, de component van de rapportbasis en de componenten van de kolombasis:

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

Paginacomponent

Een rapportpagina moet sling:resourceType van /libs/cq/reporting/components/reportpage gebruiken.

Een aangepaste pagina-component is in de meeste gevallen niet nodig.

Basiscomponent rapporteren

Elk rapporttype vereist een containercomponent die van /libs/cq/reporting/components/reportbase wordt afgeleid.

Deze component fungeert als container voor het rapport als geheel en biedt informatie voor:

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

Query-definitie

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

    Kan worden gebruikt om het resultaat te beperken dat is ingesteld op knooppunten met specifieke eigenschappen met specifieke waarden. Als de veelvoudige beperkingen worden gespecificeerd, moet de knoop aan elk van hen (EN verrichting) voldoen.

    Bijvoorbeeld:

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

    Alle textimage componenten die het laatst door de admin gebruiker zijn gewijzigd, retourneren.

  • nodeTypes

    Wordt gebruikt om het resultaat te beperken tot de opgegeven knooppunttypen. U kunt meerdere knooppunttypen opgeven.

  • mandatoryProperties

    Kan worden gebruikt om het resultaat te beperken dat aan knopen wordt geplaatst die all van de gespecificeerde eigenschappen hebben. Er wordt geen rekening gehouden met de waarde van de eigenschappen.

Alles is optioneel en kan zo nodig worden gecombineerd, maar u moet ten minste één element definiëren.

Grafiekdefinities

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

    Bevat definities voor de actieve grafieken.

    • active

      Aangezien er meerdere instellingen kunnen worden gedefinieerd, kunt u dit gebruiken om te definiëren welke momenteel actief zijn. Deze worden bepaald door een serie van knopen (er is geen verplichte noemende overeenkomst voor deze knopen, maar de standaardrapporten gebruiken vaak 0, 1x), elk met de volgende eigenschap:

      • id

        Identificatie voor de actieve diagrammen. Dit moet identiteitskaart van één van de grafiek definitions aanpassen.

  • definitions

    Bepaalt de grafiektypes die potentieel voor het rapport beschikbaar zijn. De definitions die moet worden gebruikt, worden opgegeven met de active-instellingen.

    De definities worden gespecificeerd gebruikend een serie van knopen (opnieuw genoemd 0, 1. x), elk met de volgende eigenschappen:

    • id

      De kaart-identificatie.

    • type

      Het type grafiek dat beschikbaar is. Selecteer vanuit:

      • pie
        Cirkeldiagram. Alleen gegenereerd op basis van huidige gegevens.

      • lineseries
        Reeks lijnen (verbindende punten die de daadwerkelijke momentopnamen vertegenwoordigen). Alleen gegenereerd op basis van historische gegevens.

    • Er zijn aanvullende eigenschappen beschikbaar, afhankelijk van het diagramtype:

      • voor het diagramtype pie:

        • maxRadius ( Double/Long)

          De maximale straal die voor het cirkeldiagram is toegestaan; daarom de maximumgrootte die voor de grafiek (zonder legenda) wordt toegestaan. Wordt genegeerd als fixedRadius is gedefinieerd.

        • minRadius ( Double/Long)

          De minimale straal die is toegestaan voor het cirkeldiagram. Wordt genegeerd als fixedRadius is gedefinieerd.

        • fixedRadius ( Double/Long) Hiermee definieert u een vaste straal voor het cirkeldiagram.

      • voor het diagramtype lineseries:

        • totals ( Boolean)

          Waar als een extra lijn die Totaal toont zou moeten worden getoond.
          standaardwaarde: false

        • series ( Long)

          Aantal weer te geven lijnen/reeksen.
          standaard: 9 (dit is ook het toegestane maximum)

        • hoverLimit ( Long)

          Maximum aantal samengevoegde momentopnamen (punten die op elke horizontale lijn worden getoond, die verschillende waarden vertegenwoordigen) waarvoor popups moeten worden getoond, d.w.z. wanneer de gebruiker muis-over op een specifieke waarde of een overeenkomstig etiket in de grafieklegende doet.

          standaard: 35 (d.w.z. er worden helemaal geen popups weergegeven als meer dan 35 verschillende waarden van toepassing zijn voor de huidige diagraminstellingen).

          Er geldt een extra limiet van 10 pop-ups die parallel kunnen worden weergegeven (meerdere pop-ups kunnen worden weergegeven wanneer de muisaanwijzer op de legenda wordt geplaatst).

Configuratiedialoogvenster

Elk rapport kan een configuratiedialoog hebben, toestaand de gebruiker om diverse parameters voor het rapport te specificeren. Dit dialoogvenster is toegankelijk via de knop Bewerken wanneer de rapportpagina is geopend.

Dit dialoogvenster is een standaard-CQ dialoogvenster en kan als zodanig worden geconfigureerd (zie CQ.Dialog voor meer informatie).

Een voorbeelddialoogvenster kan er als volgt uitzien:

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

Verschillende vooraf geconfigureerde componenten worden geleverd; U kunt hier in het dialoogvenster naar verwijzen met de eigenschap xtype met de waarde cqinclude:

  • title

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

    TextField om de rapporttitel te bepalen.

  • description

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

    Textarea om de rapportbeschrijving te bepalen.

  • processing

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

    Selector voor de verwerkingsmodus van het rapport (gegevens handmatig/automatisch laden).

  • scheduling

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

    Kiezer voor het plannen van momentopnamen voor de historische grafiek.

OPMERKING

De componenten waarnaar wordt verwezen, moeten worden opgenomen met het achtervoegsel .infinity.json (zie voorbeeld hierboven).

Hoofdpad

Bovendien kan een wortelweg voor het rapport worden bepaald:

  • rootPath

    Dit beperkt het rapport tot een bepaalde sectie (boom of subboom) van de bewaarplaats, die voor prestatiesoptimalisering wordt geadviseerd. Het wortelweg wordt gespecificeerd door het rootPath bezit van de report knoop van elke rapportpagina (die van het malplaatje op paginaareding wordt genomen).

    Deze kan worden gespecificeerd door:

    • het rapportmalplaatje (of als vaste waarde of als standaardwaarde voor de configuratiedialoog).
    • de gebruiker (met deze parameter)

Basiscomponent kolom

Elk kolomtype vereist een component die van /libs/cq/reporting/components/columnbase wordt afgeleid.

Een kolomcomponent definieert een combinatie van het volgende:

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

Zie ook Het bepalen van Uw Nieuw Rapport.

Kolomspecifieke query

Dit bepaalt de specifieke gegevensextractie (uit rapportgegevensresultaatreeks) voor gebruik in de individuele kolom.

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

    Definieert de eigenschap die moet worden gebruikt voor het berekenen van de werkelijke celwaarde.

    Als het bezit als Koord[] veelvoudige eigenschappen wordt bepaald (in opeenvolging) wordt gescand om de daadwerkelijke waarde te vinden.

    Bijvoorbeeld in het geval van:

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

    De overeenkomstige waarde-extractor (die hier in controle is) zal:

    • Controleer of er een eigenschap jcr:lastModified beschikbaar is en gebruik deze als dat zo is.
    • Als er geen eigenschap jcr:lastModified beschikbaar is, wordt in plaats daarvan de inhoud van jcr:created gebruikt.
  • subPath

    Als het resultaat niet op de knoop wordt gevestigd die door de vraag is teruggekeerd, subPath bepaalt waar het bezit eigenlijk wordt gevestigd.

  • secondaryProperty

    Definieert een tweede eigenschap die ook moet worden gebruikt voor het berekenen van de werkelijke celwaarde; dit wordt alleen gebruikt voor bepaalde kolomtypen ( diff en sortable ) .

    Bijvoorbeeld, in het geval van het Rapport van de Instanties van het Werkschema, wordt het gespecificeerde bezit gebruikt om de daadwerkelijke waarde van het tijdverschil (in milliseconden) tussen begin en eindtijden op te slaan.

  • secondarySubPath

    Gelijkaardig aan subPath, wanneer secondaryProperty wordt gebruikt.

In de meeste gevallen wordt alleen property gebruikt.

Clientfilter

Het clientfilter extraheert de informatie die moet worden weergegeven, uit de gegevens die door de server worden geretourneerd.

OPMERKING

Dit filter wordt aan clientzijde uitgevoerd nadat de verwerking op de volledige server is toegepast.

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

clientFilter wordt gedefinieerd als een JavaScript-functie die:

  • als input één parameter ontvangt; de gegevens die door de server worden geretourneerd (dus volledig vooraf verwerkt)
  • als output, retourneert de gefilterde (verwerkte) waarde; de gegevens die uit de inputinformatie zijn gehaald of afgeleid

In het volgende voorbeeld wordt het overeenkomende paginapad uit een deelpad geëxtraheerd:

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

Resolvers en voorbewerking

De verwerkingsrij bepaalt de diverse oplosmiddelen en vormt preprocessing:

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

    Definieert de oplosser die moet worden gebruikt. De volgende oplosmiddelen zijn beschikbaar:

    • const

      Wijst waarden toe aan andere waarden; Dit wordt bijvoorbeeld gebruikt om constanten zoals en op te lossen tot de equivalente waarde English.

    • default

      De standaardoplosser. Dit is een nepoplosser die eigenlijk niets oplost.

    • page

      Hiermee wordt een padwaarde omgezet in het pad van de desbetreffende pagina. nauwkeuriger, aan de overeenkomstige jcr:content knoop. /content/.../page/jcr:content/par/xyz wordt bijvoorbeeld omgezet in /content/.../page/jcr:content.

    • path

      Hiermee lost u een padwaarde op door optioneel een subpad toe te voegen en de werkelijke waarde van een eigenschap van het knooppunt (zoals gedefinieerd door resolverConfig) op te nemen bij het omgezette pad. Een path van /content/.../page/jcr:content kan bijvoorbeeld worden omgezet naar de inhoud van de eigenschap jcr:title, wat betekent dat een paginapad wordt omgezet naar de paginatitel.

    • pathextension

      Hiermee lost u een waarde op door een pad vooraf in te stellen en de werkelijke waarde te nemen vanuit een eigenschap van het knooppunt op het opgeloste pad. Een waarde de kan bijvoorbeeld worden voorafgegaan door een pad zoals /libs/wcm/core/resources/languages, waarbij de waarde wordt overgenomen van de eigenschap language, om de landcode de om te zetten in de taalbeschrijving German.

  • resolverConfig

    Verstrekt definities voor resolver; de beschikbare opties zijn afhankelijk van de geselecteerde resolver:

    • const

      Gebruik eigenschappen om de constanten voor het omzetten op te geven. De naam van de eigenschap definieert de constante die moet worden opgelost. De waarde van de eigenschap definieert de omgezette waarde.

      Een eigenschap met Naam= 1 en Waarde =One zal bijvoorbeeld 1 tot 1 oplossen.

    • default

      Geen configuratie beschikbaar.

    • page

      • propertyName (optioneel)

        Definieert de naam van de eigenschap die moet worden gebruikt voor het omzetten van de waarde. Indien niet opgegeven, wordt de standaardwaarde van jcr:title (de paginatitel) gebruikt; voor de oplosser page betekent dit dat eerst het pad wordt omgezet naar het paginapad en vervolgens verder wordt omgezet naar de paginatitel.

    • path

      • propertyName (optioneel)

        Specifies the name of the property that should be used for resolving the value. Indien niet opgegeven, wordt de standaardwaarde van jcr:title gebruikt.

      • subPath (optioneel)

        Deze eigenschap kan worden gebruikt om een achtervoegsel op te geven dat aan het pad moet worden toegevoegd voordat de waarde wordt omgezet.

    • pathextension

      • path (mandatory)

        Definieert het pad dat moet worden voorafgegaan.

      • propertyName (verplicht)

        Definieert de eigenschap op het omgezette pad waar de werkelijke waarde zich bevindt.

      • i18n (facultatief; type Boolean)

        Hiermee wordt bepaald of de opgeloste waarde internationalized moet zijn (d.w.z. met behulp van CQ5's internationalization services).

  • preprocessing

    Voorbewerking is optioneel en kan (afzonderlijk) worden gebonden aan de verwerkingsfasen apply of applyAfter:

Resolvers

De oplosmiddelen worden gebruikt om de vereiste informatie te halen. Voorbeelden van de verschillende oplosmiddelen zijn:

Const

Hieronder wordt een contant waarde van VersionCreated omgezet in de tekenreeks New version created.

Zie /libs/cq/reporting/components/auditreport/typecol/definitions/data.

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

Pagina

Hiermee wordt een padwaarde omgezet in de eigenschap jcr:description op het knooppunt jcr:content (child) van de bijbehorende pagina.

Zie /libs/cq/reporting/components/compreport/pagecol/definitions/data.

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

Pad

Met het volgende wordt een pad van /content/.../page naar de inhoud van de eigenschap jcr:title omgezet. Dit betekent dat een paginapad wordt omgezet naar de paginatitel.

Zie /libs/cq/reporting/components/auditreport/pagecol/definitions/data.

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

Padextensie

Het volgende voegt een waarde de met de weguitbreiding /libs/wcm/core/resources/languages voor, dan neemt de waarde van het bezit language, om landcode de aan de taalbeschrijving German op te lossen.

Zie /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"

Voorbewerken

De definitie preprocessing kan op of worden toegepast:

  • oorspronkelijke waarde:

    De voorbewerkingsdefinitie voor de oorspronkelijke waarde wordt op apply en/of applyAfter direct gespecificeerd.

  • waarde in geaggregeerde toestand:

    Indien nodig kan voor elke aggregatie een aparte definitie worden gegeven.

    Om expliciete voorbewerking voor samengevoegde waarden te specificeren, moeten de preverwerkingsdefinities op een respectieve aggregated kindknoop ( apply/aggregated, applyAfter/aggregated) verblijven. Als expliciete voorbewerking voor verschillende aggregaten wordt vereist, wordt de preverwerkingsdefinitie gevestigd op een kindknoop met de naam van het respectieve aggregaat (bijvoorbeeld apply/aggregated/min/max of andere aggregaten).

U kunt een van de volgende twee opties opgeven om tijdens de voorbehandeling te gebruiken:

  • zoeken en vervangen van
    patronenWanneer deze worden gevonden, wordt het opgegeven patroon (dat wordt gedefinieerd als een reguliere expressie) vervangen door een ander patroon. Dit kan bijvoorbeeld worden gebruikt om een subtekenreeks van het origineel te extraheren.

  • gegevenstypeopmaakprogramma's

    Zet een numerieke waarde om in een relatieve tekenreeks; de waarde "die een tijdsverschil van 1 uur vertegenwoordigt, wordt bijvoorbeeld omgezet in een tekenreeks zoals 1:24PM (1 hour ago).

Bijvoorbeeld:

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

Voorbewerken - Patronen zoeken en vervangen

Voor preprocessing kunt u een pattern (gedefinieerd als een reguliere expressie of regex) opgeven die zich bevindt en vervolgens wordt vervangen door het replace-patroon:

  • pattern

    De reguliere expressie die wordt gebruikt om een subtekenreeks te zoeken.

  • replace

    De tekenreeks, of representatie van de tekenreeks, die wordt gebruikt als vervanging voor de oorspronkelijke tekenreeks. Dit vertegenwoordigt vaak een subtekenreeks van de tekenreeks die wordt gevonden door de reguliere expressie pattern.

Een voorbeeldvervanging kan als worden verdeeld:

  • Voor het knooppunt definitions/data/preprocessing/apply met de volgende twee eigenschappen:

    • pattern: (.*)(/jcr:content)(/|$)(.*)
    • replace: $1
  • Een tekenreeks die aankomt als:

    • /content/geometrixx/en/services/jcr:content/par/text
  • Wordt opgedeeld in vier secties:

    • $1 - (.*) - /content/geometrixx/en/services
    • $2 - (/jcr:content) - /jcr:content
    • $3 - (/|$) - /
    • $4 - (.*) - par/text
  • En vervangen door de tekenreeks die wordt vertegenwoordigd door $1:

    • /content/geometrixx/en/services

voorbewerken - Formatters voor gegevenstypen

Deze formatters zetten een numerieke waarde in een relatieve koord om.

Dit kan bijvoorbeeld worden gebruikt voor een tijdkolom waarin min, avg en max aggregaten zijn toegestaan. Als min/ avg/ max aggregaten worden weergegeven als een tijdverschil (bijvoorbeeld 10 days ago), is een gegevensformatter vereist. Hiervoor wordt een datedelta-formatter toegepast op de min/ avg/ max geaggregeerde waarden. Als een count aggregaat ook beschikbaar is dan vereist dit geen formatter, evenmin doet de originele waarde.

Momenteel zijn de beschikbare gegevenstypeformatters:

  • format

    Formatter voor gegevenstypen:

    • duration

      De duur is de tijdspanne tussen twee bepaalde data. Bijvoorbeeld het begin en einde van een werkstroomactie die 1 uur heeft geduurd, vanaf 13/13/11 11:23u en eindigend één uur later om 13/11 12:23u.

      Het zet een numerieke waarde (die als milliseconden wordt geïnterpreteerd) in een duurkoord om; 30000 is bijvoorbeeld opgemaakt als * 30s.*

    • datedelta

      Datadelta is de tijdspanwijdte tussen een datum in het verleden tot "nu"(zodat zal het een verschillend resultaat hebben als het rapport op een later punt in tijd wordt bekeken).

      De numerieke waarde (geïnterpreteerd als een tijdverschil in dagen) wordt omgezet in een relatieve datumtekenreeks. 1 is bijvoorbeeld opgemaakt als 1 dag geleden.

In het volgende voorbeeld wordt datedelta-opmaak gedefinieerd voor min- en max-aggregaten:

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

Kolomspecifieke definities

De kolomspecifieke definities definiëren de filters en aggregaten die beschikbaar zijn voor die kolom.

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

    De volgende opties zijn beschikbaar als standaardopties:

    • string

    • number

    • int

    • date

    • diff

    • timeslot

      Wordt gebruikt voor het extraheren van delen van een datum die nodig is voor aggregatie (bijvoorbeeld groep per jaar om gegevens voor elk jaar te verzamelen).

    • sortable

      Wordt gebruikt voor waarden die verschillende waarden gebruiken (zoals overgenomen uit verschillende eigenschappen) voor het sorteren en weergeven.
      Daarnaast. een van de bovenstaande punten kan worden gedefinieerd als meerwaarden; string[] definieert bijvoorbeeld een array van tekenreeksen.

    De waarde-extractor wordt gekozen door het kolomtype. Als een waarde-extractor beschikbaar is voor een kolomtype, wordt deze extractor gebruikt. Anders wordt de standaardwaarde voor de extractor gebruikt.

    Een type kan (optioneel) een parameter nemen. timeslot:year extraheert bijvoorbeeld het jaar uit een datumveld. Typen met de bijbehorende parameters:

    • timeslot - De waarden zijn vergelijkbaar met de overeenkomstige constanten van 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

    Bepaalt of het rapport door deze kolom kan worden gegroepeerd.

  • filters

    Filterdefinities.

    • filterType

      Beschikbare filters zijn:

      • string

        Een op tekenreeks gebaseerd filter.

    • id

      Filter-id.

    • phase

      Beschikbare fasen:

      • raw

        Filter wordt toegepast op onbewerkte gegevens.

      • preprocessed

        Filter wordt toegepast op vooraf verwerkte gegevens.

      • resolved

        Filter wordt toegepast op omgezette gegevens.

  • aggregates

    Samengevoegde definities.

    • text

      De tekstnaam van het aggregaat. Als text niet wordt gespecificeerd, dan zal het de standaardbeschrijving van het aggregaat nemen; minimum wordt bijvoorbeeld gebruikt voor het min aggregaat.

    • type

      Samengevoegde tekst. Beschikbare aggregaten zijn:

      • count

        Telt het aantal rijen.

      • count-nonempty

        Telt het aantal niet-lege rijen.

      • min

        Geeft de minimumwaarde op.

      • max

        Geeft de maximumwaarde op.

      • average

        Verstrekt de gemiddelde waarde.

      • sum

        Verschaft de som van alle waarden.

      • median

        Geeft de mediaanwaarde.

      • percentile95

        Neemt het 95e percentiel van alle waarden.

Standaardwaarden kolom

Hiermee definieert u standaardwaarden voor de kolom:

N:defaults
    P:aggregate

Gebeurtenissen en handelingen

Edit Configuration definieert de gebeurtenissen die de listeners nodig hebben om te detecteren en de handelingen die moeten worden toegepast nadat deze gebeurtenissen hebben plaatsgevonden. Zie inleiding aan componentenontwikkeling voor achtergrondinformatie.

De volgende waarden moeten worden gedefinieerd om ervoor te zorgen dat alle vereiste acties worden opgenomen in:

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"

Algemene kolommen

Generieke kolommen zijn een extensie waarbij (de meeste van) de kolomdefinities worden opgeslagen op de instantie van het kolomknooppunt (in plaats van op het componentknooppunt).

Zij gebruiken een (standaard) dialoog, dat u aanpast, voor de individuele generische component. In dit dialoogvenster kan de rapportgebruiker de kolomeigenschappen van een algemene kolom op de rapportpagina definiëren (met de menuoptie Kolomeigenschappen…).

Een voorbeeld is de Generic kolom van Rapport van de Gebruiker; zie /libs/cq/reporting/components/userreport/genericcol.

Een kolom algemeen maken:

  • Stel de eigenschap type van het knooppunt definition van de kolom in op generic.

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

  • Geef een definitie van het dialoogvenster (standaard) op onder het knooppunt definition van de kolom.

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

    • De velden van het dialoogvenster moeten naar dezelfde namen verwijzen als de bijbehorende componenteigenschap (inclusief het pad).

      Als u bijvoorbeeld het type algemene kolom configureerbaar wilt maken via het dialoogvenster, gebruikt u een veld met de naam ./definitions/type.

    • Eigenschappen die zijn gedefinieerd met de interface/het dialoogvenster hebben voorrang op eigenschappen die zijn gedefinieerd met de component columnbase.

  • Bepaal de Edit Configuratie.

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

  • Gebruik standaard AEM methoden om (aanvullende) kolomeigenschappen te definiëren.

    Merk op dat voor eigenschappen die op zowel de component als de kolominstanties worden bepaald, de waarde op de kolominstantie belangrijkheid neemt.

    De eigenschappen die beschikbaar zijn voor een algemene kolom zijn:

    • jcr:title - kolomnaam
    • definitions/aggregates - aggregaten
    • definitions/filters - filters
    • definitions/type- het type kolom (dit moet in het dialoogvenster worden gedefinieerd met een kiezer/keuzelijst of een verborgen veld)
    • definitions/data/resolver en definitions/data/resolverConfig (maar niet definitions/data/preprocessing of .../clientFilter) - de oplosser en configuratie
    • definitions/queryBuilder - de configuratie van de vraagbouwer
    • defaults/aggregate - het standaardaggregaat

    In het geval van een nieuw geval van de generische kolom op Rapport van de Gebruiker worden de eigenschappen die met de dialoog worden bepaald voortgeduurd onder:

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

Rapportontwerp

Het ontwerp bepaalt welke kolomtypes voor het creëren van een rapport beschikbaar zijn. Het definieert ook het alineasysteem waaraan de kolommen worden toegevoegd.

U wordt sterk geadviseerd om een individueel ontwerp voor elk rapport tot stand te brengen. Dit zorgt voor volledige flexibiliteit. Zie ook Het bepalen van Uw Nieuw Rapport.

De standaardrapporteringscomponenten worden gehouden onder /etc/designs/reports.

De locatie voor uw rapporten kan afhankelijk zijn van de locatie van uw componenten:

  • /etc/designs/reports/<yourReport> geschikt is als het rapport zich onderaan bevindt /apps/cq/reporting

  • /etc/designs/<yourProject>/reports/<*yourReport*> voor rapporten die het /apps/<yourProject>/reports patroon gebruiken

De vereiste ontwerpeigenschappen worden geregistreerd op jcr:content/reportpage/report/columns (bijvoorbeeld /etc/designs/reports/<reportName>/jcr:content/reportpage/report/columns):

  • components

    Om het even welke componenten en/of componentengroepen die op het rapport worden toegestaan.

  • sling:resourceType

    Eigenschap met waarde cq/reporting/components/repparsys.

Een voorbeeldontwerpfragment (dat is ontleend aan het ontwerp van het componentenrapport) is:

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

U hoeft geen ontwerpen op te geven voor afzonderlijke kolommen. Beschikbare kolommen kunnen worden gedefinieerd in de ontwerpmodus.

OPMERKING

U wordt aangeraden geen wijzigingen aan te brengen in de standaardrapportontwerpen. Dit om ervoor te zorgen dat u geen veranderingen verliest wanneer het bevorderen van of het installeren van hotfixes.

Kopieer het rapport en het ontwerp als u een standaardrapport wilt aanpassen.

OPMERKING

De standaardkolommen kunnen automatisch worden gecreeerd wanneer een rapport wordt gecreeerd. Deze worden in de sjabloon opgegeven.

Rapportsjabloon

Elk rapporttype moet een malplaatje verstrekken. Dit zijn standaard CQ-sjablonen en kunnen als zodanig worden geconfigureerd.

De sjabloon moet:

  • sling:resourceType instellen op cq/reporting/components/reportpage

  • het te gebruiken ontwerp

  • een report onderliggende node maken die via de eigenschap sling:resourceType naar de container-component ( reportbase) verwijst

Een fragment van het voorbeeldmalplaatje (dat van het malplaatje van het componentenrapport wordt genomen) is:

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

Een fragment van het voorbeeldmalplaatje, dat de definitie van de wortelweg (die van het malplaatje van het gebruikersrapport wordt genomen) toont, is:

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

De standaardrapportagesjablonen worden aangehouden onder /libs/cq/reporting/templates.

Het wordt echter ten zeerste aanbevolen deze knooppunten niet bij te werken, maar uw eigen componentknooppunten te maken onder /apps/cq/reporting/templates of, indien van toepassing, /apps/<yourProject>/reports/templates.

Waar, als voorbeeld (zie ook Plaats van de Componenten van het Rapport):

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

Onder dit maakt u de basis voor uw sjabloon:

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

Uw eigen rapport maken - Een voorbeeld

Het bepalen van Uw Nieuw Rapport

Om een nieuw rapport te bepalen moet u creëren en vormen:

  1. De wortel voor uw rapportcomponenten.
  2. De rapportbasiscomponent.
  3. Een of meer basiscomponenten van kolommen.
  4. Het rapportontwerp.
  5. De wortel voor uw rapportmalplaatje.
  6. Het rapportmalplaatje.

Om deze stappen te illustreren, bepaalt het volgende voorbeeld een rapport dat van alle configuraties OSGi binnen de bewaarplaats een lijst maakt; d.w.z. alle instanties van de sling:OsgiConfig-node.

OPMERKING

Het kopiëren van een bestaand rapport, dan het aanpassen van de nieuwe versie, is een alternatieve methode.

  1. Creeer de wortelknoop voor uw nieuw rapport.

    Bijvoorbeeld onder /apps/cq/reporting/components/osgireport.

    N:cq [nt:folder]
        N:reporting [sling:Folder]
            N:components [sling:Folder]
                N:osgireport [sling:Folder]
    
  2. Bepaal uw rapportbasis. Bijvoorbeeld osgireport[cq:Component] onder /apps/cq/reporting/components/osgireport.

    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"
    

    Dit bepaalt een component van de rapportbasis die:

    • zoekopdrachten naar alle knooppunten van het type sling:OsgiConfig
    • geeft zowel pie- als lineseries-diagrammen weer
    • verstrekt een dialoog voor de gebruiker om het rapport te vormen
  3. Definieer de eerste kolomcomponent (columnBase). Bijvoorbeeld bundlecol[cq:Component] onder /apps/cq/reporting/components/osgireport.

    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"
    

    Dit bepaalt een kolombasiscomponent die:

    • zoekt naar en retourneert de waarde die het van de server ontvangt; in dit geval de eigenschap jcr:path voor elke sling:OsgiConfig-node
    • bevat het count-aggregaat
    • is niet gegroepeerd
    • heeft de titel Bundle (kolomtitel binnen de tabel)
    • bevindt zich in de hulpgroep OSGi Report
    • Vernieuwingen bij opgegeven gebeurtenissen
    OPMERKING

    In dit voorbeeld zijn er geen definities van N:data en P:clientFilter. De reden hiervoor is dat de waarde die van de server wordt ontvangen, op een 1:1-basis wordt geretourneerd. Dit is het standaardgedrag.

    Dit is hetzelfde als de definities:

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

    Waar de functie gewoon de waarde retourneert die deze ontvangt.

  4. Bepaal uw rapportontwerp. Bijvoorbeeld osgireport[cq:Page] onder /etc/designs/reports.

    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. Creeer de wortelknoop voor uw nieuw rapportmalplaatje.

    Bijvoorbeeld onder /apps/cq/reporting/templates/osgireport.

    N:cq [nt:folder]
        N:reporting [sling:Folder]
            N:templates [sling:Folder]
                N:osgireport [cq:Template]
    
  6. Bepaal uw rapportmalplaatje. Bijvoorbeeld osgireport[cq:Template] onder /apps/cq/reporting/templates.

    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]
    

    Hiermee definieert u een sjabloon die:

    • definieert allowedPaths voor de resulterende rapporten - in het bovenstaande geval ergens onder /etc/reports
    • biedt titels en beschrijvingen voor de sjabloon
    • verstrekt een duimnagelbeeld voor gebruik in de malplaatjelijst (de volledige definitie van dit knooppunt is hierboven niet vermeld - het is het gemakkelijkst om een geval van thumbnail.png van een bestaand rapport te kopiëren).

Het creëren van een Instantie van Uw Nieuw Rapport

Een geval van uw nieuw rapport kan nu worden gecreeerd:

  1. Open de console Tools.

  2. Selecteer Rapporten in de linkerruit.

  3. Dan Nieuw… op de werkbalk. Definieer een Titel en Naam, selecteer uw nieuw rapporttype (OSGi Report Template) van de lijst van malplaatjes, dan klik Create.

  4. Uw nieuwe rapportexemplaar zal in de lijst verschijnen. Dubbelklik hierop om te openen.

  5. Sleep een component (voor dit voorbeeld, Bundel in OSGi Report groep) van het hulpslot om de eerste kolom tot stand te brengen en start de rapportdefinitie.

    OPMERKING

    Aangezien dit voorbeeld geen groeperbare kolommen heeft, zijn de grafieken niet beschikbaar. Als u grafieken wilt zien, stelt u groupable in op true:

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

Het vormen van de Diensten van het Kader van het Rapport

Deze sectie beschrijft geavanceerde configuratieopties voor de diensten OSGi die het rapportkader uitvoeren.

Deze kunnen worden bekeken gebruikend het menu van de Configuratie van de Webconsole (beschikbaar bijvoorbeeld bij http://localhost:4502/system/console/configMgr). Wanneer het werken met AEM zijn er verscheidene methodes om de configuratiemontages voor dergelijke diensten te beheren; zie Het vormen OSGi voor meer details en de geadviseerde praktijken.

Basic Service (Day CQ Reporting Configuration)

  • De tijdzone definieert voor welke historische gegevens de tijdzone wordt gemaakt. Dit moet ervoor zorgen dat de historische grafiek de zelfde gegevens voor elke gebruiker over de wereld toont.

  • Locale definieert de landinstelling die moet worden gebruikt in combinatie met de ​tijdzone voor historische gegevens. De landinstelling wordt gebruikt om bepaalde landspecifieke kalenderinstellingen te bepalen (bijvoorbeeld of de eerste dag van een week zondag of maandag is).

  • Het pad voor momentopnamen definieert het hoofdpad waar momentopnamen voor historische grafieken worden opgeslagen.

  • Het pad naar rapporten definieert het pad waar rapporten zich bevinden. Dit wordt gebruikt door de momentopnameservice om de rapporten te bepalen om momentopnamen voor eigenlijk te nemen.

  • Dagelijkse momentopnamen bepalen het uur van elke dag wanneer de dagelijkse momentopnamen worden genomen. Het opgegeven uur bevindt zich in de lokale tijdzone van de server.

  • Uur momentopnamen bepaalt de minuut van elk uur wanneer uurmomentopnamen worden genomen.

  • Met Rijen (max.) wordt het maximale aantal rijen gedefinieerd dat voor elke opname wordt opgeslagen. Deze waarde moet redelijkerwijs worden gekozen; als het te hoog is, zal dit de grootte van de gegevensopslagruimte beïnvloeden, als het te laag is, kunnen gegevens niet accuraat zijn vanwege de manier waarop historische gegevens worden verwerkt.

  • Gegevens van de mislukking, indien toegelaten, kunnen de valse historische gegevens worden gecreeerd door de fakedata selecteur te gebruiken; als deze optie is uitgeschakeld, genereert het gebruik van de fakedata kiezer een uitzondering.

    Aangezien de gegevens vals zijn moet het only voor het testen en het zuiveren doeleinden worden gebruikt.

    Als u de kiezer fakedata gebruikt, wordt het rapport impliciet voltooid, zodat alle bestaande gegevens verloren gaan; gegevens kunnen handmatig worden hersteld, maar dit kan een tijdrovend proces zijn.

  • De gebruiker van de momentopname bepaalt een facultatieve gebruiker die voor het nemen van momentopnamen kan worden gebruikt.

    In feite worden momentopnamen gemaakt voor de gebruiker die het rapport heeft voltooid. Er kunnen situaties zijn (bijvoorbeeld op een publicatiesysteem, waar deze gebruiker niet bestaat omdat zijn account niet is gerepliceerd) waarin u een fallback-gebruiker wilt opgeven die in plaats daarvan wordt gebruikt.

    Bovendien kan het opgeven van een gebruiker een beveiligingsrisico inhouden.

  • De gebruiker van de momentopname afdwingen, indien toegelaten, zullen alle momentopnamen met de gebruiker worden genomen die onder de gebruiker van de Momentopname wordt gespecificeerd. Dit kan ernstige gevolgen hebben voor de veiligheid als het niet correct wordt behandeld.

Cacheinstellingen (Day CQ Reporting Cache)

  • ​Laat toe toelaat u toe of onbruikbaar maakt caching van rapportgegevens. Het toelaten van het rapportgeheime voorgeheugen zal rapportgegevens in geheugen tijdens verscheidene verzoeken houden. Dit kan de prestaties verhogen, maar zal leiden tot een hoger geheugengebruik en kan in extreme omstandigheden leiden tot een gebrek aan geheugen.
  • ​TTL bepaalt de tijd (in seconden) waarvoor het rapportgegeven in het voorgeheugen onder wordt gebracht. Een hoger getal zal de prestaties verhogen, maar kan ook onjuiste gegevens retourneren als de gegevens binnen de tijdsperiode veranderen.
  • Max. items definieert het maximumaantal rapporten dat tegelijkertijd in de cache moet worden geplaatst.
OPMERKING

De rapportgegevens kunnen voor elke gebruiker en taal verschillend zijn. Daarom worden de rapportgegevens in het voorgeheugen ondergebracht per rapport, gebruiker en taal. Dit betekent dat een Max entry waarde van 2 eigenlijk gegevens voor of in de cache plaatst:

  • één rapport voor twee gebruikers met verschillende taalmontages
  • één gebruiker en twee rapporten

Op deze pagina