eae:most-popular

Syntax

<eae:most-popular
   category="..."?
   collectionId="..."?
   from="..."?
   groupByPublication="..."?
   id="..."
   includeContextPubId="..."?
   includeRest="..."?
   includeSubSections="..."?
   max="..."?
   meta="..."?
   pubId="..."?
   sectionId="..."?
   sinceHoursAgo="..."?
   sinceMinutesAgo="..."?
   to="..."?
   type="..."?
   url="..."/>

Attributes

id, mandatory, no runtime expressions

Used to identify 'com.escenic.analysis.qs.client.pageview.MostPopular'.

collectionId, no runtime expressions

Used to identify a java.util.Collection containing 'com.escenic.analysis.qs.client.pageview.MostPopularElement'.

url, mandatory

Type: String

This is the URL to the EAE query service, i.e. http://server:port/eae-qs/QueryService.

from

Type: java.util.Date

Defining the start of the time period.

Note: Cannot be used with sinceMinutesAgo/sinceHoursAgo attributes.

to

Type: java.util.Date

Defining the end of the time period.

Note: Cannot be used with sinceMinutesAgo/sinceHoursAgo attributes.

sinceMinutesAgo

Type: String

Defining how many minutes ago the time period starts (appending to sinceHoursAgo).

Note: Cannot be used with to/from attributes.

sinceHoursAgo

Type: String

Defining how many hours ago the time period starts (appending to sinceMinutesAgo).

Note: Cannot be used with to/from attributes.

max

Type: String

Default: 10

Maximum number of elements in the list.

type

Type: String (comma separated values) or String[], Default: (empty/null)

Limit the list to contain only the specified types, i.e. 'article' or 'section'.

sectionId

Type: Integer or String (comma separated values) or String[], Default: (empty/null)

Limit the list to contain elements only from the specified sections.

includeSubSections

By default, the list will be limited to contain only elements from the specified sections. However, setting this value to true will also include items from the subsections of the specified sections.

pubId

Type: Integer or String (comma separated values) or String[], Default: (empty/null)

Limit the list to contain elements only from the specified publications. Note the 'includeContextPubId' attribute. If that attribute is set to true, pubIds added with the pubId attribute will be appended to the context publication ID.

includeContextPubId

By default, if neo.xredsys.api.Publication is found in the request scope, the list will be limited to contain only elements from this Publication. However, setting this value to false will ignore the publication context.

meta

Type: String (comma separated values) or String[], Default: (empty/null)

Limit the list to contain only the specified metas.It may be empty but must be a String(comma separated) or a String[]. Absence of this attribute will include all metass.

category

Type: String (comma separated values) or String[], Default: (empty/null)

An array of category values which this query will be limited to. The attribute category may be empty but must be a String(comma separated) or a String[]. Absence of this attribute will include all categories .

includeRest

This attribute determines, Wether or not to include the remaining objects as one element. If set to true, this will add an aggregated element to the list (max + 1) representing all the remaining objects.By default the value of this attribute is false.

groupByPublication

This parameter is used to configure whether article will be grouped by publication or not when generating most popular reports.It defaults to true. If set to false, aricle and / or section will not be grouped across publications.Please note that when this parameter set false, accessing pubId property in 'com.escenic.analysis.qs.client.pageview.MostPopularElement' will return 0 as article are not goruped considering publications in such case.

Scripting variable (id)

A scripting variable will be defined using the value of the id attribute as its name. The variable is of type com.escenic.analysis.qs.client.pageview.MostPopular.

Scripting variable (collectionId)

A scripting variable will be defined using the value of the collectionId attribute as its name. The variable is of type java.util.Collection.