Merge pull request #1882 from spryker/AC-1417-Create-missing-data-imp…

…ort-docs Create missing data import docs
spryker · Mar 4, 2024 · 65f8d87 · 65f8d87
2 parents d804ff3 + 2c8283d
commit 65f8d87
Show file tree

Hide file tree

Showing 45 changed files with 1,570 additions and 5 deletions.
diff --git a/Rakefile b/Rakefile
@@ -182,7 +182,9 @@ task :check_dg do
     /docs\/acp\/.+/,
     /docs\/fes\/.+/,
     /docs\/pbc\/.+/,
-    /docs\/sdk\/.+/
+    /docs\/sdk\/.+/,
+    /docs\/dg\/\w+\/[\w-]+\/202212\.0\/.+/,
+    /docs\/dg\/\w+\/[\w-]+\/202307\.0\/.+/
   ]
   HTMLProofer.check_directory("./_site", options).run
 end
diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml
@@ -1002,8 +1002,16 @@ entries:
                     url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-login-by-token-reference-information.html
                   - title: "Customer module overview: reference information"
                     url: /docs/pbc/all/customer-relationship-management/base-shop/domain-model-and-relationships/customer-module-overview-reference-information.html
-              - title: "File details: customer.csv"
-                url: /docs/pbc/all/customer-relationship-management/base-shop/import-file-details-customer.csv.html
+              - title: Import and export data
+                nested:
+                  - title: company_business_unit.csv
+                    url: /docs/pbc/all/customer-relationship-management/base-shop/import-and-export-data/file-details-company-business-unit.csv.html
+                  - title: company_user.csv
+                    url: /docs/pbc/all/customer-relationship-management/base-shop/import-and-export-data/file-details-company-user.csv.html
+                  - title: company.csv
+                    url: /docs/pbc/all/customer-relationship-management/base-shop/import-and-export-data/file-details-company.csv.html
+                  - title: customer.csv
+                    url: /docs/pbc/all/customer-relationship-management/base-shop/import-and-export-data/file-details-customer.csv.html
           - title: Marketplace
             nested:
               - title: Install the Customer Account Management + Merchant Switcher feature
@@ -2922,6 +2930,12 @@ entries:
                         url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option.csv.html
                       - title: product_option_price.csv
                         url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/product-options/import-file-details-product-option-price.csv.html
+                  - title: configurable_bundle_template_image.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-configurable-bundle-template-image.csv.html
+                  - title: configurable_bundle_template_slot.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-configurable-bundle-template-slot.csv.html
+                  - title: configurable_bundle_template.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-configurable-bundle-template.csv.html
                   - title: product_alternative.csv
                     url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-alternative.csv.html
                   - title: product_concrete_pre_configuration.csv
@@ -2934,6 +2948,16 @@ entries:
                     url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label-store.csv.html
                   - title: product_label.csv
                     url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/import-file-details-product-label.csv.html
+                  - title: product_list_to_category.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-product-list-to-category.csv.html
+                  - title: product_list_to_concrete_product.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-product-list-to-concrete-product.csv.html
+                  - title: product_measurement_unit.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-product-measurement-unit.csv.html
+                  - title: product_packaging-unit.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-product-packaging-unit.csv.html
+                  - title: product_list.csv
+                    url: /docs/pbc/all/product-information-management/base-shop/import-and-export-data/file-details-product-list.csv.html
               - title: Manage in the Back Office
                 url: /docs/pbc/all/product-information-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html
                 nested:
@@ -3353,6 +3377,12 @@ entries:
                     url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestpage-module.html
                   - title: QuoteRequestwidget
                     url: /docs/pbc/all/request-for-quote/install-and-upgrade/upgrade-modules/upgrade-the-quoterequestwidget-module.html
+          - title: Import and export data
+            nested:
+              - title: "File details: quote_request.csv"
+                url: /docs/pbc/all/request-for-quote/import-and-export-data/file-details-quote-request.csv.html
+              - title: "File details: quote_request_version.csv"
+                url: /docs/pbc/all/request-for-quote/import-and-export-data/file-details-quote-request-version.csv.html
           - title: Module relations
             url: /docs/pbc/all/request-for-quote/quotation-process-module-relations.html
           - title: Use cases
@@ -3696,6 +3726,16 @@ entries:
                     url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/shopping-lists-feature-overview/shopping-list-widget-overview.html
               - title: Wishlist feature overview
                 url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/wishlist-feature-overview.html
+              - title: Import and export data
+                nested:
+                  - title: shopping_list_company_business_unit.csv
+                    url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/import-and-export-data/file-details-shopping-list-company-business-unit.csv.html
+                  - title: shopping_list_company_user.csv
+                    url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/import-and-export-data/file-details-shopping-list-company-user.csv.html
+                  - title: shopping_list_item.csv
+                    url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/import-and-export-data/file-details-shopping-list-item.csv.html
+                  - title: shopping_list.csv
+                    url: /docs/pbc/all/shopping-list-and-wishlist/base-shop/import-and-export-data/file-details-shopping-list.csv.html
               - title: Install and upgrade
                 nested:
                   - title: Install features
@@ -4166,4 +4206,4 @@ entries:
           - title: Configure Usercentrics
             url: /docs/pbc/all/usercentrics/configure-usercentrics.html
           - title: Disconnect Usercentrics
-            url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html
+            url: /docs/pbc/all/usercentrics/disconnect-usercentrics.html
diff --git a/_includes/pbc/all/install-features/202307.0/install-the-shopping-lists-feature.md b/_includes/pbc/all/install-features/202307.0/install-the-shopping-lists-feature.md
@@ -457,7 +457,7 @@ class InstallerDependencyProvider extends SprykerInstallerDependencyProvider
 	}
 }
 ```
-
+ 
 Run the following console command to execute registered installer plugins and install infrastructural data:
 
 ```bash

diff --git a/...12.0/base-shop/import-and-export-data/file-details-company-business-unit.csv.md b/...12.0/base-shop/import-and-export-data/file-details-company-business-unit.csv.md
@@ -0,0 +1,42 @@
+---
+title: "File details: company_business_unit.csv"
+description: Use the company_business_unit.csv file to configure information about company accounts in your Spryker shop.
+template: data-import-template
+last_updated: Jun 1, 2023
+related:
+  - title: Execution order of data importers in Demo Shop
+    link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html
+---
+
+This document describes the `company_business_unit.csv` file to configure information about [business units](docs/pbc/all/customer-relationship-management/{{page.version}}/company-account-feature-overview/business-units-overview.html) in your Spryker shop.
+
+## Import file dependencies
+
+[File details: company.csv](/docs/pbc/all/customer-relationship-management/{{page.version}}/import-and-export-data/file-details-company.csv.html)
+
+## Import file parameters
+
+| PARAMETER | REQUIRED |  TYPE | DESCRIPTION |
+| --- | - | --- | --- |
+| company_key |&check;| string |  Internal data import identifier of the company.|
+| business_unit_key |&check;| string |  Internal data import identifier of the company business unit. |
+| name | &check; | string | Business unit name. |
+| email | | string | Business unit email. |
+| phone | | string | Business unit phone number. |
+| external_url | | string | Link to internal or external resources related to the business unit. |
+| iban | | string | IBAN of the business unit. |
+| bic | | string | [TODO: Add description] |
+| parent_business_unit_key | | string | Internal identifier of the parent business unit. |
+
+## Import file template and content example
+
+| FILE | DESCRIPTION |
+|---|---|
+| [template_company_business_unit.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/file-details-company-business-unit.csv.md/template_company_business_unit.csv)| Import file template with headers only. |
+| [company_business_unit.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/file-details-company-business-unit.csv.md/company_business_unit.csv)| Exemplary import file with the Demo Shop data. |
+
+## Import file command
+
+```bash
+data:import:company-business-unit
+```
diff --git a/...ment/202212.0/base-shop/import-and-export-data/file-details-company-user.csv.md b/...ment/202212.0/base-shop/import-and-export-data/file-details-company-user.csv.md
@@ -0,0 +1,39 @@
+---
+title: "File details: company_user.csv"
+description: Use the company_user.csv file to configure information about company accounts in your Spryker shop.
+template: data-import-template
+last_updated: Jun 1, 2023
+related:
+  - title: Execution order of data importers in Demo Shop
+    link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html
+---
+
+This document describes the `company_user.csv` file to configure information about [company accounts](/docs/pbc/all/customer-relationship-management/{{page.version}}/company-account-feature-overview/company-accounts-overview.html) in your Spryker shop.
+
+## Import file dependencies
+
+[File details: company.csv](/docs/pbc/all/customer-relationship-management/{{page.version}}/import-and-export-data/file-details-company.csv.html)
+[File details: customer.csv](/docs/pbc/all/customer-relationship-management/{{page.version}}/import-and-export-data/file-details-customer.csv.html)
+
+## Import file parameters
+
+| PARAMETER          | REQUIRED  | TYPE    | REQUIREMENTS OR COMMENTS                              | DESCRIPTION                                          |
+|--------------------|-----------|---------|-------------------------------------------------------|------------------------------------------------------|
+| company_user_key   | &check;   | string  |                                                       | Internal data import identifier of the company user. |
+| customer_reference | &check;   | string  |                                                       | Customer identifier.                                 |
+| company_key        | &check;   | string  |                                                       | Internal data import identifier of the company.      |
+| is_default         |           | bool    | `1`: default company user; `0` or no value otherwise. | Defines if a company user is default.                |
+
+## Import file template and content example
+
+| FILE | DESCRIPTION |
+|---|---|
+| [template_company_user.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/file-details-company-user.csv.md/template_company_user.csv)| Import file template with headers only. |
+| [company_user.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/file-details-company-user.csv.md/company_user.csv)| Exemplary import file with the Demo Shop data. |
+
+
+## Import file command
+
+```bash
+data:import:company-user
+```
diff --git a/...anagement/202212.0/base-shop/import-and-export-data/file-details-company.csv.md b/...anagement/202212.0/base-shop/import-and-export-data/file-details-company.csv.md
@@ -0,0 +1,34 @@
+---
+title: "File details: company.csv"
+description: Use the company.csv file to configure information about company accounts in your Spryker shop.
+template: data-import-template
+last_updated: Jun 1, 2023
+related:
+  - title: Execution order of data importers in Demo Shop
+    link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html
+---
+
+This document describes the `company.csv` file to configure information about [company accounts](/docs/pbc/all/customer-relationship-management/{{page.version}}/company-account-feature-overview/company-accounts-overview.html) in your Spryker shop.
+
+## Import file parameters
+
+| PARAMETER | REQUIRED | TYPE   | REQUIREMENTS OR COMMENTS                                  | DESCRIPTION                     |
+|-----------|----------|--------|-----------------------------------------------------------|---------------------------------|
+| key       | &check;  | string |                                                           | Company key.                    |
+| name      | &check;  | string |                                                           | Company name.                   |
+| is_active |          | bool   | <ul><li>`1`: active</li><li>`0`: inactive</li></ul>       | Defines if a company is active. |
+| status    |          | string | <ul><li>pending</li><li>approved</li><li>denied</li></ul> | Company status.                 |
+
+## Import file template and content example
+
+| FILE | DESCRIPTION |
+|---|---|
+| [template_company.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/template_company.csv)| Import file template with headers only. |
+| [company.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/company.csv)| Exemplary import file with the Demo Shop data. |
+
+
+## Import file command
+
+```bash
+data:import:company
+```
diff --git a/...-shop/import-file-details-customer.csv.md → ...-export-data/file-details-customer.csv.md b/...-shop/import-file-details-customer.csv.md → ...-export-data/file-details-customer.csv.md
@@ -12,6 +12,8 @@ redirect_from:
   - /docs/scos/dev/data-import/201811.0/data-import-categories/commerce-setup/file-details-customer.csv.html
   - /docs/scos/dev/data-import/201903.0/data-import-categories/commerce-setup/file-details-customer.csv.html
   - /docs/scos/dev/data-import/201907.0/data-import-categories/commerce-setup/file-details-customer.csv.html
+  - /docs/scos/dev/data-import/202212.0/data-import-categories/commerce-setup/file-details-customer.csv.html
+  - /docs/pbc/all/customer-relationship-management/202212.0/import-and-export-data/file-details-customer.csv.html
   - /docs/scos/dev/data-import/202307.0/data-import-categories/commerce-setup/file-details-customer.csv.html
 related:
   - title: Execution order of data importers in Demo Shop

diff --git a/...11.0/base-shop/import-and-export-data/file-details-company-business-unit.csv.md b/...11.0/base-shop/import-and-export-data/file-details-company-business-unit.csv.md
@@ -0,0 +1,42 @@
+---
+title: "File details: company_business_unit.csv"
+description: Use the company_business_unit.csv file to configure information about company accounts in your Spryker shop.
+template: data-import-template
+last_updated: Jun 1, 2023
+related:
+  - title: Execution order of data importers in Demo Shop
+    link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html
+---
+
+This document describes the `company_business_unit.csv` file to configure information about [business units](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/company-account-feature-overview/business-units-overview.html) in your Spryker shop.
+
+## Import file dependencies
+
+[File details: company.csv](/docs/pbc/all/customer-relationship-management/{{page.version}}/base-shop/import-and-export-data/file-details-company.csv.html)
+
+## Import file parameters
+
+| PARAMETER | REQUIRED |  TYPE | DESCRIPTION |
+| --- | - | --- | --- |
+| company_key |&check;| string |  Internal data import identifier of the company.|
+| business_unit_key |&check;| string |  Internal data import identifier of the company business unit. |
+| name | &check; | string | Business unit name. |
+| email | | string | Business unit email. |
+| phone | | string | Business unit phone number. |
+| external_url | | string | Link to internal or external resources related to the business unit. |
+| iban | | string | IBAN of the business unit. |
+| bic | | string | [TODO: Add description] |
+| parent_business_unit_key | | string | Internal identifier of the parent business unit. |
+
+## Import file template and content example
+
+| FILE | DESCRIPTION |
+|---|---|
+| [template_company_business_unit.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/file-details-company-business-unit.csv.md/template_company_business_unit.csv)| Import file template with headers only. |
+| [company_business_unit.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/customer-relationship-management/import-and-export-data/file-details-company.csv.md/file-details-company-business-unit.csv.md/company_business_unit.csv)| Exemplary import file with the Demo Shop data. |
+
+## Import file command
+
+```bash
+data:import:company-business-unit
+```