Teh Report Editor is a fantastic tool to create customized reports for audit data as well as for snapshot data. But you have to understand its basic logic and its settings. Otherwise you'll be trapped in trial and errors.
Reporting (general parameters)
Display Name
Defines the name of the report as it will appear in the Reporting selection box.
...
Filter
...
Defines the regular expression which is applied to find the elasticsearch index that is used as the base to the report. If you search for the elasticsearch indexes, that are generated by the audit driver or the snapshot service by default, you will find the following indexes using the browser based URL interface of elasticsearch:
In row index you see the two base indexes to use for reports:
- "audit-default-yyyy.mm.ss" created dialy by the audit driver
- "report-default-yyyy.mm.ss" created by the snapshot service each time it runs
"^audit" means select all indexes that do start with "audit". So in this example all available audit indexes will be used for the report.
Index Rename Javascript
This field represents a java script function, how the index name will be presented in the index selection list, when creating the report. The function sais take the name of the index starting with the 7th character and replae all "-" with a blank " ". So the real name of the index "audit-default-2022.05.10" will appear as "default-2022.05.10" in the selection list.
Sort Fieldname
Defines the attribute that is used to sort the report. The field does not to be set as a field on the report!
Sort Direction
...
(
...
Fields (to retrieve data from)
In this section you define all fields you want to place on your report based on the index you have defined above.
Just enter the field names in the order you want to see the fields on the report. Use the arrow up/down to move the fields.
To find the valid attribute names for the different indexes you can use following methods:
For audit indexes
To brows thru audit indexes to find out the valid attribute names you can either use:
- use the Audit Dashboard
- search thru the audit index using the elasticsearch browser based URL interface
Audit Dashboard
Open the default Audit Dashboard and scroll to the table at the bottom of the dashboard. Open one of the events where attribute "Event" is equal "true" using the triangle at the very left of the event row. You'll see all attributes, that are available for an event:
Browse audit-default index with Elasticsearch URL interface
You can also look into audit-default indexes using browser URLs. e.g. to look into the audit-default-2022.05.10 index enter the following command depending on your serves IP or URL and port:
https://<server URL or IP>:<port>/elasticsearch/audit-default-2022.05.10/_search?prettyThe result will look similar to the screen below. Each entry begins with "_index" and the name of the index. Attributes will start after "_source" and are marked red.
For report indexes
To brows thru report indexes to find out the valid attribute names you can use one of the following methods:
- use the History Browser
- search thru the report index using the elasticsearch browser based URL interface
History Browser
Go to the Object Browser and select a report index. Browse thru the tree and the objects you want to know the attributes names. e.g open a user you'll see its attributes:
All bold lines are names of user attributes.
Browse report-default index with Elasticsearch URL interface
You can also look into report-default indexes using browser URLs. e.g. to look into the report-default-2022.04.12 index enter the following command depending on your serves IP or URL and port to search for cn=afuhrmann
https://<server URL or IP>:<port>/elasticsearch/report-default-2022.04.12/_search?pretty&q=cn:afuhrmannThe result will look similar to the screen below. Each entry begins with "_index" and the name of the index. Attributes will start after "_source" and are marked red.
You'll find all attributes the the searched object.
Alias (and view options for field)
In the report the field name will also be the column header for this field. If you want to use a different column header in the report you have to define an alias name for the field. e.g. If the header of the attribute "cn" should appear as "ID" and "givenName" should appears as "Firstname", define the approrpiate alias like this:
The report will show the appropriate column header.
Filter (definitions)
Filter definitions let you filter the data for your report. BUT there are two completely differnet type of filters, that have a different purpose:
...