Integrate CxPlanner with Power BI using the Custom Connector

Overview

How do I integrate CxPlanner project data into Power BI?

The CxPlanner Power BI Connector allows you to extract and visualize your CxPlanner project data directly in Power BI. You can build dynamic reports with live data such as tasks, checklists, asset certificates, and more.

When and why to use this

The Power BI connector is used when you want to create custom dashboards and visualizations from your CxPlanner data.

Use it when:

• You want detailed reporting on project tasks, QA checklists, asset management, etc.
• You need to join data across modules like users, tasks, and checklists

The system:

• Fetches data via CxPlanner’s API and flattens complex JSON for easy report building
• Supports filtering, pagination, and module-specific queries

Limitations:

• Requires manual setup in Power BI Desktop
• Only accessible to users with API access and proper roles

How to - step by step

1. Prepare your environment

• Install the latest version of Power BI Desktop
• Request or generate your CxPlanner API key

2. Download and install the connector

1. Download the Connector.pq file
2. Move it to this folder:

%USERPROFILE%\Documents\Power BI Desktop\Custom Connectors\

3. If the folder doesn't exist, create it manually

[PICTURE SHOULD BE ADDED]

4. Open Power BI Desktop
5. Navigate to: File → Options and settings → Options → Security → Data Extensions
6. Select: Allow any extension to load without validation or warning
7. Restart Power BI Desktop

3. Connect to CxPlanner

1. Get Data → More → Other → CxPlanner Connector
2. Enter the following when prompted:

• Base URL: https://app.cxplanner.com
• Project ID: e.g. 12345
• API Key: Your secure API key
• (Optional) Module: qa, assets, sitevisit, etc.

3. Choose data tables to load from the navigator

[PICTURE SHOULD BE ADDED]

Behavior and results

Supported modules and endpoints

Connector capabilities

• Automatic pagination: Fetches large datasets in chunks
• Conditional endpoints: Loads only relevant data based on parameters
• JSON flattening: Structures nested data for easy reporting
• Filtering options: Query by status, user email, checklist name

Permissions matrix

Troubleshooting

Quick facts

• Requires: Company Admin and API key
• Location: Power BI Desktop → Get Data → CxPlanner Connector
• Affects: Data imports, dashboards, analytics

Example use cases

Create a project dashboard

1. Connect to your project using Project ID
2. Load Project Tasks and Project Users
3. Create task assignments, due date charts, and workload summaries

QA reporting

1. Set Module to qa
2. Load Checklists List and Checklist Items
3. Visualize QA progress across teams or asset types

Asset compliance tracking

1. Load Assets Items, Types, and Certificates
2. Join data using Asset UUID
3. Display certificate status by asset type or category

Data model recommendations

Relationship mapping

Performance best practices

• Use selective loading to minimize data volume
• Enable incremental refresh for time-based data
• Use query folding when filtering directly from the connector

API configuration

Required parameters

Optional filters

Advanced IDs (optional)

• Checklist Template UUID
• Asset UUID / Item UUID
• Certificate UUID
• Task ID
• Folder Key or File Hash

Advanced configuration

Supported modules

• systemtestview (default)
• qa
• qc
• assets
• sitevisit

Query optimization

• Use specific UUIDs to reduce data volume
• Apply parameters for selective API loading
• Schedule refreshes for live reporting

Data modeling

• Star Schema: Ideal for KPI dashboards (Projects as center)
• Snowflake: Use for normalized reporting
• Flat Tables: Useful for ad hoc reports and exports

API rate limits and handling

Security considerations

• API keys are stored securely in Power BI credentials
• HTTPS used for all data transmission
• Connector respects CxPlanner user access controls

Support and updates

Getting help

1. Review this documentation
2. Explore CxPlanner’s API reference
3. Ask in the Power BI Community Forums
4. Contact your CxPlanner Admin

Reporting issues

Include the following:

• Power BI version
• Connector version
• Error message (include screenshots)
• Steps to reproduce
• Project ID (if possible)

Version history

License and compliance

Ensure compliance with:

• CxPlanner API Terms of Use
• Power BI licensing
• Internal company data governance policies

Updated on: 08/08/2025