streamx / magento-connector
Magento connector for StreamX - a Digital Experience Data Mesh.
Installs: 77
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Type:magento2-component
Requires
- php: >=7.4
- ext-json: *
- ext-pcntl: *
- magento/framework: >=101.0.0
- magento/magento-composer-installer: *
- magento/module-backend: >=100.2.0
- magento/module-catalog: >=102.0.0
- magento/module-store: >=100.2.0
- php-amqplib/rabbitmq-bundle: ^2.17
- streamx/ingestion-client: 1.0.4
Requires (Dev)
- ext-curl: *
- ext-mysqli: *
- ext-simplexml: *
- phpunit/phpunit: ^9.5
- dev-main
- 1.0.23
- 1.0.22
- 1.0.17
- 1.0.16
- 1.0.14
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.5
- 1.0.4
- 1.0.2
- 1.0.1
- 1.0.0
- dev-DXP-1839-compute-indexed-prices
- dev-DXP-1568-validate-produced-JSONs-against-schema-required-by-Accelerator
- dev-DXP-1767-create-categories-from-import-file
- dev-DXP-1767-create-attributes-from-import-file
- dev-DXP-1767-import-test-products-while-setting-up-local-magento-test-env
- dev-DXP-1719-poc-of-bundle-components-products-publish
- dev-DXP-1568-async-ingestion-call
- dev-DXP-1567-implement-detecting-if-only-relevant-attribute-fields-have-changed-to-republish-products-using-them
- dev-DXP-1451-add-test-for-verifying-add-swatch-setting
- dev-nginx_test
This package is not auto-updated.
Last update: 2025-06-02 13:54:33 UTC
README
1. Install StreamX Connector in Magento
cd $MAGENTO_ROOT_DIR bin/composer require streamx/magento-connector
Note: if the command asks you for a github access token - just press ENTER
2. Perform steps to enable the Connector's modules in Magento
cd $MAGENTO_ROOT_DIR bin/magento module:enable StreamX_ConnectorCore bin/magento module:enable StreamX_ConnectorCatalog bin/magento cache:clean bin/magento cache:flush bin/magento setup:upgrade bin/magento setup:di:compile
3. Start your StreamX instance (or verify it's already running)
streamx run -f path-to-your-mesh-file
You can find a basic mesh file at src/catalog/test/resources/mesh.yaml
4. Enable and configure StreamX Connector via the Magento Admin page
- Click on
STORES
on the left panel - Click
Configuration
in theSettings
area - Expand
STREAMX
section, click onConnector
item, then expandGeneral Settings
section on the right - Select
Yes
for theEnable StreamX Connector
setting and click theSave Config
button - Switch Scope to website and select stores on the
List of stores to reindex
- Expand
StreamX Ingestion Settings
section below - Edit the settings you need, or leave the default values
- Click the
Save Config
button - You can also provide separate values for
StreamX Ingestion Settings
for each store
5. Verify the Connector by indexing and publishing all categories to StreamX
cd $MAGENTO_ROOT_DIR bin/magento indexer:reindex streamx_category_indexer
6. Verify if the data has been published to StreamX
If you used the src/catalog/test/resources/mesh.yaml
to set up your local StreamX instance,
you can verify if the categories were successfully published to StreamX.
To do so, open your StreamX instance's Web Delivery Service endpoint in a web browser and verify the JSON output at a category URL. Sample URL for Category with ID 6 is: http://localhost:8081/cat:6 Note: if you used a different Mesh Yaml file, the URL will be different.