https://github.com/ctsit/report_production_candidates

A REDCap module to enumerate and promote projects that aren't in production but probably should be
https://github.com/ctsit/report_production_candidates

control-center redcap redcap-external-module

Last synced: about 1 month ago
JSON representation

A REDCap module to enumerate and promote projects that aren't in production but probably should be

• Host: GitHub
• URL: https://github.com/ctsit/report_production_candidates
• Owner: ctsit
• Created: 2017-12-08T21:49:46.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-03-09T15:46:14.000Z (almost 4 years ago)
• Last Synced: 2023-08-19T18:13:23.015Z (over 1 year ago)
• Topics: control-center, redcap, redcap-external-module
• Language: PHP
• Size: 46.9 KB
• Stars: 0
• Watchers: 6
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Report Production Candidates

This REDCap module creates and displays a list of REDCap projects that should probably be moved into production. This module is integrated with Stanford University's [Go to Prod plugin](https://github.com/aandresalvarez/go_to_prod) and provides an interface for REDCap Admins to contact owners of projects for follow up.

## Prerequisites

- REDCap >= 8.0.3 (for versions < 8.0.3, [REDCap Modules](https://github.com/vanderbilt/redcap-external-modules) is required).

- [go_to_prod plugin](https://github.com/aandresalvarez/go_to_prod) installed on your REDCap instance.

## System-level Installation

1. Clone this repo into `/modules/report_production_candidates_v`.

2. Go to **Control Center > Manage External Modules** and enable _Report Production Candidates_.

## Configuration

- Users can optionally preload an email template that will be used when they click a username in the report.  See [Sample Email Configuration](samples/email_configuration.md) for an example.

## Using this module

Go to **Control Center > Report Production Candidates** and to view the reports. Admins can use the Go to Prod button to review the project's production readiness and move the project into production. They can also click on REDCap usernames within the report to send those users an email. This email can be pre-filled with a template via the module's configuration page.

## Notes regarding initial load of the report

Report Production Candidates can seem very slow on the initial load. Please be patient if the first display of report takes many minutes. On a large or old REDCap system this is completely normal. Fortunately this will only happen on the _very first_ load of the report.

Report Production Candidates uses summary data about projects that can only be acquired through queries of some of the largest tables in the REDCap database. On a large REDCap system with lots of activity or lots of stored data, these tables have millions of records. To circumvent the delays caused by querying these tables, this module uses a nightly cron job to gather the summary data. It writes the summary data into a table it can quickly query when running the report. That said, when first enabling the module, that table is empty. The reporting script detects the empty table and starts the initial run of the cron job that refreshes the table. That is why the first load of the report is slow. Normal report display should be about 50 projects/second.