Cross Project Piping - External Module

Configure Cross Project Piping

This module must be enabled on the DESTINATION project, and is intentionally disabled on surveys for security reasons. Once enabled the configuration is done with in the external module tab on the project.

Project configurations that must be set up prior to field configurations.

1. Go to your DESTINATION project.
2. In the Destination project, click on External Modules on the left-hand navigation bar. Then click on the Configure button. 3. Source Project: This field is a drop down list of all the projects the configuring user has access to.

4. Unique Match Field: Select the unique field on the destination project that represents the record (first field of project). REDCap uses record_id as the default value but can be different on every project.

5. Alternate Source Match Field: This is used if the unique match field on the destination project is different from the source project. For example if Project A records are subject_id but Project B records are record_id.

Note all configurations can repeat, in the instance you need to pipe values from multiple projects into one. Simply select the + icon in the gray space at the top.

Setting up your piped field.

1. Select the destination field from the drop down list.

2. You will only need to enter a value in the Source field if the variable name on the destination field is different from the source field.

Note to add more pipied fields select the + icon in the gray space to the right of Pipe Field:

Forms to allow piping Here you will select the instument piping will occur on. To add more then one instument select the + icon to the right.

Once all configurations have been set make sure to select save at the bottom. Piping Mode There are two different ways to use piping: 4. Auto pipe on incomplete- This method will always load the piping screen and bring data into the destination instrument every time the page is loaded unless the form is marked as complete. 5. Piping Button at top- This method will place an “Initiate Data Piping” button at the top of the designated instument and only activate piping when selected.

Note: Auto piping will only run on 'Incomplete' status, and the piping button will only appear on instruments with an 'Incomplete' status. Once a record has moved from incomplete to any other status piping will not be available. The status can always be reverted to incomplete to utilize this function.

Please note that if cross project piping is used there is a risk of overwriting data in an instrument. Any record saved with data on it whether piped or not will save on that record.

Support for Repeating Instances

This module supports repeating instances in the following way: 'Unique Match Field' and 'Destination Field' settings may both (or either) be set to fields that exist in repeating instruments of the destination project.

The module cannot, however, support configurations that require the 'Alternate Source Match Field' or 'Source Field' settings to point to fields that exist in repeating instruments.

Note: Field Embedding

The Cross-Project Piping module may not work correctly when interacting with embedded fields.