Reports

This page documents the SureDrive Reports subsystem — the report wizard, report types, user templates, subscriptions, and report generation pipeline. It covers the Angular routes and controllers, the backend ReportType enum, and operation constants.

Overview

The Reports area is accessed via SureDrive → Reports. It provides a wizard-based interface for selecting, configuring, and generating reports against study data. Reports cover: document compliance, audit trails, user roles, signing events, workflow status, team contacts, and quality metrics. Generated reports can be scheduled for subscription delivery.

Key owning modules:

UI: suredms-web-client — network/study/reports/
Backend report definitions: suredms-report — ReportType, ReportConstants, ReportField
Web service: suredms-web-service — report generation endpoints

Angular Routes

Files:

State	Purpose
`app.network.study.browse.report-wizard`	Report wizard for selecting and generating SureDrive reports
`app.network.workflow.workflow-report`	Workflow-specific report view

Controllers and Services

`StudyReportWizardController`

File: SC/suredms-web-client/src/main/webapp/app/js/network/study/reports/study-report-wizard.js

The primary controller for report selection and generation. It organises available reports into four categories:

Category	Examples
Administration	User roles, application roles, user access by archive
Network	Network contacts, organisation reports
Content	Signing audit trail, document compliance, quality compliance
Management	Workflow reports, required document – missing documents

`StudyReportService`

Shared service providing common report configuration helpers: available columns, output format selection (CSV, Excel, PDF where applicable), and report action bindings used across all report views.

Report Wizard Template

File: SC/suredms-web-client/src/main/webapp/app/views/network/study/reports/study-report-wizard.html

The wizard template renders the report category list and report parameter form. Users browse categories, select a report type, configure parameters (date range, user filter, document filter, etc.), and click Generate.

Backend Report Definitions

`ReportType` Enum

File: SC/suredms-report/src/main/java/com/sureclinical/suredms/report/context/ReportType.java

Defines all available report types across SureClinical. SureDrive-relevant report types include:

Enum Value	Display Name	Description
`USER_ROLE`	User Roles	Lists all users and their assigned user roles
`APPLICATION_ROLE`	Application Roles	Lists application roles and their feature assignments
`USER_ACCESS_BY_ARCHIVE`	User Access by Archive	Per-archive user access permissions report
`SIGNING_AUDIT_TRAIL`	Signing Audit Trail	eSign events: applied, rejected, workflow-initiated
`QUALITY_COMPLIANCE`	Quality Compliance	Document compliance status against required content types
`CONTACTS_BY_ARCHIVE`	Persons By Archive	Team members (persons) assigned to each archive
`WORKFLOWS_PLATFORM`	Workflow Report	Active and completed workflow processes
`MISSING_DOCUMENTS`	Missing Documents	Required documents not yet uploaded for milestones

`ReportConstants`

File: SC/suredms-report/src/main/java/com/sureclinical/suredms/report/ReportConstants.java

Contains string constants used in report output:

Constant	Value	Usage
`USER_ROLES`	`user.roles`	Column header for user roles in report output

`ReportField`

Contains field descriptor constants including FIELD_USER_ROLES, used to define which data columns appear in user and role reports.

Backend Operation Constants

File: SC/suredms-web-client/src/main/webapp/app/js/common/constants/constants-operations.js

Constant	Operation String	Purpose
`OPERATION_MOBILE_GET_REPORTS`	`Mobile.GetReports`	Fetches available report list for the current study
`OPERATION_MOBILE_GET_REPORT_TEMPLATES`	`Mobile.GetReportTemplates`	Fetches user-saved report templates
`OP_MOBILE_GET_USER_ROLES_REPORT`	`Mobile.GetUserRolesReport`	Retrieves the user roles report
`OP_MOBILE_GENERATE_USER_ROLES_REPORT`	`Mobile.GenerateUserRolesReport`	Generates and downloads the user roles report
`OP_MOBILE_GET_APPLICATION_ROLES_REPORT`	`Mobile.GetApplicationRolesReport`	Retrieves the application roles report
`OP_MOBILE_GENERATE_APPLICATION_ROLES_REPORT`	`Mobile.GenerateApplicationRolesReport`	Generates and downloads the application roles report

Report Wizard Flow

User navigates to SureDrive → Reports → app.network.study.browse.report-wizard.
StudyReportWizardController loads available report types via OPERATION_MOBILE_GET_REPORTS.
User selects a report category and report type.
Wizard renders report-specific parameter fields (date range, user filter, document type, etc.).
User clicks Generate — the controller submits a generation request to the corresponding operation endpoint.
The web service processes the request and returns a file download (CSV or Excel) or queues it for async delivery.

Subscriptions

Help file: Help/contents/Content_Repo/Subscribing_to_Reports_in_SureDrive.htm

Reports can be scheduled for recurring delivery. A subscription configures:

Report type and parameters
Delivery frequency (daily, weekly, monthly)
Recipients (email addresses)

Subscriptions deliver the report automatically on the configured schedule without user interaction.

User Templates

Help file: Help/contents/Content_Repo/Creating_Reports_using_the_Report_Wizard_or_User_Templates.htm

Users can save a configured report (type + parameters) as a named template for reuse. Templates are retrieved via OPERATION_MOBILE_GET_REPORT_TEMPLATES and appear in the report wizard as pre-configured shortcuts.

Report Generation from Other Views

Reports can be initiated from outside the Reports area:

Originating View	Report Type	Trigger
Audit Trail	Signing Audit Trail	Generate Report button in the Audit Trail view
Quality Queue	Quality Compliance	Quality Queue → Generate Report
Workflow Dashboard	Workflows Platform	Workflow Dashboard → Generate Report

Help Reference

Topic	File
Working with Reports	Help/contents/Content_Repo/Working-with-Reports-in-SureDrive_666730586.html
Creating Reports (Wizard / Templates)	Help/contents/Content_Repo/Creating_Reports_using_the_Report_Wizard_or_User_Templates.htm
Subscribing to Reports	Help/contents/Content_Repo/Subscribing_to_Reports_in_SureDrive.htm
Viewing Reports	Help/contents/Content_Repo/Viewing_Reports_in_SureDrive.htm
Managing Reports	Help/contents/Content_Repo/Managing_Reports_in_SureDrive.htm

Key Source Files Reference

File	Purpose
SC/suredms-web-client/src/main/webapp/app/js/network/study/reports/study-report-wizard.js	`StudyReportWizardController` — report category list and generation flow
SC/suredms-web-client/src/main/webapp/app/views/network/study/reports/study-report-wizard.html	Report wizard template
SC/suredms-web-client/src/main/webapp/app/js/common/constants/constants-operations.js	Report operation string constants
SC/suredms-report/src/main/java/com/sureclinical/suredms/report/context/ReportType.java	All report type definitions

Overview​

Angular Routes​

Controllers and Services​

StudyReportWizardController​

StudyReportService​

Report Wizard Template​

Backend Report Definitions​

ReportType Enum​

ReportConstants​

ReportField​

Backend Operation Constants​

Report Wizard Flow​

Subscriptions​

User Templates​

Report Generation from Other Views​

Help Reference​

Key Source Files Reference​