Releases: dr01d3r/redcap-em-orca-specimen-tracking
Another PHP Fix
2.0.4
- Additional PHP compatibility changes to maintain support for PHP 7.3, until REDCap officially drops it.
Example Project XML Files
Attached are project XML files that were created in REDCap v14.8.0, and contain the bare minimum project setup requirements (i.e. forms/fields) for this module to work.
Example Module Configuration
Additionally, is a zip file containing the module configurations used in the example projects. This data must be associated with the Box Project, so ensure you are in context of that project when importing these settings.
PHP Compatibility Fix
2.0.3
- PHP compatibility changes
Date Field Updates & PHP Compatibility
2.0.2
- Fixed a bug that was causing a validation error for fields using
date_mdy
ordate_dmy
validation. - Fixed a limitation that was preventing extras from being available for
date
fields.- Extras validation can now use any combination of Date and DateTime fields.
- Changed some code to be PHP 7.3 compatible
Example Project XML Files
Attached are project XML files that were created in REDCap v14.8.0, and contain the bare minimum project setup requirements (i.e. forms/fields) for this module to work.
Example Module Configuration
Additionally, is a zip file containing the module configurations used in the example projects. This data must be associated with the Box Project, so ensure you are in context of that project when importing these settings.
Bug Fixes
2.0.1
- Fixed a bug that would prevent a specimen save if a specimen field was not enabled on the Specimen Entry Form, but was marked required or had Extras.
- Fixed a bug that was preventing the deletion of specimens from a box.
- Fixed a bug that was affecting the "Reset Specimen" if a field had the "Batch Mode" configuration enabled, even when batch mode was "Off" during specimen entry.
Example Project XML Files
Attached are project XML files that were created in REDCap v14.8.0, and contain the bare minimum project setup requirements (i.e. forms/fields) for this module to work.
Example Module Configuration
Additionally, is a zip file containing the module configurations used in the example projects. This data must be associated with the Box Project, so ensure you are in context of that project when importing these settings.
Major Update - Version 2!
BREAKING CHANGES
- This is a full rebuild that will cause breaking changes in existing projects if you update without proper preparation and configuration.
- Review the new documentation, and ideally get familiar with and test it in a dev environment before going to production.
- There are too many changes to list here - review the README to learn more!
Example Project XML Files
Attached are project XML files that were created in REDCap v14.8.0, and contain the bare minimum project setup requirements (i.e. forms/fields) for this module to work.
Example Module Configuration
Additionally, is a zip file containing the module configurations used in the example projects. This data must be associated with the Box Project, so ensure you are in context of that project when importing these settings.
Data Tables (REDCap v14.x)
The primary reason for this release is to ensure new projects still work if you've upgraded to REDCap v14.0 or higher. Included is a few other minor changes and bug fixes.
- SQL queries updated to support new data tables behavior (REDCap v14.0)
- Slightly changed validation behavior to cooperate with intended field navigation
- Made unit display lookup on box [sample_type] case-insensitive
- Frozen fields are no longer required, such that they can be provided at a later time after initial entry
- Specimens can now be moved within the same box (excluding '00' temp boxes)
Refer to the previous release (v1.0.2) for example files and how to use them.
v1.0.2 - Bug Fixes
1.0.2
- Fixed a bug that prevented box position context from initializing when entering a box from the search function
- Fixed a display issue with volume units if the
sample_type
component in the box name is unknown - Fixed a bug that would prevent
enter key
navigation through the CSID/CUID fields when they were left blank
Usage
This module has been submitted to the REDCap Repository, so the first place to go for installing the module is there. However, you may refer here for the example project files to help get your projects started.
The additional files in this release include the Project XML's for each of the 3 project types this module requires (box, specimen, shipment), as well as Data Dictionaries for each, depending on your needs.
Sample Data
If you want to use the included sample data files, you'll need to match the module configuration with the following (unfortunately, module settings at the control center level cannot be imported/exported):
- General Configuration
- Study Name
- anything works
- Box Size
10x10
- Box Name
^(?<box_type>00|[A-Z]{2})(?<sample_type>[A-Z]{5})(?<aliquot_number>[0-9]{2})(-V)(?<visit>[0-9]{3})(-BX)(?<box_number>[0-9]{3})$
- Specimen Name
^(?<year>22)(-)(P)(?<participant_id>[0-9]{4})(-v)(?<visit>[0-9]{3})(?<sample_type>[a-zA-Z]{2})(?<aliquot_number>[0-9]{2})$
- Study Name
- Optional Configurations
- Preferred datatime format
MM/dd/yy HH:mm
- Default volume
1.0
- Collected -> Processed override time
1080
- CSID/CUID Disable
- No (unchecked)
- Preferred datatime format
- Mixed '00' Temporary Box Configuration
- Will this be utilizing
- Yes (checked)
- Visits per Participant
2
- Specimens per Visit
3
- Will this be utilizing
Follow module documentation for remaining instructions on configuring its usage.
v1.0.1
1.0.1
- Added support for a 10x10 box size
- Minor layout fixes related to Bootstrap 5
- Added configuration option disable the required validation of CSID/CUID
- Fixed multiple bugs related to CSID/CUID validation
Usage
This module has been submitted to the REDCap Repository, so the first place to go for installing the module is there. However, you may refer here for the example project files to help get your projects started.
The additional files in this release include the Project XML's for each of the 3 project types this module requires (box, specimen, shipment), as well as Data Dictionaries for each, depending on your needs.
Follow module documentation for remaining instructions on configuring its usage.
If migrating from the beta version (biospecimen_tracking)
You'll have to manually copy settings in the Control Center from the old module to this one. Unfortunately, there is no built-in way to export/import module settings at the Control Center level.
Initial Release
We've finally reached our first initial release milestone! Thanks to all of you that assisted in testing and trying out the beta version.
Usage
This module has been submitted to the REDCap Repository, so the first place to go for installing the module is there. However, you may refer here for the example project files to help get your projects started.
The additional files in this release include the Project XML's for each of the 3 project types this module requires (box, specimen, shipment), as well as Data Dictionaries for each, depending on your needs.
Follow module documentation for remaining instructions on configuring its usage.
If migrating from the beta version (biospecimen_tracking)
You'll have to manually copy settings in the Control Center from the old module to this one. Unfortunately, there is no built-in way to export/import module settings at the Control Center level.