Before You Begin
CAUTION Contact your Pimcore administrator or IT department for assistance or to perform the procedures in this section. |
Phase 1: Installation & Activation
NOTE: You will need command-line access (SSH) to your Pimcore server to run these commands. |
Install the Bundle via Composer: Run the following command in your project root directory:
composer require pimcore/data-hubEnable the Bundle: Register the bundle in your Pimcore configuration:
bin/console pimcore:bundle:enable PimcoreDataHubBundleInstall the Bundle (Database Setup): This creates the necessary database tables (like
pimcore_data_hub_configuration):
bin/console pimcore:bundle:install PimcoreDataHubBundleReload your Pimcore Admin Interface. You should see a new Datahub icon in the left sidebar.
Phase 2: User Permissions (Admin Access)
Before you can configure Datahub, your user account needs the right permissions to see the Datahub panel.
Go to Settings > Users & Roles > Users.
Select your user (or the admin user you are using).
Click the Permissions tab.
Scroll down to the bundle or plugin section and check the box for:
plugin_datahub_config
This allows you to create and edit Datahub configs.
Save the user. Reload the page if the icon doesn't appear immediately.
Phase 3: Creating a Configuration
Define what data is exposed and how external apps access it.
Click the Datahub icon in the sidebar.
Click Add Configuration > GraphQL, standard for most integrations.
Give it a name, such as
iPaaS-connectionorexternal-integration-app.
A. General Settings
Active: Check this to enable the endpoint.
Endpoint: This will show you the URL you will use later, e.g.
, https://your-domain.com/pimcore-graphql-webservices/webshop-connector.
B. Schema Configuration
You must explicitly allow which data objects can be seen. By default, nothing is exposed.
Click Add Schema Definition.
Entities: Choose the Object Classes (e.g., Product, Category) you want to expose.
Condition: Leave blank to expose all, or add a filter.
Field Selection: You will see a list of all fields in that Class.
Query (Read): Check the fields you want the external app to be able to read.
Mutation (Write): Check the fields you want the external app to be able to update/write.
NOTE: If you don't check these, the external app will receive empty data for those fields. |
C. Security Definitions (API Access)
Generate the API Key specifically for this integration.
Click the Security Definitions tab.
Click Add.
Give it a Name(e.g., AppUser).
At Authentication, select API Key.
Click Generate Token. Copy this token immediately. You will use this later when configuring the subscription.
In Workspaces, you must define where this key is allowed to look.
Drag and drop your Product folder into the Data Objects row.
Set permissions (Read/Create/Save/Publish). If you don't do this, the API key will connect successfully but return Access Denied or empty lists for all queries.
Phase 4: iPaaS-Specific Integration Configuration
Data Mapping
Map Pimcore objects to iPaaS types:
Product Category > iPaaS Product Category
Product > iPaaS Product
Assignments, Related Products, Variants (only direct children supported)
Ensure all required system fields (ID, classname) are included.
GraphQL Query & Fields
Include only top-level entities (Product, Product Category).
Expose required fields for iPaaS integration.
Notes on Variants:
|
API Key Usage
Ensure the API key has access to the correct workspace paths.
Keep introspection enabled during integration for field discovery; disable later if needed.
Installation Instructions for Integration Setup
Go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Pimcore integration tile
Click the Subscribe button.
Enter the Name of the subscription and select a Version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Pimcore – Release
Select Create Default Mappings (recommended). If you don’t want to create default mappings and want to create all mappings by yourself, then uncheck this box.
Enter the Variant Dimension Fields, a comma-separated list that distinguishes one variant from another variant. For example, if you are selling dog sweaters, dimensions might be size, color, or material.
Enter the Variant Related Product Class, the Pimcore class used to link/relate variants to other products, often used in cross-selling or up-selling. For example, Accessory, CrossSellProduct, etc.
Enter the Variant Category Assignment Class Names, a relation object Pimcore uses to assign a category instead of a direct link, for example, CategoryAssignment.
Enter the Related Product Class Names, a comma-separated list which defines related products, such as Accessories, spareParts, etc.
Enter the Variant Parent Field, which identifies the parent product of a variant. For example, parentID or mainProduct.
Enter the Variant Class Names, the name of the Pimcore class used to create Variants. They can be the same class as the main product, Shoe, but they can be distinct, such as ShoeCasual.
Enter the Product Category Assignment Class Names, which define which object class is used to link a product to a category, for example, ProductCategoryRelation.
Enter the Product Category Class Names, a comma-separated list of the Pimcore class names used to define your category, for example, Dog, Cat, Treats.
Enter the Product Class Names, a comma-separated list of classes configured for a product. For example, Collars, Leashes, Halters.
Enter the Datahub Config, the configuration name or ID of the Pimcore Datahub. This is the configuration profile used to talk to the Pimcore API. For example, iPaaS-connection.
Enter the API Key
Enter the API URL endpoint for your Pimcore subscription. For example:
Production:
https://api.ltlp.kuehne-nagel.com/api
Enter the CDN
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that the subscription can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
Data Sync Test
Initiate a sample data pull. (To iPaaS.com).
Initiate a sample data push. (From iPaaS.com).
Functionality Test
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.