Recalculate - Redcap External Module

What does it do?

This module allows you to calculate and save values for calc fields in a project by selecting some subset/combination of events, records, and feilds. This is usefull if you need to update a very large number of calcs, or only want to update values on a subset of records/events. Logging occurs as expected with the user and a typical "Update record (Auto calculation)" event logged in addition to an EM specifc log event when new recalcs are started via the EM. Access to the module's page is restricted to those with permissions to execute data quality rules, an explicit white list can also be created in the EM's project level configuration.

Features:

• Run recalculations for specifc records, events, fields or any cobination
• Generate previews of incorrect calculations before executing them
• Execute a recalcuation on a single issue in your preview table
• The most recent preview of issues you genertate is cached so you can quickly load it later
• Verbose logging
• An API is exposed (see below) for you to easily trigger recalcs via a script or other integration
• Schedule recalculations to occur at a later time
• Setup scheduled reclaculations to repeat as often as you'd like

FYIs:

• Removing a repeating scheduled cron will remove all future runs too
• A repeating scheduled cron that fails via error (usually due to running for over 24 hours) will not repeat
• If you find yourself getting a 500 response using the API you should ask your Redcap admin to edit the System Config option "Usable Memory" for the EM, something around 4096 should work. You will also want to ask them to be sure "memory_limit" in the server's php.ini file is atleast the same value.

Installing

You can install the module from the REDCap EM repo or drop it directly in your modules folder (i.e. redcap/modules/recalculate_v1.0.0).

API

This module exposes a simple API to trigger recalcuations ...

POST /api/?type=module&prefix=recalculate&page=api&NOAUTH

|Body Parameter| Description | Type | |:-----------------:|:---------------------------------------:|:------------:| | token | User's API token | string | | fields | Unique field names or '' for all | json array | | events | Event IDs or '' for all | json array | | records | Record IDs or '*' for all | json array |

No defaults are assumed by the api, thus all fields are requried. A parameter type of "json array" should always be an array, not a naked string. Errors are not returned for invalid event ids, the ids are simply thrown out.

Return Format

js { "changes": 0, // Number of total Changes "errors": [], // Any errors that occured, list of objects with the property "display" (bool) and "text" (string) "records": [], // List of strings, record IDs requested "preview": [] // Always an empty array, used only internally }