API Report Using DataConnect Designer

How to Create a Custom API Report Using DataConnect Designer

Overview

This guide walks through the process of creating a custom API report using Ellucian's DataConnect Designer. Follow these steps to generate a reusable API endpoint based on your SQL query.

Step-by-Step Instructions

1. Prepare Your Insights Report

Ensure your Insights Report is ready for conversion.

2. Access DataConnect Designer

Navigate to the DataConnect Designer interface:

3. Create a New Pipeline

1. Navigate to the 'Insights Reports' package
2. Click '+ Pipeline' to create a new pipeline

Naming Convention

(Example: student-enrollment-report)

• Use this format for your pipeline name:
  • All lowercase
  • Words separated by dashes
  • Singular words only

4. Configure Pipeline Settings

• HTTP Method: GET
• Authentication Type: Ethos Token
• Description: Add a descriptive explanation of your report's purpose

5. Import Pipeline Template

1. Click the Pipeline tab
2. Find your report name in the top middle section
3. Click the down arrow next to your report name
4. Select 'Import Pipeline'
5. Import the pipeline file attached to this article

6. Configure SQL Query

1. Click the first Extract Data fitting in your pipeline
2. Paste your SQL query into the SQL box

7. Test Your Pipeline

1. Click 'Save' at the top
2. Click 'Test'
3. Click 'Run Test'
4. Verify results return in JSON format

8. Finalize and Publish

1. Click 'Cancel' after testing
2. Click 'Publish'
   • First-time publication will use version 'Major 1.0.0'
   • This version number will be important for future updates

Key Notes

• The version number will be visible in your package
• This creates a custom API endpoint for your report
• Ensure your SQL query is properly formatted and tested