Power BI to REDCap Custom Connector

This repository contains a custom Power BI data connector that enables integration with a REDCap installation. This connector supports all REDCap project types, including:

• Classic and longitudinal projects
• Projects with repeating instruments and repeating events
• Projects with Data Access Groups (DAGs)
• Projects with survey fields

This connector uses the REDCap API to securely retrieve project data directly into Power BI for analysis and visualisation.

Features

• Connects to any REDCap instance with API access enabled
• Supports raw or label formats for both data and headers
• Handles checkbox fields, survey metadata, and DAGs
• Optional filtering by fields, forms, and events
• Works with Power BI Desktop and Power BI Service (with gateway)

Required Parameters

When connecting Power BI to REDCap, you must provide the following parameters:

Parameter	Description	Accepted Values
REDCap URL	Base URL of your REDCap installation (must start with HTTPS)	https://...
Project API Token	API token generated from the REDCap project	String
Data Format	Format of exported data values	raw or label
Header Format	Format of column headers	raw or label
Export Checkbox Labels	Export checkbox labels instead of coded values	true or false
Export Survey Fields	Include survey-related fields	true or false
Export Data Access Groups	Include Data Access Group information	true or false

Optional Parameters

You may optionally restrict the export using the following parameters:

Parameter	Description
Fields	Comma-separated list of REDCap field names
Forms	Comma-separated list of REDCap instruments
Events	Comma-separated list of event names (for longitudinal projects)

If optional parameters are not provided, all available data will be returned.

Example Connection

REDCap_URL: https://redcap.example.org/api/
API_Token: ABC123XYZ
rawOrlabel (Data Format): raw
rawOrlabel_Headers (Header Format): label
exportCheckboxLabel: true
exportSurveyFields: false
exportDataAccessGroups: true
Fields: age,gender,visit_date
Forms: demographics,follow_up
Events: baseline_arm_1

Installing and Enabling the Custom Connector

Step 1: Copy the Connector File

1. Build or download the .mez file for the connector.
2. Copy the file to the following directory on your machine:

Windows

[Documents]\Microsoft Power BI Desktop\Custom Connectors

If the folder does not exist, create it manually.

Step 2: Enable Custom Connectors in Power BI Desktop

1. Open Power BI Desktop
2. Go to File → Options and settings → Options
3. Select Security
4. Under Data Extensions, choose one of the following:
   • Allow any extension to load (not recommended)
   • Allow only extensions with a valid certificate (recommended for production)
5. Restart Power BI Desktop

Step 3: Connect to REDCap

1. In Power BI Desktop, select Get Data
2. Search for the REDCap_Connector (Beta)(Custom) connector
3. Enter the required parameters
4. Authenticate when prompted (API token is passed as a parameter)

Microsoft Links

• How to load custom connectors in Power BI
• How to enable and use custom connectors in Power BI service (online)