Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Equella table structures to the guides directory and linked the docs to the Reporting Guide #7

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Added Equella table structures to the guides directory and linked the docs to the Reporting Guide #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ab895c9
Added table structure documents. Then linked these documents in the r…
matjmiles Feb 9, 2018
90b5d33
Fixed link in reporting guide.
matjmiles Feb 9, 2018
84dcc88
Another link fix.
matjmiles Feb 9, 2018
d8195b1
fix
matjmiles Feb 9, 2018
2dbda0c
Changed file name
matjmiles Feb 9, 2018
d6487a4
More file name changes
matjmiles Feb 9, 2018
4a02c78
More docu fixes.
matjmiles Feb 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added guides/EQUELLA_Table_Structures_audit_log_entry.pdf
View file
Open in desktop
Binary file not shown.
Binary file added guides/EQUELLA_Table_Structures_tleuser_item_audit_log_entry_language_string.pdf
View file
Open in desktop
Binary file not shown.
Binary file added guides/EQUELLA_Table_Structures_tleuser_join_item.pdf
View file
Open in desktop
Binary file not shown.
10 changes: 10 additions & 0 deletions guides/ReportingGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Table of Contents
* [User management](#user-management)
* [Scenarios](#scenarios)
* [Creating an Equella-Enabled BIRT Report Designer Binary](#creating-an-equella-enabled-birt-report-designer-binary)
* [Equella Table Structures](#equella-table-structures)

## Report Designer overview

Expand Down Expand Up @@ -604,3 +605,12 @@ User and Group information queries require careful implementation as each record

# Creating an Equella-Enabled BIRT Report Designer Binary
A given BIRT RD Equella release binary is comprised of a standard binary of BIRT RD, along with the Equella plugins from [equella/equella-reporting-plugin](https://github.com/equella/equella-reporting-plugin). These plugins are the same plugins used in the Equella application to receive requests from BIRT RD, and to run the reports that have been added to Equella.

## Equella Table Structures

* [audit_log_entry table](EQUELLA_Table_Structures_audit_log_entry.pdf) – The contents of these columns changes based on the event_type and event_category
* [tleuser join item table structure](EQUELLA_Table_Structures_tleuser_join_item.pdf) – Often we want to generate a report that joins the tleuser table with the item table. The join is: tleuser.uuid = item.owner
* [tleuser__item__audit_log_entry__language_string structure](EQUELLA_Table_Structures_tleuser_item_audit_log_entry_language_string.pdf) – Relationships between tleuser, audit_log_entry, language_string, item