https://github.com/ctsit/modify_contact_admin_button

Modify the behavior of the 'Contact REDCap Administrator' button by redirecting the user to a configurable url
https://github.com/ctsit/modify_contact_admin_button

redcap redcap-external-module redcap-repo

Last synced: about 1 month ago
JSON representation

Modify the behavior of the 'Contact REDCap Administrator' button by redirecting the user to a configurable url

• Host: GitHub
• URL: https://github.com/ctsit/modify_contact_admin_button
• Owner: ctsit
• License: other
• Created: 2017-12-15T14:15:28.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-05T00:09:03.000Z (over 2 years ago)
• Last Synced: 2023-08-19T18:13:22.191Z (over 1 year ago)
• Topics: redcap, redcap-external-module, redcap-repo
• Language: PHP
• Size: 253 KB
• Stars: 2
• Watchers: 7
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# REDCap External Module: Modify Contact Admin Button

[![DOI](https://zenodo.org/badge/114378066.svg)](https://zenodo.org/badge/latestdoi/114378066)

Modify Contact Admin Button changes the behavior of REDCap's 'Contact REDCap Administrator' button by redirecting the user to a configurable URL. The REDCap admin can set this URL in the external module configuration. The admin can add a series of parameters to the URL to make details about the current REDCap user and project available to the target form.

## Prerequisites

- REDCap >= 8.0.3 (for versions < 8.0.3, [REDCap Modules](https://github.com/vanderbilt/redcap-external-modules) is required).

## Installation

- Clone this repo into `/modules/modify_contact_admin_button_v`.

- Go to **Control Center > External Modules** and enable Modify Contact Admin Button.

- Still in **Control Center > External Modules** configure the module with a URL of a web form. You may also include parameter name-value pairs to be appended to the URL. For example, you could provide the URL of a REDCap survey used for service request intake. Lastly, activate this module for all projects.

## Features included

The following values may be selected to be appended to the URL:

- user_firstname

- user_lastname

- email

- project_id

- USERID

The `USERID` field contains the redcap username.

Settings on the system-level can be overridden for specific projects by super users only.

Additional Contact REDCap Admininistrator link at the top of project pages (introduced in REDCap v12.3.1) can also be modified with a system-wide setting, which can also be overridden at the project level.

In addition, the label of the 'Contact REDCap administrator' button can be changed, and the button can be removed entirely. Furthermore, the 'Suggest a New Feature' link can be removed for specific projects.

## Example

Using the configuration below:

![Example Configuration](example_configuration.png)

the rewritten target URL might look like this:

    https://redcap.example.org/surveys/?s=DUPrXGmx3L&gatorlink=jdoe&project_id=14&redcap_username=jdoe

To use the appended parameters, make sure the parameter names you chose coincide with the names of the fields in the target REDCap survey.