/
Reports
Reports
The reports module provides a content type which specifies a simple report based on the filtered records of some other content type, and allows that report to be run and downloaded as a CSV.
By default, reports are a content type which exist in the url space at /lynicon/reports/report-name. The editor for a report contains a number of fields which specify an output field for the report which needs to be generated. These are explained below:
Block | Field | Explanation |
General | Title | The name of the report for listings |
General | Content Type | The name of the content type to list in the report |
Fields | Name | The name of a property to show, this can be a path e.g. Image.Url or ItemList.Count. It can also be two special values, *Type to show the (underlying) type of the item, or *Url to show the url of the item. |
Fields | IsFilter | If checked, the user is presented with the possible values of this field in a drop down - when the report is run the rows are matched against this value before being included. |
Fields | Hide | If checked, the value of the field is not shown in output |
Fields | Filter Value | Optionally, a fixed value to which this property is compared before including in output |
Fields | Filter Comparison | Select the kind of comparison to use against the user supplie value or Filter Value when filtering |
Fields | Show Referred | Check so that nstead of showing the value of the field itself, it's used as a key to retrieve a value from another type of data |
Fields | Get All Refs | When following a key to get data, this will load all possible records for all values of the key. This only works where the Value Field Name and Text Field Names are all fields of the summary for the linked to record type |
Fields | Get Full Ref Record | Check this to get the full record not the summary when following a key. Only needed when there is a field not in the summary for Value Field Name or in Text Field Names. |
Fields | Ref Type Name | The name of the type of the record being referenced by key. |
Fields | Value Field Name | The field which is compared to the key when referencing a record |
Fields | Text Field Name | A field name or comma separated list (no spaces) of field names of the properties of the record retrieved by key to show in the output |