New article
Recently updated
What is PleaseReport?
Who is this article for?Please Review administrators or data scientists.
Access keys for PleaseReport are required.
PleaseReport is a reporting feature for Ideagen Please Review. It presents the Data as a collection of database views, formatted to match both the underlying tables, and through composite views that show the data pre-joined in useful, common reporting formats. As a result, it is possible to create more complex reports with little effort.
Reporting Schema
PleaseReport uses an additional schema to host the reporting views, a schema which has read only permissions on the underlying base tables. This ensures that it is not possible for a user to change the underlying data, either maliciously or by accident.
Access to the view schema will be restricted to a set of Access Keys that expose the data through an oData interface (Open Data Protocol). As a result, there is no risk of anyone viewing data that does not belong to them.
This article provides details on:
1. Base Table Views
PleaseReport exposes the base data via simple views with the same definitions as the underlying base tables.
|
View Name |
Purpose |
|---|---|
|
VT_Bookmark |
A list of all defined bookmarks in the system |
| VT_Comment | Detailed information on all comments in all reviews |
| VT_CommentHistory | Historical comment data, identifying when each comment changed status and in what way |
| VT_CommentLike | Likes made by reviewers on comments |
| VT_Document | List of all documents in each review, and details on each |
| VT_LicenseFile | Details on the license file applied to the current system |
| VT_Paragraph | Details on the paragraphs within the document |
| VT_Participant | Details on all participants in all reviews |
| VT_PermissionSet | Permissions configuration for users and workgroups in the system |
| VT_QueueEntry | Queue details for scheduled job execution, including integrated workgroup refresh and recycle bin purging |
| VT_Review | Details on all reviews in the system |
| VT_ReviewDocument | Details on each document in a review |
| VT_ReviewMetrics | Metrics created by the administrator and tracked for reviews |
| VT_ReviewMetricsValue | Values for metrics per review |
| VT_ReviewType | Types of reviews, including review types defined by the system administrator |
| VT_SchemaInfo | Current Please Review Schema version |
| VT_Settings | Configuration settings, both default and custom, for the system and individual workgroups |
| VT_StatusCode | Status Code reference data |
| VT_Subject | Details on all the user s within the system |
| VT_SubjectExtSource | Details on how individual users are authenticated, including users who are authenticated internally and externally |
| VT_UserType | Types of user reference |
| VT_Workgroup | Workgroup details, and their place within the workgroup hierarchy |
| VT_WorkgroupMember | Users within each workgroup |
2. Reporting Views
PleaseReport provides a set of sample views that join data from multiple base views in a manner that is typically queried by users. For most of your reports you will be able to use one of these sample views provided. For more complicated requirements you may need to join two or more views together to create your report.
|
View Name |
Purpose |
|---|---|
| VS_ActiveInactiveUsers | Total active/inactive users within the system |
| VS_DocumentFormatCount | Report on the total number of documents of each format within the system |
| VS_LicenseReport | Basic license report, giving summary data of each license type |
| VS_OverdueReviewsByOwner | Reviews that are overdue and should be closed and completed and may be consuming licenses as a result |
| VS_ParticipantsAndDocumentTypes | Review details including a list of all participants and counts of how many documents of each type are part of a review |
| VS_ReviewChangesPerDocument | Details on comments, proposed changes and edit zones per document in a review |
| VS_ReportParticpantCommentDetails | Reviews with owner, a list of all participants and detail values for each status of comment |
| VS_ReportParticpantComments | Reviews with owner, a list of all participants and aggregate values for each status of comment |
| VS_RolesInReviews | Report on roles of participants within reviews |