Blueprint introduction

Blueprint is Data Integration new low-code connector builder that simplifies the process of creating custom connectors. With its intuitive editor interface, Blueprint allows users to build connectors using YAML, enabling seamless data migration within the Data Integration platform. Data Integration built this tool to develop and maintain connectors and data pipelines, all within your Data Integration workspace.

When to use Blueprint

Before creating a new connector with Blueprint, check if the connector you need is already available in Data Integration’s pre-built Sources library. If a suitable connector exists, you can use it directly without needing to build a new one. If the required connector is not available, Blueprint provides a straightforward solution for building custom connectors.

Blueprint is particularly ideal for connecting to HTTP APIs that expose data as JSON records with fixed endpoints. It is especially useful when working with APIs that do not have a pre-built integration in Data Integration. Blueprint also supports multi-report configurations, which let a single Blueprint generate multiple named report outputs, each targeting a different API endpoint. This means you no longer need to create separate Blueprints and sources for each type of data you want to extract from the same API.

Workflow for using Blueprint

To get started with Blueprint, follow these steps:

1. Access Blueprints
   Navigate to the left-hand sidebar in your Data Integration workspace and select Blueprints. You can view, manage, and create your Blueprints.

2. Create a new Blueprint

   • On the Blueprints page, click Add Blueprint to open the Blueprint editor.
   • You can also use YAML templates created with Data Integration Copilot feature.

3. Edit your Blueprint

   The Blueprint editor presents you with a scaffold YAML file. This serves as a template to guide you in building your custom connector. You can modify this YAML file to meet the specific requirements of the API you are connecting to.

4. Validate YAML

   After editing the YAML file, ensure its syntax and structure are valid. Use the built-in validation tools in the editor to check for errors and confirm that your Blueprint is correctly configured.

   • Fix any issues highlighted during validation before proceeding.

5. Save and use the Blueprint
   Once you have completed the customization, save your Blueprint. After saving, you can use the Blueprint file can as a Source in a Source-to-Target Flow, enabling you to integrate your custom connector into your data pipeline.