Merge pull request #2246 from spryker/data-exchange-general-info

Data Exchange landing page and FAQ

Rakefile

@@ -175,7 +175,8 @@ task :check_pbc do
     /docs\/scu\/.+/,
     /docs\/pbc\/\w+\/[\w-]+\/202204\.0\/.+/,
     /docs\/pbc\/\w+\/[\w-]+\/202212\.0\/.+/,
-    /docs\/pbc\/\w+\/[\w-]+\/202307\.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

_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

_data/sidebars/pbc_all_sidebar.yml

@@ -922,6 +922,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:

_includes/pbc/all/install-features/202400.0/install-the-data-exchange-api-inventory-management-feature.md → _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

docs/scos/dev/feature-integration-guides/202307.0/glue-api/data-exchange-api/install-the-data-exchange-api.md → _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
 

docs/pbc/all/data-exchange/202311.0/data-exchange-faq.md

@@ -0,0 +1,48 @@
+---
+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 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. 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?**
+
+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 need to create an HTTP Client by selecting Spryker Data Exchange API. 
+
+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 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 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 core and it's not dependent on any middleware. It can be used by any middleware, application service, etc., to exchange data with SCCOS.