A REDCap Module designed to display a banner at the top of select project pages. Supports the data piping of query results into the banner text.
- REDCap >= 8.0.3
- Obtain this module from the Consortium [REDCap Repo] (https://redcap.vanderbilt.edu/consortium/modules/index.php) from the REDCap Control Center.
- Clone this repo into
<redcap-root>/modules/data_driven_project_banner_v0.0.0.
Typically, this module should be enabled on all projects after it has been configured. All configuration options are at the system-level.
Provide the text you would like displayed in the project banner. This field supports HTML formatted text. If you do not configure this value, you will get the default project banner:
This is the default project banner. Change this in the system level
module configuration for the Data Driven Project Banner module.
The banner text field also supports data piping akin to REDCap Smart Variables, (i.e. [project_id] will return the value stored for project id). That said, this module uses its own set of replacement fields. The variables available for replacement are the column names in the response to the SQL query specified in the Prebuilt SQL configuration option. No other values are available to be piped.
Select an optional SQL query from the list provided. The recommended query is REDCap projects table which runs the query SELECT * FROM redcap_projects WHERE project_id = [project_id] where [project_id] is the Project ID for the current project. Note that if the SQL query fails, the banner will still be displayed, but without the intended data piping. If a query result is required to display the banner, select Require a non-empty query result.
Advanced users may edit the config.json file to add their own SQL queries. These queries should be project-centric and return only one row. Any reference to [project_id] in these queries will be replaced with the current Project ID. That is the only substition made to the query string.
If you use the REDCap projects table query, there are over 110 possible column names to choose from when data piping. These columns are probably the most interesting for data piping:
project_id
app_title
project_contact_name
project_contact_email
project_pi_firstname
project_pi_mi
project_pi_lastname
project_pi_email
project_pi_alias
project_pi_username
project_pi_pub_exclude
project_pub_matching_institution
project_irb_number
project_grant_number
If you are using the query UF: projects for which unpaid invoices were sent over 340 days ago, it adds these fields to those listed above, but this query is dependent on tables available in the UF CTSI REDCap instance.
invoice_url
invoice_id
invoice_status
invoice_created_date
creation_time
saved_attribute_count
record_count
uploaded_file_count
total_file_storage_in_mb
owner_username
owner_firstname
owner_lastname
owner_email
project_user_email_addresses