From 4ecd70520ec7d6863a784a447205a8dbd20be416 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Fri, 13 Oct 2023 14:07:03 +0200 Subject: [PATCH 1/3] Data Exchange landing page and FAQ --- .../202311.0/data-exchange-faq.md | 42 ++++++ .../data-exchange/202311.0/data-exchange.md | 136 ++++++++++++++++++ 2 files changed, 178 insertions(+) create mode 100644 docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md create mode 100644 docs/pbc/all/data-exchange/202311.0/data-exchange.md diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md b/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md new file mode 100644 index 00000000000..2dc06330da6 --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md @@ -0,0 +1,42 @@ +--- +title: Data Exchange FAQ +description: +template: concept-topic-template +--- +## Spryker Middleware powered by Alumio + +**How can I understand where data is stuck? How can I rectify issues that occurred during an integration run?** + +When data is not successfully processed via Alumio the specific Task (which contains the data) will be set to “Failed”. This allows you to easily spot via the Alumio dashboard which Tasks were not completed. You can also filter on this. The reason for failing can be found in either the “Import” or the “Export” logs of a Task (detail page of a Task). These logs will give clarity on why the import or export of data failed – and allow you to find the cause very fast. Besides that, in our latest version of Alumio we’ve made it possible to export Tasks (i.e. all failed tasks) to a CSV-file. This way other parties without access to Alumio can also analyse the data. + +**How can I get notified of any issues?** +There are multiple types of alerts via email within Alumio. On the following pages on our forum you can find more detailed information: + +[Alerts for Incoming Configurations](https://forum.alumio.com/t/alerts-for-incoming-configurations/355) + +[Alerts for Route Configurations](https://forum.alumio.com/t/alerts-for-route-configurations/357) + +**What is the performance of Alumio? Is there any overhead that Alumio adds?** + +On the following page on our website you can find detailed statistics regarding the performance of Alumio: https://www.alumio.com/performance/reports . Alumio does add a very small amount of overhead, as processing the data takes effort. And the more data transformations you perform in Alumio, the more overhead you add. But this overhead without any transformations of data is very minimum (milliseconds per Task). + +**What do I need to connect Spryker Middleware powered by Alumio to Spryker Cloud Commerce OS?** +On your Alumio platform you just need to create an HTTP Client by selecting Spryker Data Exchange API. + +Also, on your Spryker Cloud Commerce OS platform you need to have installed the latest[ Data Exchange API modules integration](https://docs.spryker.com/docs/scos/dev/feature-integration-guides/202307.0/glue-api/dynamic-data-api/data-exchange-api-integration.html). + + +## Data Exchange API + +**What is the difference between Backend API and (Dynamic) Data Exchange API?** + +The difference between Backend API & Data Exchange API is that: + +The Backend API is a resource/route based development driven API endpoints that serve a specific business logic purpose (like set calculate order totals or manage PIM data). + +On the other hand, the Data Exchange API is a REST API abstraction over our database tables that provide an easy (yet secure) access to our data model directly with higher levels of performance that is managed with no development efforts needed via UI or configuration files. + + +**Can the Data Exchange API be used without Spryker Middleware powered by Alumio?** + +Yes, it can. The Data Exchange API is part of Spryker Cloud Commerce (SCCOS) core and it's not dependent on any middleware. It can be used by any middleware, application service, etc. to exchange data with SCCOS. diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange.md b/docs/pbc/all/data-exchange/202311.0/data-exchange.md new file mode 100644 index 00000000000..c08e030cece --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange.md @@ -0,0 +1,136 @@ +--- +title: Data Exchange +description: +template: concept-topic-template +--- + +Data Exchange refers to the process of transferring data between Spryker and third-party systems. Spryker offers various solutions to facilitate data exchange between a Spryker-based solution and third-party systems, ensuring compatibility, consistency, quality, and security of your data. + +Spryker offers the following options to import and export data: + +- Data Importers and Data Exporters: available in SCCOS by default. +- Data Exchange API: available in SCCOS by default. +- Spryker Middleware powered by Alumio: + - Spryker Integration Apps + - Custom integrations using the existing Alumio connectors + - Custom integration apps using the SDK to build own connectors + + +## Data Importers and Data Exporters + +For information on how data importers and exporters work, see [Data import](/docs/scos/dev/data-import/202307.0/data-import.html) and [Data export] (/docs/scos/dev/data-export/202307.0/data-export.html). + +## Data Exchange API + +Data Exchange API is a dynamic database API that facilitates data transfer in real time, ensuring data is always current across all integrated platforms. It is part of the Spryker Cloud Commerce OS platform core. + +Data Exchange API lets you build, customize, and manage APIs tailored to your specific business requirements through an intuitive user interface. + +The main benefits of the Data Exchange API include the following: + +- No coding is required: The API endpoints are created from the user interface. +- Rapid API generation: The APIs are generated within minutes. +- Flexibility and customization: You can tailor APIs to your needs. You can define parameters to ensure compatibility with your systems. +- Real-time updates: The infrastructure supports dynamic changes, so you can modify APIs on the fly. +- Security and Access Control: The infrastructure incorporates strong security measures and access controls, which safeguards sensitive information. + + +We recommend considering the Data Exchange API in the following cases: + +- You want to implement a data integration via API with another middleware that is not Alumio. +- You want to create your own data integration engine via API, without using any middleware software. + +## Spryker Middleware Powered by Alumio + +The Spryker Middleware powered by Alumio is a cloud-based integration Platform as a Service (iPaaS). It lets you exchange data between your Spryker system and third-party systems via a user-friendly interface. +The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To obtain it, reach out to [Spryker support](https://spryker.com/support/). + +With the Spryker Middleware powered by Alumio, the data exchange process looks like this: + +1. Transfer of data from the source system via the API connector. The data is transferred in real time, which ensures that the data is always current across all integrated platforms. +2. Data is fed into Alumio and transformed there. +3. Transfer of data to the target system via the API connector. + +For more details about the Spryker Middleware Powered by Alumio, see [LINK]. + +The Spryker Middleware Powered by Alumio is the foundation of the Spryker Integration Apps. You can also use it to build custom integrations. + +### Spryker Integration Apps + +The Integration Apps let you import data between your Spryker system and third-party systems without any development effort and without the need to configure mapping and transformation of data, as the configurations are preset. + +To exchange data between a Spryker system and a third-party system with an Integration App, you need to do the following: + +- Provision the Spryker Middleware Powered by Alumio. +- Provision the Spryker Integration Apps you need. +- Make minimum adjustments to the existing mapping and transformation of data. + +Reach out to [Spryker support](https://spryker.com/support/) with the request regarding the Spryker Middleware Powered by Alumio and the Integration Apps. + +We recommend considering Integration Apps for data exchange in the following cases: + +- You require a quick setup of the data exchange process, which should take up to a few hours. +- You need a pre-configured mapping and transformation of data for exchange between Spryker and a third-party system so you would have to make minimum adjustments. +- For your project, it is important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. + +With the Spryker Integration Apps, the data exchange process like this: + +Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_86 + +
+ + +Spryker provides Early Access to the [Akeneo PIM Integration App](LINK). This Integration App allows for product import from Akeneo to Spryker. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or product are created in Akeneo, they are transformed in the Alumio middleware before the data is transferred to Spryker via the Spryker Middleware Powered by Alumio. + +The middleware allows customers to configure data that is to be transferred to Spryker. For example, attributes and super attributes. + +{% info_block infoBox "Info" %} + +Akeneo handles the so-called “cold data”. Cold data is product information directly linked to the product that describes product properties. The Akeneo PIM Integration App does not include the transfer of “hot data” such as stock or pricing. + +{% endinfo_block %} + +For details on how to import data from Akeneo to Spryker, see [Configure Akeneo PIM integration app](LINK). + +### Custom Integration Apps with Alumio connectors + +In cases where there are no integration apps for data exchange, you can build them yourself using the Spryker Alumio Middleware. Alumio provides a number of built-in API connectors to third-party systems that you can use to build integrations between these systems and Spryker. Check the available connectors for Spryker on the [Alumio web-site](https://www.alumio.com/platforms/spryker). + +With Custom Integration Apps, the data exchange process like this: + +Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_124 + +
+ + + +We recommend building custom integrations with the existing Alumio connectors in the following cases: +- There is no Spryker Integration App for the system you need. However, Alumio offers a connector for this system. +- You require a quick setup of the data exchange process, which should take up to a few days. +- You don't have the developer resources to do the coding job upon initial setup. +- You don't have the developer resources to do the coding job when you need to update mapping or configuration settings. +- You have a tech-savy person who can configure mapping of data for exchange between Spryker and a third-party system. +- For your project, it is important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. + +For more details on how to manage integrations and exchange data in the Alumio platform, see QUESTION: WHAT LINK TO ALUMIO DOCUMENTATION SHOULD WE PROVIDE HERE? + +### Custom Integration Apps with custom connectors + +If you have legacy systems or systems of old versions with which you need to exchange data and for which Alumio does not provide a connector, you can still build you integration apps. You can build a connector to these systems, as Spryker Middleware Powered by Alumio includes an SDK to build own connectors. + +To build an integration app for a legacy system, you need: + +1. Provision the Spryker Middleware Powered by Alumio. +2. Build a connector to the legacy system using the SDK from the Spryker Middleware Powered by Alumio. Building a connector with SDK usually takes up to a few weeks. +3. Build the mapping and transformation of data. Initial configuration of data mapping and transformation usually takes up to a few days, changing them takes up to a few hours. + +With the Integration Apps with custom connectors, the data exchange process like this: + +Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_140 + +
+ + +We recommend building Custom Integration Apps with the connectors created using the SDK in cases when Alumio does not have the connectors to the system with which you want to exchange data. Even though you need a developer to build a connector for such systems, this solution is still faster and in the long term more cost-efficient than, for example, the default data importer and exporters. + +QUESTION: DO WE PROVIDE DOCUMENTATION ON HOW TO BUILD THE CONNECTORS WITH THE SDK? \ No newline at end of file From 66dbc65c491c04e46e98b54f1c08e1f674a184a8 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Mon, 16 Oct 2023 11:55:54 +0200 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: MonicaSilva <47432712+monicabrassilva@users.noreply.github.com> --- .../202311.0/data-exchange-faq.md | 20 +++++-- .../data-exchange/202311.0/data-exchange.md | 59 +++++++++++-------- 2 files changed, 49 insertions(+), 30 deletions(-) diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md b/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md index 2dc06330da6..3c8f0248669 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md @@ -12,19 +12,29 @@ When data is not successfully processed via Alumio the specific Task (which cont **How can I get notified of any issues?** There are multiple types of alerts via email within Alumio. On the following pages on our forum you can find more detailed information: -[Alerts for Incoming Configurations](https://forum.alumio.com/t/alerts-for-incoming-configurations/355) +- [Alerts for Incoming Configurations](https://forum.alumio.com/t/alerts-for-incoming-configurations/355) -[Alerts for Route Configurations](https://forum.alumio.com/t/alerts-for-route-configurations/357) + +- [Alerts for Route Configurations](https://forum.alumio.com/t/alerts-for-route-configurations/357) **What is the performance of Alumio? Is there any overhead that Alumio adds?** On the following page on our website you can find detailed statistics regarding the performance of Alumio: https://www.alumio.com/performance/reports . Alumio does add a very small amount of overhead, as processing the data takes effort. And the more data transformations you perform in Alumio, the more overhead you add. But this overhead without any transformations of data is very minimum (milliseconds per Task). **What do I need to connect Spryker Middleware powered by Alumio to Spryker Cloud Commerce OS?** + On your Alumio platform you just need to create an HTTP Client by selecting Spryker Data Exchange API. Also, on your Spryker Cloud Commerce OS platform you need to have installed the latest[ Data Exchange API modules integration](https://docs.spryker.com/docs/scos/dev/feature-integration-guides/202307.0/glue-api/dynamic-data-api/data-exchange-api-integration.html). + ## Integration Apps + + **What is the difference between an Alumio Connector and an Integration App?** + +An Alumio connector allows to establish connectivity between a data source (e.g. an external system) and the Alumio platform (Spryker Middleware powered by Alumio), it doesn't contain any business logic nor transforms data. + +While an Integration Apps is a pre-built integration to integrate popular platforms with Spryker Cloud Commerce OS, reducing the time and complexity of setting up new data exchange pathways (usually includes business logic, data mapping and, data transformation). + ## Data Exchange API @@ -32,9 +42,11 @@ Also, on your Spryker Cloud Commerce OS platform you need to have installed the The difference between Backend API & Data Exchange API is that: -The Backend API is a resource/route based development driven API endpoints that serve a specific business logic purpose (like set calculate order totals or manage PIM data). +- The Backend API is a resource/route based development driven API endpoints that serve a specific business logic purpose (like set calculate order totals or manage PIM data). + + +- On the other hand, the Data Exchange API is a REST API abstraction over our database tables that provide an easy (yet secure) access to our data model directly with higher levels of performance that is managed with no development efforts needed via UI or configuration files. -On the other hand, the Data Exchange API is a REST API abstraction over our database tables that provide an easy (yet secure) access to our data model directly with higher levels of performance that is managed with no development efforts needed via UI or configuration files. **Can the Data Exchange API be used without Spryker Middleware powered by Alumio?** diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange.md b/docs/pbc/all/data-exchange/202311.0/data-exchange.md index c08e030cece..9f57eabb348 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange.md @@ -8,12 +8,12 @@ Data Exchange refers to the process of transferring data between Spryker and thi Spryker offers the following options to import and export data: -- Data Importers and Data Exporters: available in SCCOS by default. -- Data Exchange API: available in SCCOS by default. +- Data Importers and Data Exporters: available in SCCOS by default +- Data Exchange API: available in SCCOS by default - Spryker Middleware powered by Alumio: - Spryker Integration Apps - Custom integrations using the existing Alumio connectors - - Custom integration apps using the SDK to build own connectors + - Custom integration apps using the Alumio SDK to build your own connectors ## Data Importers and Data Exporters @@ -53,7 +53,7 @@ With the Spryker Middleware powered by Alumio, the data exchange process looks l For more details about the Spryker Middleware Powered by Alumio, see [LINK]. -The Spryker Middleware Powered by Alumio is the foundation of the Spryker Integration Apps. You can also use it to build custom integrations. +The Spryker Middleware Powered by Alumio is the foundation of the Spryker Integration Apps. You can use it also to build custom integrations. ### Spryker Integration Apps @@ -61,17 +61,17 @@ The Integration Apps let you import data between your Spryker system and third-p To exchange data between a Spryker system and a third-party system with an Integration App, you need to do the following: -- Provision the Spryker Middleware Powered by Alumio. -- Provision the Spryker Integration Apps you need. +- Have a user account on Spryker Middleware Powered by Alumio +- Have the Integration App you need deployed in the Spryker Middleware powered by Alumio platform - Make minimum adjustments to the existing mapping and transformation of data. -Reach out to [Spryker support](https://spryker.com/support/) with the request regarding the Spryker Middleware Powered by Alumio and the Integration Apps. +Reach out to [Spryker support](https://spryker.com/support/) or to your Customer Success Manager if you need access to the Spryker Middleware Powered by Alumio and the Integration App. We recommend considering Integration Apps for data exchange in the following cases: - You require a quick setup of the data exchange process, which should take up to a few hours. - You need a pre-configured mapping and transformation of data for exchange between Spryker and a third-party system so you would have to make minimum adjustments. -- For your project, it is important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. +- For your project, it is important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, health monitoring, etc. With the Spryker Integration Apps, the data exchange process like this: @@ -80,9 +80,9 @@ Note to PMs: Here is a draw.io diagram created from image here: https://docs.goo
-Spryker provides Early Access to the [Akeneo PIM Integration App](LINK). This Integration App allows for product import from Akeneo to Spryker. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or product are created in Akeneo, they are transformed in the Alumio middleware before the data is transferred to Spryker via the Spryker Middleware Powered by Alumio. +Spryker provides Early Access to the [Akeneo PIM Integration App](LINK). This Integration App allows to import products from Akeneo PIM to Spryker Cloud Commerce OS. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or products are created or updated in Akeneo, they are transformed in the Alumio platform before the data is transferred to the Spryker Cloud Commerce OS. -The middleware allows customers to configure data that is to be transferred to Spryker. For example, attributes and super attributes. +The middleware allows customers to configure data that is to be transferred to Spryker, for example, attributes and super attributes. {% info_block infoBox "Info" %} @@ -92,11 +92,11 @@ Akeneo handles the so-called “cold data”. Cold data is product information d For details on how to import data from Akeneo to Spryker, see [Configure Akeneo PIM integration app](LINK). -### Custom Integration Apps with Alumio connectors +### Custom integrations with Alumio connectors -In cases where there are no integration apps for data exchange, you can build them yourself using the Spryker Alumio Middleware. Alumio provides a number of built-in API connectors to third-party systems that you can use to build integrations between these systems and Spryker. Check the available connectors for Spryker on the [Alumio web-site](https://www.alumio.com/platforms/spryker). +In cases where there are no integration apps for data exchange with the third-party system you need, you can build them yourself using the Alumio platform. Alumio provides a number of built-in API connectors to third-party systems that you can use to build integrations between these systems and Spryker. Check the available connectors for Spryker on the [Alumio web-site](https://www.alumio.com/platforms/spryker). -With Custom Integration Apps, the data exchange process like this: +With custom integrations, the data exchange process looks like this: Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_124 @@ -105,32 +105,39 @@ Note to PMs: Here is a draw.io diagram created from image here: https://docs.goo We recommend building custom integrations with the existing Alumio connectors in the following cases: -- There is no Spryker Integration App for the system you need. However, Alumio offers a connector for this system. +- There is no Spryker Integration App for the system you need to integrate with. However, Alumio offers a connector for this system. - You require a quick setup of the data exchange process, which should take up to a few days. -- You don't have the developer resources to do the coding job upon initial setup. -- You don't have the developer resources to do the coding job when you need to update mapping or configuration settings. -- You have a tech-savy person who can configure mapping of data for exchange between Spryker and a third-party system. +- You have a tech-savy user who can configure mapping of data for exchange between Spryker and a third-party system. - For your project, it is important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. -For more details on how to manage integrations and exchange data in the Alumio platform, see QUESTION: WHAT LINK TO ALUMIO DOCUMENTATION SHOULD WE PROVIDE HERE? +For more details on how to manage integrations and exchange data in the Alumio platform, see: +- [The Basic Parts Of A Connector Package In Alumio] (https://support.alumio.com/support/solutions/articles/80001031213-the-basic-parts-of-a-connector-package-in-alumio) +- [How To Use The Alumio Connector Packages](https://forum.alumio.com/t/how-to-use-the-alumio-connector-packages/219) +- Alumio keeps here up-to-date the list of their standard Connector Packages [Latest iPaaS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27) + +### Custom integrations with custom connectors +Before starting to implement any custom connector: +- Double check if the connector with the third-party system you want to integrate with is in the list of existing Alumio standard connectors: [Alumio iPaasS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27) - this list is updated continuously -### Custom Integration Apps with custom connectors +- If the system you wish to integrate with is not on the list, you may always submit a request to implement a standard connector, and see if it aligns with your timelines. Check here how to do it: [How do I request a new connector package?](https://forum.alumio.com/t/how-do-i-request-a-new-connector-package/148) -If you have legacy systems or systems of old versions with which you need to exchange data and for which Alumio does not provide a connector, you can still build you integration apps. You can build a connector to these systems, as Spryker Middleware Powered by Alumio includes an SDK to build own connectors. +If you have legacy systems or old version systems with which you need to exchange data, and for which Alumio does not provide a connector, you can still build your own connector to these systems, as Alumio platform includes an Alumio SDK to build your own connectors. -To build an integration app for a legacy system, you need: +To build a data integration for a legacy system, you need: -1. Provision the Spryker Middleware Powered by Alumio. -2. Build a connector to the legacy system using the SDK from the Spryker Middleware Powered by Alumio. Building a connector with SDK usually takes up to a few weeks. +1. Have a user account on Spryker Middleware powered by Alumio +2. Build a connector to the legacy system using the Alumio SDK. Building a connector with the Alumio SDK usually takes up to a few weeks. 3. Build the mapping and transformation of data. Initial configuration of data mapping and transformation usually takes up to a few days, changing them takes up to a few hours. -With the Integration Apps with custom connectors, the data exchange process like this: +With the data integration with custom connectors, the data exchange process looks like this: Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_140
-We recommend building Custom Integration Apps with the connectors created using the SDK in cases when Alumio does not have the connectors to the system with which you want to exchange data. Even though you need a developer to build a connector for such systems, this solution is still faster and in the long term more cost-efficient than, for example, the default data importer and exporters. +We recommend building custom integrations with the connectors created using the Alumio SDK, in cases where Alumio does not have the connectors to the system you want to exchange data with. Even though you need a developer to build a connector for such systems, most of the times this solution is still faster and in the long term more cost-efficient than, for example, using the default data importer and exporters. + -QUESTION: DO WE PROVIDE DOCUMENTATION ON HOW TO BUILD THE CONNECTORS WITH THE SDK? \ No newline at end of file +**How to build Alumio connectors with the Alumio SDK?** +Check Alumio documentation for more information: https://forum.alumio.com/t/creating-alumio-connector-packages/252 From 61d53b02e2fc296a42e2f115417497a85166682d Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Tue, 17 Oct 2023 11:51:14 +0200 Subject: [PATCH 3/3] finalizing the docs --- Rakefile | 1 + _config.yml | 2 + _data/sidebars/pbc_all_sidebar.yml | 27 ++++++ ...change-api-inventory-management-feature.md | 2 +- .../install-the-data-exchange-api.md | 18 +--- .../202311.0/data-exchange-faq.md | 34 ++++---- .../data-exchange/202311.0/data-exchange.md | 82 +++++++++---------- ...change-api-inventory-management-feature.md | 10 +++ .../install-the-data-exchange-api.md | 16 ++++ .../how-to-configure-data-exchange-api.md | 3 +- ...ow-to-send-request-in-data-exchange-api.md | 1 + ...change-api-inventory-management-feature.md | 8 -- 12 files changed, 116 insertions(+), 88 deletions(-) rename _includes/pbc/all/install-features/{202400.0 => 202311.0}/install-the-data-exchange-api-inventory-management-feature.md (97%) rename {docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api => _includes/pbc/all/install-features/202311.0}/install-the-data-exchange-api.md (96%) create mode 100644 docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md create mode 100644 docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api.md rename docs/{scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides => pbc/all/data-exchange/202311.0/tutorials-and-howtoes}/how-to-configure-data-exchange-api.md (97%) rename docs/{scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides => pbc/all/data-exchange/202311.0/tutorials-and-howtoes}/how-to-send-request-in-data-exchange-api.md (99%) delete mode 100644 docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api-inventory-management-feature.md diff --git a/Rakefile b/Rakefile index 047ea96d367..eee3093c744 100644 --- a/Rakefile +++ b/Rakefile @@ -176,6 +176,7 @@ task :check_pbc do /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202307\.0\/.+/, + /docs\/pbc\/\w+\/[\w-]+\/202311\.0\/.+/, /docs\/pbc\/\w+\/[\w-]+\/202400\.0\/.+/ ] HTMLProofer.check_directory("./_site", options).run diff --git a/_config.yml b/_config.yml index afec5e8970b..890337276ca 100644 --- a/_config.yml +++ b/_config.yml @@ -158,6 +158,7 @@ versions: '202204.0': '202204.0' '202212.0': '202212.0' '202307.0': '202307.0' + '202311.0': '202311.0' '202400.0': 'Winter release' # versioned categories - these must match corresponding directories @@ -190,6 +191,7 @@ versioned_categories: - carrier-management - content-management-system - customer-relationship-management + - data-exchange - discount-management - dynamic-multistore - emails diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 921db8ac6e5..8f904871807 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -930,6 +930,33 @@ entries: nested: - title: Install the Customer Account Management + Merchant Switcher feature url: /docs/pbc/all/customer-relationship-management/marketplace/install-the-customer-account-management-merchant-switcher-feature.html + - title: Data Exchange + url: /docs/pbc/all/data-exchange/data-exchange.html + include_versions: + - "202311.0" + nested: + - title: Install and upgrade + nested: + - title: Data Exchange API + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api.html + include_versions: + - "202311.0" + - title: Data Exchange API + Inventory Management + url: /docs/pbc/all/data-exchange/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.html + include_versions: + - "202311.0" + - title: Tutorials and HowTos + nested: + - title: Configure Data Exchange API endpoints + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-configure-data-exchange-api.html + include_versions: + - "202311.0" + - title: How to send a request in Data Exchange API + url: /docs/pbc/all/data-exchange/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.html + include_versions: + - "202311.0" + - title: Data Exchange FAQ + url: /docs/pbc/all/data-exchange/data-exchange-faq.html - title: Discount Management url: /docs/pbc/all/discount-management/discount-management.html nested: diff --git a/_includes/pbc/all/install-features/202400.0/install-the-data-exchange-api-inventory-management-feature.md b/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md similarity index 97% rename from _includes/pbc/all/install-features/202400.0/install-the-data-exchange-api-inventory-management-feature.md rename to _includes/pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md index 39552df01d8..dc9df8e0de7 100644 --- a/_includes/pbc/all/install-features/202400.0/install-the-data-exchange-api-inventory-management-feature.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md @@ -10,7 +10,7 @@ Install the required features: | NAME | VERSION | INTEGRATION GUIDE | |-------------------|------------------|------------------| -| Data Exchange API | {{page.version}} | [Data Exchange API integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/dynamic-data-api/data-exchange-api-integration.html) | +| Data Exchange API | {{page.version}} | [Data Exchange API integration](/docs/pbc/all/data-exchange/{{page.version}}/install-and-upgrade/install-the-data-exchange-api.html) | | Inventory Management | {{page.version}} | [Install the Inventory Management feature](/docs/pbc/all/warehouse-management-system/202400.0/unified-commerce/install-and-upgrade/install-the-inventory-management-feature.html) | ### 1) Set up behavior diff --git a/docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api.md b/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api.md similarity index 96% rename from docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api.md rename to _includes/pbc/all/install-features/202311.0/install-the-data-exchange-api.md index f18c10725a3..f58e1b71f16 100644 --- a/docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api.md +++ b/_includes/pbc/all/install-features/202311.0/install-the-data-exchange-api.md @@ -1,17 +1,3 @@ ---- -title: Install the Data Exchange API -description: Learn how to install the Data Exchange API -last_updated: June 22, 2023 -template: feature-integration-guide-template -redirect_from: - - /docs/scos/dev/feature-integration-guides/202304.0/glue-api/data-exchange-api/data-exchange-api-integration.html - - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api-integration.html - - docs/scos/dev/feature-integration-guides/202307.0/glue-api/dynamic-data-api/data-exchange-api-integration.html -related: -- title: How to configure Data Exchange API - link: docs/scos/dev/glue-api-guides/page.version/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.html ---- - This document describes how to install the Data Exchange API. Data Exchange API is a powerful tool that enables seamless interaction with databases. You can easily access data by sending requests to a dedicated API endpoint. It lets you retrieve, create, update, and manage data in a flexible and efficient manner. @@ -26,8 +12,8 @@ Install the required features: | NAME | VERSION | INTEGRATION GUIDE | | --- | --- | --- | -| Glue Backend Api Application | {{page.version}} | [Glue API - Glue Storefront and Backend API applications integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-glue-storefront-and-backend-api-applications-integration.html) | -| Glue Authentication | {{page.version}} | [Glue API - Authentication integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/glue-api-authentication-integration.html) | +| Glue Backend Api Application | {{page.version}} | [Glue API - Glue Storefront and Backend API applications integration](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-storefront-and-backend-glue-api-applications.html) | +| Glue Authentication | {{page.version}} | [Glue API - Authentication integration](/docs/scos/dev/migration-concepts/migrate-to-decoupled-glue-infrastructure/decoupled-glue-infrastructure-integrate-the-authentication.html) | ### Install the required modules diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md b/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md index 3c8f0248669..ebe0ba08df1 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md @@ -7,48 +7,42 @@ template: concept-topic-template **How can I understand where data is stuck? How can I rectify issues that occurred during an integration run?** -When data is not successfully processed via Alumio the specific Task (which contains the data) will be set to “Failed”. This allows you to easily spot via the Alumio dashboard which Tasks were not completed. You can also filter on this. The reason for failing can be found in either the “Import” or the “Export” logs of a Task (detail page of a Task). These logs will give clarity on why the import or export of data failed – and allow you to find the cause very fast. Besides that, in our latest version of Alumio we’ve made it possible to export Tasks (i.e. all failed tasks) to a CSV-file. This way other parties without access to Alumio can also analyse the data. +When data isn't processed successfully via Alumio, the specific task which contains the data will be set to “Failed”. This feature allows you to identify incomplete tasks through the Alumio dashboard. You can also filter tasks by this status. The reason for the failure can be located in the task detail page, within either the *Import* or *Export* logs. These logs provide insights into why the data import or export failed and allow you to find the cause. Additionally, the latest version of Alumio allows you to export tasks, specifically all failed tasks, to a .CSV file. This way, other parties without access to Alumio can also analyze the data. **How can I get notified of any issues?** -There are multiple types of alerts via email within Alumio. On the following pages on our forum you can find more detailed information: - -- [Alerts for Incoming Configurations](https://forum.alumio.com/t/alerts-for-incoming-configurations/355) - +There are multiple types of alerts via email within Alumio. See the following pages for more details: +- [Alerts for Incoming Configurations](https://forum.alumio.com/t/alerts-for-incoming-configurations/355) - [Alerts for Route Configurations](https://forum.alumio.com/t/alerts-for-route-configurations/357) **What is the performance of Alumio? Is there any overhead that Alumio adds?** -On the following page on our website you can find detailed statistics regarding the performance of Alumio: https://www.alumio.com/performance/reports . Alumio does add a very small amount of overhead, as processing the data takes effort. And the more data transformations you perform in Alumio, the more overhead you add. But this overhead without any transformations of data is very minimum (milliseconds per Task). +Alumio does introduce a minimal amount of overhead, as processing the data requires resources. The extent of this overhead depends on the number of data transformations carried out in Alumio. In cases where no data transformations are applied, the overhead is extremely low, measuring in milliseconds per task. +Check the following Alumio report with the detailed statistics regarding the performance of Alumio: https://www.alumio.com/performance/reports. **What do I need to connect Spryker Middleware powered by Alumio to Spryker Cloud Commerce OS?** -On your Alumio platform you just need to create an HTTP Client by selecting Spryker Data Exchange API. +On your Alumio platform, you need to create an HTTP Client by selecting Spryker Data Exchange API. -Also, on your Spryker Cloud Commerce OS platform you need to have installed the latest[ Data Exchange API modules integration](https://docs.spryker.com/docs/scos/dev/feature-integration-guides/202307.0/glue-api/dynamic-data-api/data-exchange-api-integration.html). +Also, on your Spryker Cloud Commerce OS platform, you have to install the latest [Data Exchange API modules integration](https://docs.spryker.com/docs/scos/dev/feature-integration-guides/202307.0/glue-api/dynamic-data-api/data-exchange-api-integration.html). ## Integration Apps **What is the difference between an Alumio Connector and an Integration App?** -An Alumio connector allows to establish connectivity between a data source (e.g. an external system) and the Alumio platform (Spryker Middleware powered by Alumio), it doesn't contain any business logic nor transforms data. - -While an Integration Apps is a pre-built integration to integrate popular platforms with Spryker Cloud Commerce OS, reducing the time and complexity of setting up new data exchange pathways (usually includes business logic, data mapping and, data transformation). +An Alumio Connector enables connectivity between a data source, such as an external system, and the Alumio platform (Spryker Middleware powered by Alumio). The connector itself doesn't include any business logic or data transformation. +While an Integration Apps is a pre-built integration that links popular platforms with Spryker Cloud Commerce OS. The integration apps reduce the time and complexity of setting up new data exchange pathways. The integration apps usually encompass business logic, data mapping, and data transformation. ## Data Exchange API -**What is the difference between Backend API and (Dynamic) Data Exchange API?** - -The difference between Backend API & Data Exchange API is that: - -- The Backend API is a resource/route based development driven API endpoints that serve a specific business logic purpose (like set calculate order totals or manage PIM data). - - -- On the other hand, the Data Exchange API is a REST API abstraction over our database tables that provide an easy (yet secure) access to our data model directly with higher levels of performance that is managed with no development efforts needed via UI or configuration files. +**What is the difference between Backend API and Data Exchange API?** +The difference between Backend API and Data Exchange API lies in their functionalities: +- The Backend API consists of resource/route-based development-driven API endpoints that serve a specific business logic purpose, such as calculating order totals or managing PIM data. +- In contrast, the Data Exchange API is a REST API abstraction layer over our database tables, offering secure and convenient access to our data model with enhanced performance. It's managed through UI or configuration files without requiring development efforts. **Can the Data Exchange API be used without Spryker Middleware powered by Alumio?** -Yes, it can. The Data Exchange API is part of Spryker Cloud Commerce (SCCOS) core and it's not dependent on any middleware. It can be used by any middleware, application service, etc. to exchange data with SCCOS. +Yes, it can. The Data Exchange API is part of Spryker Cloud Commerce core and it's not dependent on any middleware. It can be used by any middleware, application service, etc., to exchange data with SCCOS. diff --git a/docs/pbc/all/data-exchange/202311.0/data-exchange.md b/docs/pbc/all/data-exchange/202311.0/data-exchange.md index 9f57eabb348..b0789a4fa61 100644 --- a/docs/pbc/all/data-exchange/202311.0/data-exchange.md +++ b/docs/pbc/all/data-exchange/202311.0/data-exchange.md @@ -1,6 +1,6 @@ --- title: Data Exchange -description: +description: General information about the data exchange options. template: concept-topic-template --- @@ -8,7 +8,7 @@ Data Exchange refers to the process of transferring data between Spryker and thi Spryker offers the following options to import and export data: -- Data Importers and Data Exporters: available in SCCOS by default +- Data Importers and Data Exporters: available in Spryker Cloud Commerce OS (SCCOS) by default - Data Exchange API: available in SCCOS by default - Spryker Middleware powered by Alumio: - Spryker Integration Apps @@ -18,11 +18,14 @@ Spryker offers the following options to import and export data: ## Data Importers and Data Exporters -For information on how data importers and exporters work, see [Data import](/docs/scos/dev/data-import/202307.0/data-import.html) and [Data export] (/docs/scos/dev/data-export/202307.0/data-export.html). +Data Importers and Data Exporters are tools that let you bring external data into and send data from SCCOS, using .CSV files. Data Importers and Data Exporters are part of the SCCOS platform core. +Data Importers and Data Exporters require extensive customization development for each project and ongoing development effort, which makes them less suitable for demanding data exchange. + +For information on how data importers and exporters work, see [Data import](/docs/scos/dev/data-import/202307.0/data-import.html) and [Data export](/docs/scos/dev/data-export/202307.0/data-export.html). ## Data Exchange API -Data Exchange API is a dynamic database API that facilitates data transfer in real time, ensuring data is always current across all integrated platforms. It is part of the Spryker Cloud Commerce OS platform core. +Data Exchange API is a dynamic database API that facilitates data transfer in real-time, ensuring data is always current across all integrated platforms. It's part of the SCCOS platform core. Data Exchange API lets you build, customize, and manage APIs tailored to your specific business requirements through an intuitive user interface. @@ -34,10 +37,9 @@ The main benefits of the Data Exchange API include the following: - Real-time updates: The infrastructure supports dynamic changes, so you can modify APIs on the fly. - Security and Access Control: The infrastructure incorporates strong security measures and access controls, which safeguards sensitive information. - We recommend considering the Data Exchange API in the following cases: -- You want to implement a data integration via API with another middleware that is not Alumio. +- You want to implement a data integration via API with another middleware that's not [Alumio](https://www.alumio.com). - You want to create your own data integration engine via API, without using any middleware software. ## Spryker Middleware Powered by Alumio @@ -47,13 +49,13 @@ The Spryker Middleware Powered by Alumio isn't a part of SCCOS by default. To ob With the Spryker Middleware powered by Alumio, the data exchange process looks like this: -1. Transfer of data from the source system via the API connector. The data is transferred in real time, which ensures that the data is always current across all integrated platforms. +1. Transfer of data from the source system via the API connector. The data is transferred in real-time, which ensures that the data is always current across all integrated platforms. 2. Data is fed into Alumio and transformed there. 3. Transfer of data to the target system via the API connector. -For more details about the Spryker Middleware Powered by Alumio, see [LINK]. + -The Spryker Middleware Powered by Alumio is the foundation of the Spryker Integration Apps. You can use it also to build custom integrations. +The Spryker Middleware Powered by Alumio is the foundation of the Spryker Integration Apps. You can also use it to build [custom integrations](#custom-integrations-with-alumio-connectors). ### Spryker Integration Apps @@ -61,45 +63,41 @@ The Integration Apps let you import data between your Spryker system and third-p To exchange data between a Spryker system and a third-party system with an Integration App, you need to do the following: -- Have a user account on Spryker Middleware Powered by Alumio -- Have the Integration App you need deployed in the Spryker Middleware powered by Alumio platform +- Have a user account on Spryker Middleware Powered by Alumio. +- Have the Integration App you need deployed in the Spryker Middleware powered by Alumio platform. - Make minimum adjustments to the existing mapping and transformation of data. -Reach out to [Spryker support](https://spryker.com/support/) or to your Customer Success Manager if you need access to the Spryker Middleware Powered by Alumio and the Integration App. +Reach out to [Spryker support](https://spryker.com/support/) or to your Customer Success Manager if you need access to the Spryker Middleware Powered by Alumio and the Integration Apps. We recommend considering Integration Apps for data exchange in the following cases: - You require a quick setup of the data exchange process, which should take up to a few hours. -- You need a pre-configured mapping and transformation of data for exchange between Spryker and a third-party system so you would have to make minimum adjustments. -- For your project, it is important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, health monitoring, etc. - -With the Spryker Integration Apps, the data exchange process like this: +- You need a pre-configured mapping and transformation of data for exchange between Spryker and a third-party system, so you would have to make minimum adjustments. +- For your project, it's important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, health monitoring, etc. -Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_86 +With the Spryker Integration Apps, the data exchange process looks like this:
-Spryker provides Early Access to the [Akeneo PIM Integration App](LINK). This Integration App allows to import products from Akeneo PIM to Spryker Cloud Commerce OS. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or products are created or updated in Akeneo, they are transformed in the Alumio platform before the data is transferred to the Spryker Cloud Commerce OS. +Spryker provides Early Access to the Akeneo PIM Integration App. This Integration App allows to import products from Akeneo PIM to Spryker Cloud Commerce OS. The connector between Spryker and Akeneo is set up in a configurable way. Once new objects such as categories, attributes, or products are created or updated in Akeneo, they are transformed in the Alumio platform before the data is transferred to the Spryker Cloud Commerce OS. The middleware allows customers to configure data that is to be transferred to Spryker, for example, attributes and super attributes. -{% info_block infoBox "Info" %} +{% info_block infoBox "Cold data handling" %} -Akeneo handles the so-called “cold data”. Cold data is product information directly linked to the product that describes product properties. The Akeneo PIM Integration App does not include the transfer of “hot data” such as stock or pricing. +Akeneo handles the so-called “cold data”. Cold data is product information directly linked to the product that describes product properties. The Akeneo PIM Integration App doesn't include the transfer of “hot data” such as stock or pricing. {% endinfo_block %} -For details on how to import data from Akeneo to Spryker, see [Configure Akeneo PIM integration app](LINK). + ### Custom integrations with Alumio connectors -In cases where there are no integration apps for data exchange with the third-party system you need, you can build them yourself using the Alumio platform. Alumio provides a number of built-in API connectors to third-party systems that you can use to build integrations between these systems and Spryker. Check the available connectors for Spryker on the [Alumio web-site](https://www.alumio.com/platforms/spryker). +In cases where there are no integration apps for data exchange with the third-party system you need, you can build them yourself using the Alumio platform. Alumio provides a number of built-in API connectors to third-party systems that you can use to build integrations between these systems and Spryker. Check the available connectors for Spryker on the [Alumio website](https://www.alumio.com/platforms/spryker). With custom integrations, the data exchange process looks like this: -Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_124 -
@@ -107,37 +105,37 @@ Note to PMs: Here is a draw.io diagram created from image here: https://docs.goo We recommend building custom integrations with the existing Alumio connectors in the following cases: - There is no Spryker Integration App for the system you need to integrate with. However, Alumio offers a connector for this system. - You require a quick setup of the data exchange process, which should take up to a few days. -- You have a tech-savy user who can configure mapping of data for exchange between Spryker and a third-party system. -- For your project, it is important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. +- You have a tech-savvy user who can configure the mapping of data for exchange between Spryker and a third-party system. +- For your project, it's important that the data exchange solution allows for the proper data orchestration like dependency management, error handling and logging, entity mapping, integration variable management, .CSV file validation, health monitoring, etc. -For more details on how to manage integrations and exchange data in the Alumio platform, see: -- [The Basic Parts Of A Connector Package In Alumio] (https://support.alumio.com/support/solutions/articles/80001031213-the-basic-parts-of-a-connector-package-in-alumio) +For more details on how to manage integrations and exchange data in the Alumio platform, see the following information provided by Alumio: +- [The Basic Parts Of A Connector Package In Alumio](https://support.alumio.com/support/solutions/articles/80001031213-the-basic-parts-of-a-connector-package-in-alumio) - [How To Use The Alumio Connector Packages](https://forum.alumio.com/t/how-to-use-the-alumio-connector-packages/219) -- Alumio keeps here up-to-date the list of their standard Connector Packages [Latest iPaaS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27) +- Up-to-date list of Alumio standard Connector Packages: [Latest iPaaS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27) ### Custom integrations with custom connectors -Before starting to implement any custom connector: -- Double check if the connector with the third-party system you want to integrate with is in the list of existing Alumio standard connectors: [Alumio iPaasS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27) - this list is updated continuously -- If the system you wish to integrate with is not on the list, you may always submit a request to implement a standard connector, and see if it aligns with your timelines. Check here how to do it: [How do I request a new connector package?](https://forum.alumio.com/t/how-do-i-request-a-new-connector-package/148) +If you have legacy systems or old version systems with which you need to exchange data and for which Alumio doesn't provide a connector, you can still build your own connector to these systems, as Alumio platform includes an Alumio SDK to build connectors. + +{% info_block warningBox "Check before implementation" %} -If you have legacy systems or old version systems with which you need to exchange data, and for which Alumio does not provide a connector, you can still build your own connector to these systems, as Alumio platform includes an Alumio SDK to build your own connectors. +Before beginning to implement any custom connector, double check if the connector with the third-party system you want to integrate with is on the list of existing Alumio standard connectors: [Alumio iPaasS Connector Packages](https://forum.alumio.com/c/ipaas-connector-packages/27). This list is continuously updated. +If the system you wish to integrate with isn't on the list, you can submit a request for the implementation of a standard connector. This will give you an opportunity to assess if it aligns with your project timelines. For details on how to submit the request, refer to [How do I request a new connector package?](https://forum.alumio.com/t/how-do-i-request-a-new-connector-package/148). -To build a data integration for a legacy system, you need: +{% endinfo_block %} + + +To build a data integration for a legacy system, you need to do the following: -1. Have a user account on Spryker Middleware powered by Alumio +1. Have a user account on Spryker Middleware powered by Alumio. 2. Build a connector to the legacy system using the Alumio SDK. Building a connector with the Alumio SDK usually takes up to a few weeks. -3. Build the mapping and transformation of data. Initial configuration of data mapping and transformation usually takes up to a few days, changing them takes up to a few hours. +3. Build the mapping and transformation of data. Initial configuration of data mapping and transformation usually takes up to a few days, and changing them takes up to a few hours. With the data integration with custom connectors, the data exchange process looks like this: -Note to PMs: Here is a draw.io diagram created from image here: https://docs.google.com/presentation/d/1RrnuZrbWbDQ_H8K0A5s06uW-oACf74t1TZMjrFzc_eQ/edit#slide=id.g22d9016de29_0_140 -
-We recommend building custom integrations with the connectors created using the Alumio SDK, in cases where Alumio does not have the connectors to the system you want to exchange data with. Even though you need a developer to build a connector for such systems, most of the times this solution is still faster and in the long term more cost-efficient than, for example, using the default data importer and exporters. - +We recommend building custom integrations with the connectors created using the Alumio SDK, in cases where Alumio doesn't have the connectors to the system you want to exchange data with. Even though you need a developer to build a connector for such systems, most of the time, this solution is still faster and, in the long term, more cost-efficient than, for example, using the default Data Importers and Data Exporters. -**How to build Alumio connectors with the Alumio SDK?** -Check Alumio documentation for more information: https://forum.alumio.com/t/creating-alumio-connector-packages/252 +For information on how to build Alumio connectors with the Alumio SDK, check the Alumio documentation: [Creating Alumio Connector Packages](https://forum.alumio.com/t/creating-alumio-connector-packages/252). diff --git a/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md b/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md new file mode 100644 index 00000000000..8d20d3ec89b --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api-inventory-management-feature.md @@ -0,0 +1,10 @@ +--- +title: Install the Data Exchange API + Inventory Management feature +description: Install the Data Exchange API + Inventory Management features in your project. +last_updated: Sep 06, 2023 +template: feature-integration-guide-template +redirect_from: +- /docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api-inventory-management-feature.html +--- + +{% include pbc/all/install-features/202311.0/install-the-data-exchange-api-inventory-management-feature.md %} \ No newline at end of file diff --git a/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api.md b/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api.md new file mode 100644 index 00000000000..7ffaf1a518e --- /dev/null +++ b/docs/pbc/all/data-exchange/202311.0/install-and-upgrade/install-the-data-exchange-api.md @@ -0,0 +1,16 @@ +--- +title: Install the Data Exchange API +description: Learn how to install the Data Exchange API +last_updated: June 22, 2023 +template: feature-integration-guide-template +redirect_from: + - /docs/scos/dev/feature-integration-guides/202304.0/glue-api/data-exchange-api/data-exchange-api-integration.html + - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api-integration.html + - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/dynamic-data-api/data-exchange-api-integration.html + - /docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api.html +related: +- title: How to configure Data Exchange API + link: docs/scos/dev/glue-api-guides/page.version/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.html +--- + +{% include pbc/all/install-features/202311.0/install-the-data-exchange-api.md %} \ No newline at end of file diff --git a/docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.md b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.md similarity index 97% rename from docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.md rename to docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.md index e43060f6139..305d2e97f7a 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.md +++ b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-configure-data-exchange-api.md @@ -5,7 +5,8 @@ last_updated: June 23, 2023 template: howto-guide-template redirect_from: - /docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-configure-data-exchange-api.html - - /docs/scos/dev/glue-api-guides/202307.0/dynamic-data-api/how-to-guides/how-to-configure-data-exchange-api.html + - /docs/scos/dev/glue-api-guides/202307.0/dynamic-data-api/how-to-guides/how-to-configure-data-exchange-api.html + - /docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-configure-data-exchange-api.html --- This document describes how to create and configure the Data Exchange API endpoints. diff --git a/docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.md b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.md similarity index 99% rename from docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.md rename to docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.md index b342a65ddec..db5db727d2a 100644 --- a/docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.md +++ b/docs/pbc/all/data-exchange/202311.0/tutorials-and-howtoes/how-to-send-request-in-data-exchange-api.md @@ -6,6 +6,7 @@ template: howto-guide-template redirect_from: - /docs/scos/dev/glue-api-guides/202304.0/dynamic-data-api/how-to-guides/how-to-send-request-in-data-exchange-api.html - /docs/scos/dev/glue-api-guides/202307.0/dynamic-data-api/how-to-guides/how-to-send-request-in-data-exchange-api.html + - /docs/scos/dev/glue-api-guides/202307.0/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.html --- This document describes how to send interact with databases using the Data Exchange API. The Data Exchange API lets you configure endpoints to interact with any database tables. In this document, we are using the `/dynamic-data/countries` to interact with the `spy_country` table as an example. diff --git a/docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api-inventory-management-feature.md b/docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api-inventory-management-feature.md deleted file mode 100644 index 864defd3cf7..00000000000 --- a/docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api-inventory-management-feature.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Data Exchange API + Inventory Management feature integration -description: Install the Data Exchange API + Inventory Management features in your project. -last_updated: Sep 06, 2023 -template: feature-integration-guide-template ---- - -{% include pbc/all/install-features/202400.0/install-the-data-exchange-api-inventory-management-feature.md %} \ No newline at end of file