A configurable, searchable, and performant, list dashboard.
To enhance searching REDCap records. This module can also be used to create a custom list dashboard.
This module does not yet support repeating events.
- Configurable field search options
- Configurable field display options
- New Record support for projects with and without auto-numbering enabled
- Only Super Users or project users with explicit "Create Record" rights will see the "Add new record" button
- Result highlighting when searching with partial matching enabled
- Support for searching through repeating forms
- Data Access Group security
- Users in a DAG will only see results from within their DAG
- Users not assigned a DAG will see results regardless of DAG
- Long text truncation
- To prevent dropdowns from extending off screen and table headers causing significant visual issues, field labels, structured data values (select, radio, checkbox), and Dynamic SQL results will be truncated down to 60 characters OR the first new line, whichever one comes first.
- If truncation causes visual text to be removed, an ellipsis (...) will be appended to the end.
- NOTE: An ellipsis only applies to multi-line labels if the first line exceeds 60 characters.
- REDCap
- Minimum: v13.1.0 STD (v13.1.5 LTS)
- Latest: v14.3.7 STD
- PHP
- Minimum: v7.2.5
- Latest: v8.1.29
- redcap_every_page_top
- Enable the module in your project, if it is not already enabled
- Click Configure for Orca Search Module
- Redirect Add/Edit Records to Module
- Check this option if you would like to "replace" the Add/Edit Records page with this module.
- When a user clicks the link, they will be directed to the module's search page.
- Limit the search results
- The results can be restricted to 500, 1000, 2000, 5000, or No Limit. If the search results exceed that number, an error message will display and no results will show.
- Which instances to search through
- Latest - search only the most recent instances of forms.
- All - all instances will be considered.
- Currently, the results table will always display the result from the latest instance, even if the matching value was found on a previous instance.
- Show instance badge
- A red badge will display in the data table, indicating which instance the displayed value was found.
- Include DAG in results
- An additional column will display in the results, indicating the Data Access Group that record belongs to.
- This option only works if the project uses Data Access Groups.
- Prevent an empty search from yielding results
- Forces users to always provide a value when searching. This can be useful when you want to restrict access to records (i.e. MRN exact match).
- Specify 'Record Home' button location in display fields table (default=Last Column)
- Allow the record home button to be the first or last column, or not displayed at all
- Search Fields
- This repeating configuration allows you to select the fields that you want to use as search fields.
- Fields will display in the dropdown, in the order that exist in the config.
- Fields that are select, radio, form status, etc., will display a dropdown instead of a text box, for filtering by value.
- Return Partial Matches
- This option allows you to do a 'wildcard' search on that field (i.e. searching wis in a state search will return results for Wisconsin)
- NOTE: This option is ignored if the field type is radio, select, checkbox, or sql
- Display Fields
- These are the fields you wish to see in the results table
- Text values will display as-is, while structured data will show the display values.
- Selecting the form_name_complete fields will display accordingly (Incomplete, Unverified, Complete).
- Fields will display in the table, in the order they are selected in the config.
- DateTime fields are displayed and searched using the values as they are stored in the database (YYYY-MM-DD).
- If a project uses Data Access Groups, and the record_id field is displayed, I've done my best to ensure that column sorts as expected.
- For projects with significant record counts (10,000+, especially if they use DAGs), the usage of getAutoId() for adding new records will increase the load times of the module.
- For a baseline example, a project with ~45k records takes 4-8 seconds for getAutoId() to complete.
- Note: performance for this should see significant improvement in REDCap v9.3.7+
- If you identify any issues, please submit an issue on this GitHub repo or make a post on the forums and tag me (@chris.kadolph)
- Multiple Filters
- Use DateTime format from the Data Dictionary rather than raw database value
- Support for displaying the latest instance that matched the search criteria
- Custom configuration page
- Row formatting (i.e. form status indicators)