The versioning feature of the External Module Framework allows for backward compatibility while the framework changes over time. To allow existing modules to remain backward compatible, a new framework-version is released each time a breaking change is made. These breaking changes are documented at the top of each framework version page linked in the table below.
New REDCap versions support all previous framework versions indefinitely, giving module authors the flexibility to update to newer framework versions at a time of their choosing (addressing breaking changes at that time). While there are no current plans to drop support for older framework versions, that is expected to change down the road.
All new features (e.g. new methods) are available to framework versions 2 and above. In Framework versions 2-4, the now deprecated $module->framework->whateverMethod() syntax is required to access newer methods.
Modules should specify the framework-version in config.json as follows:
{
...
"framework-version": #,
}
...where the # is replaced by the latest framework version integer (as opposed to string) that is available on the minimum REDCap version they intend to support (per the table below). If a framework-version is not specified, the module will default to framework version 1.
Modules will only work on REDCap versions that support their framework-version per the following table. It is NOT required to specify a redcap-version-min in addition to framework-version, as the latter is automatically considered during REDCap minimum version checking, per the table below. The redcap-version-min will effectively be overridden if it is omitted or is older than the REDCap version required by the framework-version.
| Framework Version | First Standard Release | First LTS Release |
|---|---|---|
| Version 16 | 14.6.4 | TBD |
| Version 15 | 14.0.2 | 14.0.5 |
| Version 14 | 13.7.0 | 13.7.3 |
| Version 13 | 13.4.11 | 13.7.3 |
| Version 12 | 13.1.0 | 13.1.5 |
| Version 11 | 12.5.9 | 13.1.5 |
| Version 10 | 12.4.1 | 12.4.6 |
| Version 9 | 12.0.4 | 12.0.8 |
| Version 8 | 11.1.1 | 11.1.5 |
| Version 7 | 10.8.2 | 11.1.5 |
| Version 6 | 10.4.1 | 10.6.4 |
| Version 5 | 9.10.0 | 10.0.5 |
| Version 4 | 9.7.8 | 10.0.5 |
| Version 3 | 9.1.1 | 9.1.3 |
| Version 2 | 8.11.6 | 9.1.3 |
| Version 1 | 8.0.0 | 8.1.2 |