vendure-data-hub-plugin
User Guide
This guide covers using the Data Hub Admin UI to create and manage data pipelines.
Visual Pipeline Editor - Drag-and-drop interface for building data pipelines
Contents
- Creating Pipelines - Build and edit pipelines with the visual editor
- Import/Export Wizards - Step-by-step guide to data import and export wizards
- Advanced Recipes - Real-world pipeline examples and patterns
- Managing Connections - Set up database and API connections
- Secrets Management - Store API keys and credentials securely
- Scheduling Pipelines - Automate pipeline execution
- Monitoring & Logs - Track runs and debug issues
- Product Feeds - Generate feeds for Google, Meta, and more
- Queue & Messaging - Consume from and produce to message queues
- External Integrations - Search engines, webhooks, and external APIs
Accessing Data Hub
- Log in to the Vendure Admin UI
- Click Data Hub in the left navigation menu
- You’ll see the main dashboard with pipeline overview
Dashboard Overview
The Data Hub dashboard shows:
- Active Pipelines - Pipelines currently enabled
- Recent Runs - Latest pipeline executions
- Failed Records - Records requiring attention
- Upcoming Schedules - Next scheduled runs
Navigation
| Section | Purpose |
|---|---|
| Pipelines | Create, edit, run pipelines |
| Runs | View execution history and logs |
| Connections | Manage external system connections |
| Secrets | Store sensitive credentials |
| Errors | Review and retry failed records |
| Analytics | View performance metrics |
| Settings | Configure plugin options |
Required Permissions
To use Data Hub, your admin role needs these permissions:
| Action | Permission Required |
|---|---|
| View pipelines | ReadDataHubPipeline |
| Create/edit pipelines | CreateDataHubPipeline, UpdateDataHubPipeline |
| Run pipelines | RunDataHubPipeline |
| View run history | ViewDataHubRuns |
| Manage connections | ManageDataHubConnections |
| Manage secrets | CreateDataHubSecret, ReadDataHubSecret |
| Configure settings | UpdateDataHubSettings |
Ask your administrator to assign these permissions if you don’t have access.