From bf911dbbca3308655e96e00b1030ed05eb2833e9 Mon Sep 17 00:00:00 2001 From: Vadym Sachenko Date: Mon, 24 Jul 2023 18:17:07 +0300 Subject: [PATCH 1/5] Update pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index fb47e2bca44..012712e2b7c 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1392,6 +1392,14 @@ entries: include_versions: - "202212.0" nested: + - title: Base shop + nested: + - title: Upgrade modules + nested: + - title: Upgrade the OfferGui module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offergui-module.html + - title: Upgrade the Offer module + url: /docs/pbc/all/offer-management/base-shop/upgrade-modules/upgrade-the-offer-module.html - title: Marketplace nested: - title: Marketplace Product Offer feature overview @@ -1401,7 +1409,7 @@ entries: - title: Install and upgrade nested: - title: Install features - nested: + nested: - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal @@ -1461,6 +1469,18 @@ entries: url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html - title: Marketplace Product Offer feature overview url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-overview.html + - title: "Marketplace Merchant Portal Product Offer Management feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-merchant-portal-product-offer-management-feature-domain-model-and-relationships.html + - title: "Product Offer validity dates: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-validity-dates.html + - title: "Product Offer in the Back Office: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-in-the-back-office.html + - title: "Product Offer storage: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-storage.html + - title: "Product Offer store relation: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/product-offer-store-relation.html + - title: "Marketplace Product Offer feature: Domain model and relationships" + url: /docs/pbc/all/offer-management/marketplace/marketplace-product-offer-feature-domain-model-and-relationships/marketplace-product-offer-feature-domain-model-and-relationships.html - title: Order Management System url: /docs/pbc/all/order-management-system/order-management-system.html include_versions: @@ -1985,10 +2005,6 @@ entries: url: /docs/pbc/all/payment-service-provider/unzer/extend-and-customize/implement-new-payment-methods-on-the-project-level.html - title: Customize the credit card display in your payment step url: /docs/pbc/all/payment-service-provider/unzer/extend-and-customize/customize-the-credit-card-display-in-your-payment-step.html - - - - - title: Price Management url: /docs/pbc/all/price-management/price-management.html nested: From aadf28c963a462ea0754159f1d0d8bd87d275152 Mon Sep 17 00:00:00 2001 From: Vadym Sachenko Date: Tue, 25 Jul 2023 15:07:00 +0300 Subject: [PATCH 2/5] sidebar + redirects Added missing docs to the sidebar and set redirects --- _data/sidebars/pbc_all_sidebar.yml | 21 ++++++++++++++++++- _data/sidebars/scos_dev_sidebar.yml | 6 +++++- _data/sidebars/scu_dev_sidebar.yml | 4 +++- .../exporting-product-data-for-fact-finder.md | 2 ++ .../analytics/fact-finder/fact-finder.md | 1 + ...-configuring-fact-finder-web-components.md | 2 ++ .../installing-and-configuring-fact-finder.md | 2 ++ ...-and-configuring-the-fact-finder-ng-api.md | 2 ++ .../fact-finder/integrating-fact-finder.md | 2 ++ .../using-fact-finder-campaigns.md | 2 ++ ...using-fact-finder-recommendation-engine.md | 2 ++ .../using-fact-finder-search-suggestions.md | 2 ++ .../fact-finder/using-fact-finder-search.md | 2 ++ .../fact-finder/using-fact-finder-tracking.md | 2 ++ 14 files changed, 49 insertions(+), 3 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 012712e2b7c..15e64b680c1 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -423,6 +423,10 @@ entries: nested: - title: Base shop nested: + - title: What's changed + url: /docs/pbc/all/content-management-system/base-shop/whats-changed-in-cms.html + include_versions: + - "202204.0" - title: CMS feature overview url: /docs/pbc/all/content-management-system/base-shop/cms-feature-overview/cms-feature-overview.html nested: @@ -1105,6 +1109,11 @@ entries: url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchant-product-restrictions-feature.html - title: Merchants and Merchant Relations url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/install-the-merchants-and-merchant-relations-feature.html + - title: Upgrade the MerchantGui module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchantgui-module.html + - title: Upgrade the Merchant module + url: /docs/pbc/all/merchant-management/base-shop/install-and-upgrade/upgrade-the-merchant-module.html + - title: Manage in the Back Office url: /docs/pbc/all/merchant-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html nested: @@ -1168,6 +1177,8 @@ entries: url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-product-tax-feature.html - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html + - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management + url: /docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - title: Merchant Switcher url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - title: Merchant Switcher + Customer Account Management @@ -1295,7 +1306,7 @@ entries: - title: Edit translations url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/identity-access-management/manage-using-glue-api/glue-api-retrieve-protected-resources.html + url: /docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.html - title: Third-party integrations nested: - title: Customer service @@ -2402,6 +2413,10 @@ entries: url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-productvalidity-module.html - title: Stock url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stock-module.html + - title: StockSalesConnector + url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-stocksalesconnector-module.html + include_versions: + - "202204.0" - title: Touch url: /docs/pbc/all/product-information-management/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-touch-module.html @@ -2628,6 +2643,8 @@ entries: url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-approval-process-feature-overview.html - title: Marketplace Product Options feature overview url: /docs/pbc/all/product-information-management/marketplace/marketplace-product-options-feature-overview.html + - title: Marketplace Merchant Portal Product Management feature overview + url: /docs/pbc/all/product-information-management/marketplace/marketplace-merchant-portal-product-management-feature-overview.html - title: Install and upgrade nested: - title: Install features @@ -2740,6 +2757,8 @@ entries: url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-approval-process-feature-domain-model-and-relationships.html - title: Marketplace Product Options url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-product-options-feature-domain-model-and-relationships.html + - title: "Marketplace Merchant Portal Product Management feature: Domain model and relationships" + url: /docs/pbc/all/product-information-management/marketplace/domain-model-and-relationships/marketplace-merchant-portal-product-management-feature-domain-model-and-relationships.html - title: Product Relationship Management url: /docs/pbc/all/product-relationship-management/product-relationship-management.html include_versions: diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 215cdbb9a7f..e8e7cb2d69b 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -3341,6 +3341,8 @@ entries: include_versions: - "202212.0" nested: + - title: "Oryx: Compositions" + url: /docs/scos/dev/front-end-development/oryx/oryx-compositions.html - title: Set up url: /docs/scos/dev/front-end-development/oryx/set-up-oryx.html - title: Boilerplate @@ -4519,7 +4521,6 @@ entries: url: /docs/scos/dev/technology-partner-guides/taxes/avalara/integrating-avalara-tax-product-options.html - title: Integrating Avalara Tax + Shipment url: /docs/scos/dev/technology-partner-guides/taxes/avalara/integrating-avalara-tax-shipment.html - - title: Architecture url: /docs/scos/dev/architecture/architecture.html nested: @@ -4562,6 +4563,7 @@ entries: url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/keeping-a-project-upgradable.html nested: - title: Extension scenarios + url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/extension-scenarios/extenstion-scenarios.html nested: - title: Event subscribers' registration url: /docs/scos/dev/guidelines/keeping-a-project-upgradable/supported-extension-scenarios/event-subscribers-registration.html @@ -4610,6 +4612,8 @@ entries: - title: Testing guidelines url: /docs/scos/dev/guidelines/testing-guidelines/testing-guidelines.html nested: + - title: Testing concepts + url: /docs/scos/dev/guidelines/testing-guidelines/testing-concepts.html - title: Setting up tests url: /docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html - title: Publish and Synchronization testing diff --git a/_data/sidebars/scu_dev_sidebar.yml b/_data/sidebars/scu_dev_sidebar.yml index c5af1a13ebc..da2caf288bc 100644 --- a/_data/sidebars/scu_dev_sidebar.yml +++ b/_data/sidebars/scu_dev_sidebar.yml @@ -21,6 +21,8 @@ entries: url: /docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-project-self-hosted-with-gitlab.html - title: Connect the Spryker CI to a Azure managed project url: /docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-azure-managed-project.html + - title: Connect the Spryker CI to a GitLab managed project + url: /docs/scu/dev/onboard-to-spryker-code-upgrader/connect-spryker-ci-to-a-gitlab-managed-project.html - title: Invite users to Spryker CI url: /docs/scu/dev/invite-users-to-spryker-ci.html - title: Run the SCU @@ -38,4 +40,4 @@ entries: - title: The process exceeded the timeout url: /docs/scu/dev/troubleshooting/the-process-exceeded-the-timeout.html - title: You have an unprocessed PR from a previous update - url: /docs/scu/dev/troubleshooting/you-have-an-unprocessed-pr-from-a-previous-update.html + url: /docs/scu/dev/troubleshooting/you-have-an-unprocessed-pr-from-a-previous-update.html \ No newline at end of file diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md index c39e14abfe0..5dc5f2458e1 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md @@ -11,6 +11,8 @@ redirect_from: - /docs/search-factfinder-export-csv - /docs/en/search-factfinder-export-csv - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html related: - title: Installing and configuring FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.md index 7a5d9d1e763..d2d8e2b5ba1 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.md @@ -11,6 +11,7 @@ redirect_from: - /docs/factfinder - /docs/en/factfinder - /docs/scos/user/technology-partners/202212.0/marketing-and-conversion/analytics/fact-finder.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/fact-finder.html related: - title: Installing and configuring FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md index 53c15e2ac55..378f641cbf1 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md @@ -11,6 +11,8 @@ redirect_from: - /docs/fact-finder-web-components - /docs/en/fact-finder-web-components - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html --- This document shows how to install and configure FACT-Finder web components. diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md index f2537318cb9..4bb3661e334 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md @@ -11,6 +11,8 @@ redirect_from: - /docs/fact-finder-installation-and-configuration - /docs/en/fact-finder-installation-and-configuration - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html related: - title: Integrating FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md index b1e6aeb5f6f..8971b78d2ac 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md @@ -11,6 +11,8 @@ redirect_from: - /docs/fact-finder-ng - /docs/en/fact-finder-ng - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html related: - title: Installing and configuring FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.md index 2f010512269..8a15cde6bf0 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.md @@ -11,6 +11,8 @@ redirect_from: - /docs/fact-finder-integration-into-project - /docs/en/fact-finder-integration-into-project - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html related: - title: Installing and configuring FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md index 15d63f47b07..8ba215676ba 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md @@ -11,6 +11,8 @@ redirect_from: - /docs/search-factfinder-campaigns - /docs/en/search-factfinder-campaigns - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html related: - title: Installing and configuring FACT-Finder NG API link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md index b34295ac476..78757f48c77 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md @@ -11,6 +11,8 @@ redirect_from: - /docs/search-factfinder-recommendation - /docs/en/search-factfinder-recommendation - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html related: - title: Installing and configuring FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md index 7d26e9ad964..be2e666fefa 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md @@ -11,6 +11,8 @@ redirect_from: - /docs/search-factfinder-suggest - /docs/en/search-factfinder-suggest - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html related: - title: Integrating FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md index c326f078217..d871fca1925 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md @@ -11,6 +11,8 @@ redirect_from: - /docs/search-factfinder-search - /docs/en/search-factfinder-search - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html related: - title: Installing and configuring FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html diff --git a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md index 932b60cf8f6..d87c439982a 100644 --- a/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md +++ b/docs/pbc/all/miscellaneous/202212.0/third-party-integrations/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md @@ -11,6 +11,8 @@ redirect_from: - /docs/search-factfinder-tracking - /docs/en/search-factfinder-tracking - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - /docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html + - /docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html related: - title: Integrating FACT-Finder link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html From 3793f5a2773c13807cf9e39c0ca9cbc30f178609 Mon Sep 17 00:00:00 2001 From: Vadym Sachenko Date: Tue, 25 Jul 2023 15:09:05 +0300 Subject: [PATCH 3/5] redundant docs remove redundant docs redirects were set for --- .../exporting-product-data-for-fact-finder.md | 104 ---- ...-configuring-fact-finder-web-components.md | 382 ------------ .../installing-and-configuring-fact-finder.md | 68 --- ...-and-configuring-the-fact-finder-ng-api.md | 569 ------------------ .../fact-finder/integrating-fact-finder.md | 197 ------ .../using-fact-finder-campaigns.md | 218 ------- ...using-fact-finder-recommendation-engine.md | 131 ---- .../using-fact-finder-search-suggestions.md | 80 --- .../fact-finder/using-fact-finder-search.md | 228 ------- .../fact-finder/using-fact-finder-tracking.md | 195 ------ .../exporting-product-data-for-fact-finder.md | 104 ---- .../analytics/fact-finder/fact-finder.md | 20 - ...-configuring-fact-finder-web-components.md | 337 ----------- .../installing-and-configuring-fact-finder.md | 68 --- ...-and-configuring-the-fact-finder-ng-api.md | 569 ------------------ .../fact-finder/integrating-fact-finder.md | 197 ------ .../using-fact-finder-campaigns.md | 218 ------- ...using-fact-finder-recommendation-engine.md | 131 ---- .../using-fact-finder-search-suggestions.md | 80 --- .../fact-finder/using-fact-finder-search.md | 228 ------- .../fact-finder/using-fact-finder-tracking.md | 195 ------ 21 files changed, 4319 deletions(-) delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md delete mode 100644 docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/fact-finder.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md delete mode 100644 docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md deleted file mode 100644 index 9ea4debab0b..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: Exporting product data for FACT-Finder -description: Export data to FACT-Finder CSV by applying the configuration. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-export-csv -originalArticleId: 431824f4-acc7-4a60-8b02-dd450427c1e3 -redirect_from: - - /2021080/docs/search-factfinder-export-csv - - /2021080/docs/en/search-factfinder-export-csv - - /docs/search-factfinder-export-csv - - /docs/en/search-factfinder-export-csv - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: FACT-Finder - link: docs/scos/user/technology-partners/page.version/marketing-and-conversion/analytics/fact-finder.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html ---- - -## Output Folder - -Define an output folder where the CSV files will be generated by adding the following line in your configuration file: -```php - [ - 'url' => 'http://search-web-components.fact-finder.de/FACT-Finder-7.2', - 'version' => '7.2', - 'default-query' => 'trousers', - 'channel' => 'heroku-fact-finder-de_DE', - 'search-immediate' => false, - ], -]; -... -``` - -To set up the components configuration, use the following config code as an example: - -
-config/Shared/config_default.php - -```php -... -$config[FactFinderWebComponentsConstants::BREADCRUMB_COMPONENT_CONFIG] = [ - 'properties' => [ - 'show-only' => false, - ], - 'items' => [ - 'search', - 'filter', - 'advisor', - ], -]; - -$config[FactFinderWebComponentsConstants::SEARCH_BOX_COMPONENT_CONFIG] = [ - 'properties' => [ - 'suggest-onfocus' => 'true', - 'use-suggest' => 'true', - ], -]; - -$config[FactFinderWebComponentsConstants::SEARCH_BUTTON_COMPONENT_CONFIG] = [ - 'suggest-onfocus' => false, - 'hidesuggest-onblur' => true, - 'select-onclick' => false, - 'use-suggest' => false, - 'suggest-delay' => 0, -]; - -$config[FactFinderWebComponentsConstants::HEADER_NAVIGATION_COMPONENT_CONFIG] = [ - 'properties' => [ - 'group-count' => 4, - 'group-size' => 4, - 'hide-empty-groups' => '1', - 'fetch-initial' => '1', - ], -]; - -$config[FactFinderWebComponentsConstants::SUGGEST_CONFIG] = [ - 'properties' => [], - 'productItemType' => 'productName', - 'searchItems' => [ - [ - 'type' => 'searchTerm', - 'title' => 'Search term', - ], - [ - 'type' => 'category', - 'title' => 'Category', - ], - [ - 'type' => 'brand', - 'title' => 'Brand', - ], - ], -]; - -$config[FactFinderWebComponentsConstants::RECORD_LIST_COMPONENT_CONFIG] = [ - 'properties' => [], - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::CHECKOUT_TRACKING_CONFIG] = [ - 'properties' => [ - 'disable-auto-tracking' => true, - ], - 'items' => [ - [ - 'recordId' => 'd44c3c7b5e52f7a6b27041c1e789e954', - 'count' => '2', - ], - [ - 'recordId' => '19532fa96a8e60a27328f01520cc4', - 'count' => '4', - ], - ], -]; - -$config[FactFinderWebComponentsConstants::RECORD_COMPONENT_CONFIG] = [ - 'subscribe' => 'true', - 'is-recommendation' => false, - 'infinite-scrolling' => true, - 'infinite-debounce-delay' => 32, - 'infinite-scroll-margin' => 0, -]; - -$config[FactFinderWebComponentsConstants::ASN_GROUP_COMPONENT_CONFIG] = [ - 'opened' => false, - 'collapsible' => true, - 'lazy-load' => true, -]; - -$config[FactFinderWebComponentsConstants::ASN_GROUP_ELEMENT_CONFIG] = [ - 'selected' => true, -]; - -$config[FactFinderWebComponentsConstants::ASN_REMOVE_ALL_FILTER_CONFIG] = [ - 'align' => 'vertical', - 'show-always' => true, - 'remove-params' => false, -]; - -$config[FactFinderWebComponentsConstants::ASN_SLIDER_CONFIG] = [ - 'properties' => [ - 'align' => 'vertical', - ], -]; - -$config[FactFinderWebComponentsConstants::ASN_SLIDER_CONTROL_CONFIG] = [ - 'submit-on-input' => true, -]; - -$config[FactFinderWebComponentsConstants::PAGING_COMPONENT_CONFIG] = [ - 'properties' => [ - ], -]; - -$config[FactFinderWebComponentsConstants::PRODUCTS_PER_PAGE_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'dropdown' => '', - 'list' => '', - 'item' => '', -]; - -$config[FactFinderWebComponentsConstants::SORT_BOX_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'items' => [ - [ - 'key' => 'default.template', - 'title' => 'factfinder.web-components.sort.box.default.style', - ], - [ - 'key' => 'Price.asc', - 'title' => 'factfinder.web-components.sort.box.overriden.for', - ], - [ - 'key' => 'null.desc', - 'title' => 'factfinder.web-components.sort.box.relevance', - ], - ], -]; - -$config[FactFinderWebComponentsConstants::SIMILAR_PRODUCTS_COMPONENT_CONFIG] = [ - 'properties' => [ - 'max-results' => 4, - ], - 'list' => '', - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::SIMILAR_PRODUCT_ID_CONFIG] = [ - 'recordId' => 'd44c3c7b5e52f7a6b27041c1e789e954', -]; - -$config[FactFinderWebComponentsConstants::RECOMMENDATION_CONFIG] = [ - 'properties' => [ - 'max-results' => 4, - ], - 'list' => '', - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::RECOMMENDATION_RECORD_ID_CONFIG] = [ - 'recordId' => '19532fa96a8e60a27328f01520cc4', -]; - -$config[FactFinderWebComponentsConstants::TAG_CLOUD_COMPONENT_CONFIG] = [ - 'properties' => [ - ], -]; - -$config[FactFinderWebComponentsConstants::PUSHED_PRODUCTS_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'list' => '', - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::CAMPAIGN_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'answer' => '', - 'question' => '', - 'feedbacktext' => '', -]; -... -``` -
-
- -## Integration into Project - -**frontend/settings.js** - -```js -// define project relative paths to context -const paths = { - ... - - // eco folders - eco: { - // all modules - modules: './vendor/spryker-eco' - }, - - // project folders - project: { - ... - } -}; - -... - -// export settings -module.exports = { - ... - - // define settings for suite-frontend-builder finder - find: { - // webpack entry points (components) finder settings - componentEntryPoints: { - // absolute dirs in which look for - dirs: [ - ... - path.join(context, paths.eco.modules), - ... - ], - ... - }, - - ... - } -} -``` - -**src/Pyz/Yves/ShopUi/Theme/default/es6-polyfill.ts** - -```js -// add es6 polyfill -import 'core-js/fn/promise'; -import 'core-js/fn/array'; -import 'core-js/fn/set'; -import 'core-js/fn/map'; - -// check if the browser natively supports webcomponents (and es6) -const hasNativeCustomElements = !!window.customElements; - -// then load a shim for es5 transpilers (typescript or babel) -// https://github.com/webcomponents/webcomponentsjs#custom-elements-es5-adapterjs -if (hasNativeCustomElements) { - import(/* webpackMode: "eager" */'@webcomponents/webcomponentsjs/custom-elements-es5-adapter'); -} -``` - -**src/Pyz/Yves/ShopUi/Theme/default/vendor.ts** - -```js -// add es6 polyfill -import 'core-js/fn/promise'; -import 'core-js/fn/array'; -import 'core-js/fn/set'; -import 'core-js/fn/map'; - -// check if the browser natively supports webcomponents (and es6) -const hasNativeCustomElements = !!window.customElements; - -// then load a shim for es5 transpilers (typescript or babel) -// https://github.com/webcomponents/webcomponentsjs#custom-elements-es5-adapterjs -if (hasNativeCustomElements) { - import(/* webpackMode: "eager" */'@webcomponents/webcomponentsjs/custom-elements-es5-adapter'); -} -``` - -**src/Pyz/Yves/ShopUi/Theme/default/vendor.ts** - -```js -// add webcomponents polyfill -import '@webcomponents/webcomponentsjs/custom-elements-es5-adapter'; -import '@webcomponents/webcomponentsjs/webcomponents-loader'; -import '@webcomponents/webcomponentsjs/webcomponents-bundle'; -import 'ff-web-components/dist/bundle'; -``` - -Update in Core "@webcomponents/webcomponentsjs": "^2.0.4", - - **package.json** - -```json -"dependencies": { -"ff-web-components": "git+https://github.com/FACT-Finder-Web-Components/ff-web-components.git#release/3.0" -}, -``` - -## Frontend Integration - -Add the required Communication element: - -```html -{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include atom('communication', 'FactFinderWebComponents') with { - data: { - properties: { - component: 'url="http://search-web-components.fact-finder.de/FACT-Finder-7.2" version="7.2" default-query="trousers" channel="bergfreunde-co-uk" search-immediate="true"' - } - } - } only {% raw %}%}{% endraw %} - -{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} -``` - -Add a widget: -```json -{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include atom('communication', 'FactFinderWebComponents') with { - data: { - properties: { - component: 'url="http://search-web-components.fact-finder.de/FACT-Finder-7.2" version="7.2" default-query="trousers" channel="bergfreunde-co-uk" search-immediate="true"' - } - } - } only {% raw %}%}{% endraw %} - - {% raw %}{%{% endraw %} include atom('header-navigation', 'FactFinderWebComponents') with { - data: { - properties: { - component: 'group-count="4" group-size="4" hide-empty-groups="1" fetch-initial="1"' - } - } - } only {% raw %}%}{% endraw %} -{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} -``` diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md deleted file mode 100644 index f2537318cb9..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Installing and configuring FACT-Finder -description: This article provides details on the installation and configuration of the FACT-Finder module. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/fact-finder-installation-and-configuration -originalArticleId: 5d9650ca-e38b-4c41-ade5-e767e9878a73 -redirect_from: - - /2021080/docs/fact-finder-installation-and-configuration - - /2021080/docs/en/fact-finder-installation-and-configuration - - /docs/fact-finder-installation-and-configuration - - /docs/en/fact-finder-installation-and-configuration - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html -related: - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Installation - -Composer dependency: - -To install Spryker's FactFinder module, use [composer](https://getcomposer.org/): -```php -composer require spryker-eco/fact-finder-sdk -composer require spryker-eco/fact-finder -``` - -If you faced an issue with the FACT-Finder library dependency and it is not installed, please use the following instructions: - -1. Add `composer.json`> file to the respective section of your project, `FACT-Finder/FACT-Finder-PHP-Library": "1.3.*` -2. Add to the repositories section: - ```json -{"type": "git","url": "git@github.com:FACT-Finder/FACT-Finder-PHP-Library.git"} -``` -3. Run `composer update` command: -```bash -composer update -``` - -## Channel Configuration - -Channel Management in FACT-Finder admin panel can be used for creating and removing the channels. It also creates parent-child hierarchy and manages backups. - -By default, channel settings should be the following: - -* File encoding - `UTF-8` -* Enclosing (quote) character - `"` -* Field separator - `,` -* Number of header lines - `1` -* Data record ID - `ProductNumber` -* Product number for tracking - `ProductNumber` diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md deleted file mode 100644 index b1e6aeb5f6f..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md +++ /dev/null @@ -1,569 +0,0 @@ ---- -title: Installing and configuring FACT-Finder NG API -description: Fact Finder NG API integration is used for search, tracking, and importing endpoints. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/fact-finder-ng -originalArticleId: 90e6b6fb-5a4a-4efc-a798-02fb8009c493 -redirect_from: - - /2021080/docs/fact-finder-ng - - /2021080/docs/en/fact-finder-ng - - /docs/fact-finder-ng - - /docs/en/fact-finder-ng - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Installation -To install the package use `composer require spryker-eco/fact-finder-ng` command. - -## Configuration -For using the package you have to set configuration parameters. -```php -$config[FactFinderNgConstants::FACT_FINDER_URL] = ''; # Fact-Finder URL -$config[FactFinderNgConstants::FACT_FINDER_CHANNEL] = ''; # Fact-Finder channel value -$config[FactFinderNgConstants::FACT_FINDER_USERNAME] = ''; # Fact-Finder user for authorization. -$config[FactFinderNgConstants::FACT_FINDER_PASSWORD] = ''; # Fact-Finder password for authorization. -``` -## Import Usage -Fact-Finder has an import API call. It can be used to update product information by URL set on the Fact-Finder side. To trigger the import, you have to add Console command to `ConsoleDependecyProvider`. - -**ConsoleDependencyProvider.php** - -```php -factFinderNgClient->trackCheckoutEvent($this->preparedCheckoutEventTransfers($quoteTransfer)); - - return parent::execute($request, $quoteTransfer); - } - - /** - * @param QuoteTransfer $quoteTransfer - * - * @return CartOrCheckoutEventTransfer[] - */ - protected function preparedCheckoutEventTransfers(QuoteTransfer $quoteTransfer): array - { - $eventTransfers = []; - foreach ($quoteTransfer->getItems() as $itemTransfer) { - $eventTransfer = new CartOrCheckoutEventTransfer(); - $eventTransfer->setCount($itemTransfer->getQuantity()); - $eventTransfer->setId($itemTransfer->getSku()); - $eventTransfer->setMasterId($itemTransfer->getAbstractSku()); - $eventTransfer->setPrice($itemTransfer->getUnitPriceToPayAggregation()); - $eventTransfer->setSid(uniqid()); - - $eventTransfers[] = $eventTransfer; - } - - return $eventTransfers; - } -} -``` - -## Search, Suggestion, Navigation Usage -For using search functions, you have to extend SearchClient on the project level. If you want to use different search engines, you might need to create search router, for choosing the right engine. - -**SearchRouter** - -```php -searchPlugins = $searchPlugins; - } - - /** - * Resolve here what the handler should be work - * - * @param \Spryker\Client\Search\Dependency\Plugin\QueryInterface $searchQuery - * @param array $resultFormatters - * @param array $requestParameters - * - * @return array|\Elastica\ResultSet - */ - public function search(QueryInterface $searchQuery, array $resultFormatters = [], array $requestParameters = []) - { - foreach ($this->searchPlugins as $searchPlugin) { - if ($searchPlugin->isApplicable($requestParameters)) { - return $searchPlugin->handle($searchQuery, $resultFormatters, $requestParameters); - } - } - - return []; - } -} -``` - -If you want to use ElasticSearch for specific cases, you have to create a plugin on the project level - -**ElasticSearchHandlerPlugin** - -```php -getFactory()->createElasticsearchSearchHandler()->search($searchQuery, $resultFormatters, $requestParameters); - } - - /** - * @param array $requestParameters - * - * @return bool - */ - public function isApplicable(array $requestParameters): bool - { - return true; - } -} -``` - -The Fact-Finder Ng module contains plugins for choosing search, suggestion, or navigation request should be used. By now you can create plugin stack in `SearchDependencyProvider` for using in `SearchRouter`. - -**SearchDependencyProvider** - -```php -provideFactFinderNgClient($container); - $container = $this->addSearchPlugins($container); - - return $container; - } - - /** - * @return \Pyz\Client\Search\Plugin\SearchHandlerPluginInterface[] - */ - protected function getSearchPlugins(): array - { - return [ - new FactFinderNgNavigationHandlerPlugin(), - new FactFinderNgSearchHandlerPlugin(), - new FactFinderNgSuggestHandlerPlugin(), - new ElasticSearchHandlerPlugin(), - ]; - } - - /** - * @param \Spryker\Client\Kernel\Container $container - * - * @return \Spryker\Client\Kernel\Container - */ - protected function provideFactFinderNgClient(Container $container): Container - { - $container[static::CLIENT_FACT_FINDER_NG] = function (Container $container) { - return $container->getLocator()->factFinderNg()->client(); - }; - - return $container; - } - - /** - * @param \Spryker\Client\Kernel\Container $container - * - * @return \Spryker\Client\Kernel\Container - */ - protected function addSearchPlugins(Container $container): Container - { - $container[static::PLUGINS_SEARCH] = function () { - return $this->getSearchPlugins(); - }; - - return $container; - } -} -``` - -Then SearchClient can be adjusted: - -**SearchRouter** - -```php -getFactory() - ->createSearchRouter() - ->search($searchQuery, $resultFormatters, $requestParameters); - } -} -``` - -The idea that you have to adjust places, where the search is called for adding needed params to request parameters. For example, you can adjust `SuggestionController` for adding a suggest parameter, so `FactFinderNgSuggestHandlerPlugin` will know that it should be called. - -**SuggestionController** - -```php -query->get(self::PARAM_SEARCH_QUERY); - - if (!$searchString) { - return $this->jsonResponse(); - } - - $requestParameters = array_merge($request->query->all(), ['suggest' => 1]); # Here you add new request parameter. - - $searchResults = $this - ->getFactory() - ->getCatalogClient() - ->catalogSuggestSearch($searchString, $requestParameters); - - return $this->jsonResponse([ - 'completion' => ($searchResults['completion'] ? $searchResults['completion'][0] : null), - 'suggestion' => $this->renderView('@CatalogPage/views/suggestion-results/suggestion-results.twig', $searchResults)->getContent(), - ]); - } -} -``` - -## Pagination, Sorting, and Filters -### Pagination -For the Yves layer, pagination should work out of the box. Request mapper cares about page and ipp (items for page) parameters and map it to Fact-Finder parameters. - -If you use the Glue layer, you have to add page and ipp value to request parameters. - -### Sorting -By default, the Yves layer doesn't care about sort options which suggested by Fact-Finder. If you want to use them, you have to change `SortedResultFormatterPlugin` in `CatalogDependencyProvider`. -```php -buildRoute('/factfinder', 'FactFinder', 'Search', 'index'); - $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_SEARCH, $route); - - $route = $this->buildRoute('/factfinder/suggestions', 'FactFinder', 'Suggestions', 'index'); - $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_SEARCH, $route); - - $route = $this->buildRoute('/factfinder/track', 'FactFinder', 'Track', 'index'); - $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_TRACK, $route); - - $route = $this->buildRoute('/factfinder/recommendations', 'FactFinder', 'Recommendations', 'index'); - $routeCollection->add(static::ROUTE_FACT_FINDER_RECOMMENDATIONS, $route); - - return $routeCollection; - } -} -``` - -2. Then add the created route provider to the `RouterDependencyProvider` file: Expand a code sample - -```php -provideClients($container); - - return $container; - } - - /** - * @param \Spryker\Yves\Kernel\Container $container - * - * @return \Spryker\Yves\Kernel\Container - */ - protected function provideClients(Container $container) - { - $container[self::FACT_FINDER_SDK_CLIENT] = function () use ($container) { - return $container->getLocator() - ->factFinderSdk() - ->client(); - }; - - return $container; - } - -} -``` -2. Add it to your factory: - -```php -getProvidedDependency(FactFinderDependencyProvider::FACT_FINDER_SDK_CLIENT); - } - - ... - -} -``` diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md deleted file mode 100644 index 94605f5b1bd..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: Using FACT-Finder campaigns -description: The FACT-Finder Campaign Manager module allows you to target the management of search results in order to improve the customer lead process or deliberately highlight products. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-campaigns -originalArticleId: c9ceca36-2c18-45b1-840b-be14f926645c -redirect_from: - - /2021080/docs/search-factfinder-campaigns - - /2021080/docs/en/search-factfinder-campaigns - - /docs/search-factfinder-campaigns - - /docs/en/search-factfinder-campaigns - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html -related: - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: FACT-Finder - link: docs/scos/user/technology-partners/page.version/marketing-and-conversion/analytics/fact-finder.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html ---- - -## Prerequisites - -The FACT-Finder Campaign Manager module allows you to target the management of search results in order to improve the customer lead process or deliberately highlight products. -Campaigns are activated according to the specific criteria and are then returned accordingly in the search results. - -Campaigns are a powerful tool for visual merchandising. One of their numerous functions is automatic redirects to static pages for specific search terms, e.g. searching for "ToS" automatically redirects the user to the terms of service page. Even more importantly, campaigns allow for targeted placement of banners or the customization of search results. - -These types of the campaign can be created with the Campaign Assistant: - -* **Feedback Campaigns**: Display preset texts and banners with search results. Also used for pushed products. -* **Redirect Campaigns**: Redirect the user to the specific pages for certain search terms. -* **Advisor Campaigns**: Manages questions and answers that are presented to the shop visitor. Answers lead to specific product sets. -* **Product Campaigns**: Allows you to place campaigns on product pages instead of search result pages. - -### Feedback Campaign - -Feedback campaigns add predefined banners, texts, and products aimed to search results in reaction to specific search terms or other triggers. -These campaigns are best suited to pushing products. -A feedback campaign can also be used to place videos, point the customer towards the brand stores or to the designed zero-result pages. - -### Redirect Campaign - -Redirect campaigns react to triggers like search words and send users to specific pages, like Contact, ToS, etc. -Every webstore has a number of pages that should be available in this way. -Apart from the contact form and terms of service, payment and shipping conditions, as well as the about page, fall into that list. - -### Redirect Campaign - -Advisor campaigns give you the ability to set up questions as text or images which are presented to the customer in certain situations. -You group the questions with the preset answers the customer can choose. Each answer is combined with a product set which is displayed to the user on giving the answer. This gives you the ability to guide the user with targeted questions. -Advisor campaigns are especially useful to react to rising trends or frequently used filter combinations. - -### Product Campaign - -Product campaigns can be placed on any product detail page, shopping cart page or shop page and display a specific product set. -They employ the same method of defining product sets but are different in the way they are triggered. - -## Usage - -### Search Page - -Search result campaigns are fetched implicitly by invoking a search request. Examples of integration of advisor, redirect, feedback and pushed products campaigns can be found in `vendor/spryker-eco/fact-finder/src/SprykerEco/Yves/FactFinder/Theme/default/search/catalog.twig` - -### Product Details Page - -To fetch Fact-Finder campaigns for product page, you need to make a call using Fact-Finder client. To do that: - -1. Add FactFinder client to dependency provider: - -**Code sample** - -```php -provideClients($container); - - return $container; - } - - /** - * @param \Spryker\Yves\Kernel\Container $container - * - * @return \Spryker\Yves\Kernel\Container - */ - protected function provideClients(Container $container) - { - ... - - $container[self::CLIENT_FACT_FINDER] = function (Container $container) { - return $container->getLocator()->factFinderSdk()->client(); - }; - - return $container; - } - -} -``` - -2. Add methods to get FactFinder client and to create product campaign request transfer: - -**Code sample** - - ```php -getProvidedDependency(ProductDependencyProvider::CLIENT_FACT_FINDER); - } - - /** - * @return \Generated\Shared\Transfer\FactFinderSdkProductCampaignRequestTransfer - */ - public function createFactFinderSdkProductCampaignRequestTransfer() - { - return new FactFinderSdkProductCampaignRequestTransfer(); - } - -} - ``` - -3. Fetch product campaigns from controller: - -**Code sample** - - ```php -getFactory() - ->createFactFinderSdkProductCampaignRequestTransfer(); - $factFinderSdkProductCampaignRequestTransfer->addProductNumber($storageProductTransfer->getIdProductAbstract()); - $factFinderSdkProductCampaignRequestTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); - $factFinderProductCampaignResponseTransfer = $this->getFactory() - ->getFactFinderClient() - ->getProductCampaigns($factFinderSdkProductCampaignRequestTransfer); - $campaigns = $factFinderProductCampaignResponseTransfer->getCampaignIterator()->getCampaigns(); - - $productData = [ - ... - 'campaigns' => $campaigns, - ]; - - return $productData; - } -} -``` - -4. Inject feedback campaign templates into product details template, indicating position of campaign widget in `feedbackBlockPositionId` parameter e.g.: - -```php -{% raw %}{%{% endraw %} if campaigns is defined {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include '@FactFinder/campaigns/partials/feedback.twig' with { - campaigns: campaigns, - feedbackBlockPositionId: 'product detail - above product', - } {% raw %}%}{% endraw %} -{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} -``` -Additionally, you might need to add some more feedback widgets to general layout in `src/Pyz/Yves/Application/Theme/default/layout/layout.twig` -5. Inject pushed products campaign template into product details template, e.g.: - -```php -{% raw %}{%{% endraw %} if campaigns is defined {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include '@FactFinder/campaigns/partials/pushed-products.twig' with { - campaigns: campaigns, - } {% raw %}%}{% endraw %} -{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} -``` - -### Cart Page - -To fetch Fact-Finder campaigns for cart page, perform the same actions as for product page, but under Cart module namespace. diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md deleted file mode 100644 index e1374e4be1a..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: Using FACT-Finder recommendation engine -description: The FACT-Finder recommendation engine analyzes product and category relationships. The results are rendered in recommendations widget, which can be displayed on product details pages, homepage or in the shopping cart. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-recommendation -originalArticleId: e3d079b4-2197-4009-a2f9-df27739a4b7f -redirect_from: - - /2021080/docs/search-factfinder-recommendation - - /2021080/docs/en/search-factfinder-recommendation - - /docs/search-factfinder-recommendation - - /docs/en/search-factfinder-recommendation - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: FACT-Finder - link: docs/scos/user/technology-partners/page.version/marketing-and-conversion/analytics/fact-finder.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html ---- - -## Prerequisites - -The FACT-Finder recommendation engine analyzes product and category relationships. The results are rendered in recommendations widget, which can be displayed on product details pages, homepage or in the shopping cart. - -## Usage - -To add recommendations widget to product page, insert the following code into `src/Pyz/Yves/Product/Theme/default/product/detail.twig`: -```html -{% raw %}{{{% endraw %} fact_finder_recommendations({id: product.sku, mainId: product.idProductAbstract}, '@FactFinder/recommendations/products.twig') {% raw %}}}{% endraw %} -``` -To add recommendations widget to cart page, modify cart controller (`src/Pyz/Yves/Cart/Controller/CartController.php`) to add array of product ids into template variables: - -
-Click here to expand the code sample - -```php -getClient() - ->getQuote(); - - $factFinderSid = $request->cookies->get(FactFinderConstants::COOKIE_SID_NAME); - $quoteTransfer->setFactFinderSid($factFinderSid); - - $voucherForm = $this->getFactory() - ->getVoucherForm(); - - $cartItems = $this->getFactory() - ->createProductBundleGrouper() - ->getGroupedBundleItems($quoteTransfer->getItems(), $quoteTransfer->getBundleItems()); - - $cartItemsIds = []; - $cartItemsNames = []; - foreach ($cartItems as $cartItem) { - $cartItemsNames[] = $cartItem->getName(); - $cartItemsIds[] = $cartItem->getSku(); - } - - $stepBreadcrumbsTransfer = $this->getFactory() - ->getCheckoutBreadcrumbPlugin() - ->generateStepBreadcrumbs($quoteTransfer); - - $itemAttributesBySku = $this->getFactory() - ->createCartItemsAttributeProvider() - ->getItemsAttributes($quoteTransfer, $selectedAttributes); - - $promotionStorageProducts = $this->getFactory() - ->getProductPromotionMapperPlugin() - ->mapPromotionItemsFromProductStorage( - $quoteTransfer, - $request - ); - - $factFinderSdkProductCampaignRequestTransfer = $this->getFactory() - ->createFactFinderSdkProductCampaignRequestTransfer(); - $factFinderSdkProductCampaignRequestTransfer->setProductNumber($cartItemsIds); - $factFinderSdkProductCampaignRequestTransfer->setSid($factFinderSid); - - $campaigns = $this->getCampaigns( - $factFinderSdkProductCampaignRequestTransfer, - $cartItems - ); - - return $this->viewResponse([ - 'cart' => $quoteTransfer, - 'cartItems' => $cartItems, - 'attributes' => $itemAttributesBySku, - 'cartItemsIds' => $cartItemsIds, - 'cartItemsNames' => $cartItemsNames, - 'voucherForm' => $voucherForm->createView(), - 'stepBreadcrumbs' => $stepBreadcrumbsTransfer, - 'promotionStorageProducts' => $promotionStorageProducts, - 'campaigns' => $campaigns, - ]); - } - -... -``` -
-
- -Then add recommendations widget to cart page template `src/Pyz/Yves/Cart/Theme/default/cart/index.twig`: - -```twig -{% raw %}{{{% endraw %} fact_finder_recommendations({id: cartItemsIds, mainId: cartItemsIds}, '@FactFinder/recommendations/products.twig') {% raw %}}}{% endraw %} -``` diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md deleted file mode 100644 index 7d26e9ad964..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Using FACT-Finder search suggestions -description: The FACT-Finder Suggest module enables you to provide customers with suggested search terms while they are entering a search term. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-suggest -originalArticleId: f607990d-14ec-467f-95d7-ab9ea783745e -redirect_from: - - /2021080/docs/search-factfinder-suggest - - /2021080/docs/en/search-factfinder-suggest - - /docs/search-factfinder-suggest - - /docs/en/search-factfinder-suggest - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html -related: - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html ---- - -## Prerequisites - -The FACT-Finder Suggest module enables you to provide customers with suggested search terms while they are entering a search term. In this way, users do not necessarily have to enter the entire search term themselves but can choose a suggestion. As the users are presented with similar search queries, it enables them to select a suitable, more precise search term and save time when searching. The FACT-Finder Suggest entries are provided by the product information in the Search database as well as from the recent frequently searched and found search terms. The suggestions in this database are no longer linked to the data in the product database, which is why filtering by attributes (such as category) is unfortunately not possible by default. - -## Usage - -To check example implementation, please see [Fact Finder - Search Integration](/docs/scos/dev/technology-partner-guides/{{page.version}}/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html). Typing in a search box triggers an API suggest request. By default , use `/fact-finder/suggestions` to get suggestions. Or you can use the `FactFinderSdk` module to make a suggest request. - -It will return a `FactFinderSdkSuggestResponseTransfer` object that contains an array of suggestions. - -Basic parameters: - -* `query` - Query text. -* `sid` - FACT-Finder session id. - -Controller example: -```php -query->get('query', '*'); - - $factFinderSuggestRequestTransfer->setQuery($query); - $factFinderSuggestRequestTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); - - $response = $this->getFactory() - ->getFactFinderClient() - ->getSuggestions($factFinderSuggestRequestTransfer); - - return $this->jsonResponse($response->getSuggestions()); -} - -... -``` - -`FactFinderSdkSuggestResponse` has array with suggests. FACT-Finder supports multiple suggest types. -The standard types are: Product name, Manufacturer, Category, Search term. We have created suggestion for Product name, Category, Search term, Brand in our demo. diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md deleted file mode 100644 index c326f078217..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: Using FACT-Finder search -description: FACT-Finder suggests error-tolerant on-site search. FACT-Finder delivers relevant results even when spelling errors and typos occur. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-search -originalArticleId: 4d1987e5-ae5c-4884-84ae-d5bc2eaa99a6 -redirect_from: - - /2021080/docs/search-factfinder-search - - /2021080/docs/en/search-factfinder-search - - /docs/search-factfinder-search - - /docs/en/search-factfinder-search - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Prerequisites - -FACT-Finder suggests error-tolerant on-site search. The online shop's search function is its most powerful sales tool. - -FACT-Finder delivers relevant results even when spelling errors and typos occur. - -## Usage - -By default, you can use the `/fact-finder` route to see an example catalog page. Another option is to use FactFinderSdk module client to request FACT-Finder API. All parameters from `GET` request will be sent to the FACT-Finder API. - -As a response, you'll receive a `FactFinderSdkSearchResponseTransfer` object that contains data, after search navigation, bread crumbs, paging. - -Basic parameters: - -* `query` - The search term indicates the term or phrase that is to be used to search in the FACT- Finder database. -* `channel` - If your search environment consists of multiple channels, you can define what channel to search here. If no channel is specified, the first channel in the channel list is used. -* `page` - If a search result contains many results, they will be divided into pages. It limits the amount of data that has to be sent in one go. You can indicate what page should be returned. Page numbering starts with 1. -* `productsPerPage` - In the FACT-Finder Management Interface, you can define the number of results that will be returned on a page by default. To change the number, you can set it with this parameter. -* `sort` - By default, the result that is returned has been sorted for relevance. However, you can specify a different sort order here. -* `filter` - When a filter parameter is sent to FACT-Finder, the Search engine only returns results that correspond to the filter indicated. -* `searchField` - Normally FACT-Finder searches all fields defined as searchable. However, it is possible to search only one specific field as well. -* `noArticleNumberSearch` - Normally an article number search is carried out if the search term matches one or more set formats. You can also use parameters to prevent an article number search from being carried out. -* `sid` - Session ID. -* `useAsn` - Controls whether or not the ASN (after-search navigation block) is created. -* `useFoundWords` - FACT-Finder is able to return the words that were used to find the data record for the located records. -* `useCampaigns` - If you want to prevent the Campaign Manager from checking whether the search query matches a campaign, use this parameter. -* `navigation` - FACT-Finder can also replicate your entire shop navigation. -* `idsOnly` - The result normally contains all field information about the products that have been found. -* `generateAdvisorTree` - This parameter is used in conjunction with advisor campaigns. -* `disableCache` - This parameter controls whether or not the search result cache is used. -* `followSearch` - The parameter is automatically attached to all follow-up parameter sets of a search result. The parameter must not be passed on initial requests. -* `usePersonalization` - Allows the activation / deactivation of the queries personalization. -* `useSemanticEnhancer` - Allows activation / deactivation of the semantic enhancement of queries. -* `useAso` - Allows the activation / deactivation of the automatic search optimization. - -Controller example: - -**Code sample** - - ```php -query->all(); - - $factFinderSearchRequestTransfer->setRequest($requestArray); - - $ffSearchResponseTransfer = $this->getFactory() - ->getFactFinderClient() - ->search($factFinderSearchRequestTransfer); - - if ($ffSearchResponseTransfer->getCampaignIterator()->getHasRedirect()) { - return $this->redirectResponseExternal($ffSearchResponseTransfer->getCampaignIterator()->getRedirectUrl()); - - } - - $feedbackForm = $this->getFactory() - ->createFeedbackForm(); - - if (!$ffSearchResponseTransfer->getResult()) { - $this->addErrorMessage('Search is not available at the moment'); - } - - return [ - 'searchResponse' => $ffSearchResponseTransfer, - 'pagingRote' => 'fact-finder', - 'lang' => Store::getInstance()->getCurrentLanguage(), - 'query' => isset($requestArray['query']) ? $requestArray['query'] : '', - 'page' => isset($requestArray['page']) ? $requestArray['page'] : '', - 'feedbackForm' => $feedbackForm->createView(), - ]; - } - -... -``` - -The FactFinder module includes templates. Templates can be used for changing the default partial templates in the following way: - -In `src/Pyz/Yves/Catalog/Theme/default/catalog/catalog.twig` you can put: - -```php -{% raw %}{%{% endraw %} include '@FactFinder/layout/catalog/filters.twig' with { - afterSearchNavigation: factFinderSearchResponse.getAfterSearchNavigation -} {% raw %}%}{% endraw %} - -{% raw %}{%{% endraw %} include '@FactFinder/layout/partials/sort.twig' {% raw %}%}{% endraw %} - -{% raw %}{%{% endraw %} include '@FactFinder/search/partials/pagination.twig' with { - showAlwaysFirstAndLast: true - } {% raw %}%}{% endraw %} -``` - -According to the template examples, you can set up default demoshop template for using FACT-Finder responses. - -## After Search - -`FactFinderSdkSearchResponseTransfer` has campaign iterator, bread crumbs, paging, search result, sorting parameters, result per page option, filter groups. - -You can build any front end and templates using those options in the response transfer object. - -### Filter Groups - -Default settings in the FACT-Finder admin panel are: - -For categories filter: - -* Source field -`CategoryPath` -* Field type -`CategoryPath` - -For price filter: - -* Source field - Price -* Field type - Number -* Range type - Slider - -For stock filter: - -* Source field - Stock -* Field type - Text -* Selection Type - Multi-select - -Filter groups have the following options (name - type): - -* filters -`FactFinderSdkDataFilter[]` -* name - string -* `detailedLinkCount` - int -* unit - string -* `isRegularStyle` - bool -* `isSliderStyle` - bool -* `isTreeStyle` - bool -* `isMultiSelectStyle` - bool -* `hasPreviewImages` - bool -* `hasSelectedItems` - bool -* `isSingleHideUnselectedType` - bool -* `isSingleShowUnselectedType` - bool -* `isMultiSelectOrType` - bool -* `isMultiSelectAndType` - bool -* `isTextType` - bool -* `isNumberType` - bool - -Filter has the following options (name - type): - -* item -`FactFinderSdkDataItem` -* `fieldName` - string -* `matchCount` - int -* `clusterLevel` - int -* `previewImage` - string -* `hasPreviewImage` - bool -* `absoluteMinimum` - string -* `absoluteMaximum` - string -* `selectedMinimum` - string -* `selectedMaximum` - string - -### Bread Crumbs - -Bread crumbs have following options (name - type): - -* item -`FactFinderSdkDataItem` -* `isSearchBreadCrumb` - bool -* `isFilterBreadCrumb` - bool -* `fieldName` - string - -### Paging - -Paging has the following options (name - type): - -* `pageCount` - int -* `firstPage` -`FactFinderSdkDataPage` -* `lastPage` -`FactFinderSdkDataPage` -* `previousPage` -`FactFinderSdkDataPage` -* `currentPage` -`FactFinderSdkDataPage` -* `nextPage` -`FactFinderSdkDataPage` - -Data page has the following options (name - type): - -* item -`FactFinderSdkDataItem` -* `pageNumber` - int - -Data item has the following options (name - type): - -* label - string -* url - string -* selected - bool - -### Sorting Options - -Is array of data items. diff --git a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md b/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md deleted file mode 100644 index 932b60cf8f6..00000000000 --- a/docs/scos/dev/technology-partner-guides/202204.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -title: Using FACT-Finder tracking -description: Tracking information lets the FACT-Finder Search tool automatically learn from the user behavior. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-tracking -originalArticleId: c84875c9-9cd3-40b6-a74f-8ea4abffe195 -redirect_from: - - /2021080/docs/search-factfinder-tracking - - /2021080/docs/en/search-factfinder-tracking - - /docs/search-factfinder-tracking - - /docs/en/search-factfinder-tracking - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html -related: - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Prerequisites - -Tracking information lets the FACT-Finder Search tool automatically learn from the user behavior. - -The data provided through this interface can be used for a variety of purposes. They include the tracking of events such as users clicking on a detail page, placing a product into the shopping cart and purchasing it. The information can form the basis for automated search optimization. It automatically improves the search result on the basis of the established consumer behavior. Information about product clicks, shopping cart, and purchase events, in other words, the user behavior, is required for the Personalization module, which provides tailored search results for each user. The information on product purchases can also be used as a basis for the Recommendation Engine module. - -Please note, that the personalization can only work if a proper session ID is sent with each search request. - -## Usage - -By default, you can use the `/fact-finder/track` route. According to the FACT-Finder documentation, you can use tracking `GET` parameters . The user session ID will be appended on a server side. - -* **General Parameters**: - - `id` - ID of the item for which information is to be sent. - - `masterId` (optional) - If your shop contains item versions and you need to transmit the item version number with the id parameter, you will need to transmit the master item number using this parameter to ensure that the products and the possible events can be assigned to each other. - - `channel` - The name of the FACT-Finder channel in which the search was conducted. - - `sid` - Use it to pass the user's session identifier. - - `event` - This parameter specifies the event type. Use the following values for the various types: - + click - + cart - + checkout - + login - + recommendationClick - + feedback - - `title` (optional) - The item name. - - `userId` (optional) - Use it to pass a user identifier. As with the session ID, it can be anonymized. - - `cookieId` (optional) - You use this parameter to pass a token that identifies the user over a longer period of time, even when not being logged in to the shop. -* Click on the detail page: - - `sid` - Use it to pass the user's session identifier. - - `query` - The search term for which the user has searched. - - `pos` - The position of the product in the search results. - - `origPos` - It transmits the original position of the item in the search result. - - `page` - The number of the search result page on which the selected product was displayed. - - `pageSize` (optional) - The number of products per search result page at the time the click was executed. - - `origPageSize` - The default number of products per search result page. - - `simi` (optional) - The FACT-Finder similarity value for the respective product. - - `campaign` - This field has the campaign ID as its value. -* Shopping basket and purchase information: - - `count` - Quantity of product purchased. - - `price` (optional) - Product price. - - `campaign` - The search result via a campaign. This field has the campaign ID as its value. -* User login: - - `sid` - Use this to pass the user's session identifier. - - `userId` - Use this to pass a user identifier. Like the session ID, this can be anonymized. -* Recommendation Engine click: - - `mainId` - ID of the article for which the clicked article was recommended. -* Search result feedback: - - `query` - The search term for which a search was conducted and on which feedback has been provided. - - `positive` - Send the value true at this point if the customer provided positive feedback. Send false if negative feedback was provided on the result. - - `message` (optional) - If the customer left a message as justification of their opinion, you can send it using this parameter. -* Shop cachehit: - - `page` - The number of the search result page on which the selected product was displayed. - - `pageSize` - The number of products per search result page at the time the click was executed. - - `query` - The search term for which a search was conducted and on which feedback has been provided. - - `hitCount` - The amount of products found in the search result. - - `searchTime` - The time which was needed to create the search result. - - `bestSimi` - Similarity of the best product. - - `minSimi` - Similarity of the last product. - - `filterfieldName` (optional) - Information about active filters in the search result. - - `searchField` (optional) - The field for which the search was performed in case the search was limited to a specific field. - - `customSorting` (optional) - If the default sorting was not used for the search result, then please send a true. - - `additionalInfo`` (optional) - You may use this parameter to add something to the log entry, such as to enable searching the log for a specific entry. -* Suggest Tracking: - - `queryFromSuggest` - This parameter indicates that the FACT-Finder query was triggered through a selection from the suggestion list. In this case send the parameter with the value true. - - `userInput` - Please use this parameter to send the order of letters the shop user entered until the search query was triggered. - -To use tracking on the back-end, provide the dependency to your module dependency provider. - -**Code sample** - - ```php -getLocator()->factFinderSdk()->client(); - }; - - return $container; - } - -{% raw %}{%{% endraw %} endhighlight {% raw %}%}{% endraw %} - -Add a new function to your module factory. - -{% raw %}{%{% endraw %} highlight php linenos {% raw %}%}{% endraw %} -getProvidedDependency(YourBundleDependencyProvider::FACT_FINDER_CLIENT); - } -``` - -Login tracking could be added to a `Pyz\Yves\Customer\Plugin\Provider\CustomerAuthenticationSuccessHandler` on `AuthenticationSuccess` function. - -Example of a user login tracking function: - -```php -setEvent(CustomerConstants::LOGIN_TRACKING); - $trackingTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); - $trackingTransfer->setUserId(md5($customer->getEmail())); - - $this->factFinderSdkClient->track($trackingTransfer); - } -``` - -Shopping basket tracking function could be added to a `Yves\Cart\Handler\CartOperationHandler` changeQuantity and add functions. - -Add a session client and a fact finder sdk client to the `CartOperationHandler` class via a `DependencyProvider`. - -Example of an add to cart tracking function: - -```php -getCurrentItemTransfer($quoteTransfer, $sku); - - if ($trackItemTransfer) { - $trackRequestTransfer = new FactFinderSdkTrackingRequestTransfer(); - $trackRequestTransfer->setId($trackItemTransfer->getSku()) - ->setMasterId() // generate and add an abstract product sku - ->setEvent(static::CART_TRACK_EVENT_NAME) // static::CART_TRACK_EVENT_NAME === 'cart' - ->setCount($quantity) - ->setPrice($trackItemTransfer->getUnitPrice() / 100) - ->setSid($this->sessionClient->getId()); - - return $this->factFinderSdkClient->track($trackRequestTransfer); - } - - return new FactFinderSdkTrackingResponseTransfer(); - } -``` diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md deleted file mode 100644 index c39e14abfe0..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: Exporting product data for FACT-Finder -description: Export data to FACT-Finder CSV by applying the configuration. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-export-csv -originalArticleId: 431824f4-acc7-4a60-8b02-dd450427c1e3 -redirect_from: - - /2021080/docs/search-factfinder-export-csv - - /2021080/docs/en/search-factfinder-export-csv - - /docs/search-factfinder-export-csv - - /docs/en/search-factfinder-export-csv - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: FACT-Finder - link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html ---- - -## Output Folder - -Define an output folder where the CSV files will be generated by adding the following line in your configuration file: -```php - [ - 'url' => 'http://search-web-components.fact-finder.de/FACT-Finder-7.2', - 'version' => '7.2', - 'default-query' => 'trousers', - 'channel' => 'heroku-fact-finder-de_DE', - 'search-immediate' => false, - ], -]; -... -``` - -To set up the components configuration, use the following config code as an example: - -
-config/Shared/config_default.php - -```php -... -$config[FactFinderWebComponentsConstants::BREADCRUMB_COMPONENT_CONFIG] = [ - 'properties' => [ - 'show-only' => false, - ], - 'items' => [ - 'search', - 'filter', - 'advisor', - ], -]; - -$config[FactFinderWebComponentsConstants::SEARCH_BOX_COMPONENT_CONFIG] = [ - 'properties' => [ - 'suggest-onfocus' => 'true', - 'use-suggest' => 'true', - ], -]; - -$config[FactFinderWebComponentsConstants::SEARCH_BUTTON_COMPONENT_CONFIG] = [ - 'suggest-onfocus' => false, - 'hidesuggest-onblur' => true, - 'select-onclick' => false, - 'use-suggest' => false, - 'suggest-delay' => 0, -]; - -$config[FactFinderWebComponentsConstants::HEADER_NAVIGATION_COMPONENT_CONFIG] = [ - 'properties' => [ - 'group-count' => 4, - 'group-size' => 4, - 'hide-empty-groups' => '1', - 'fetch-initial' => '1', - ], -]; - -$config[FactFinderWebComponentsConstants::SUGGEST_CONFIG] = [ - 'properties' => [], - 'productItemType' => 'productName', - 'searchItems' => [ - [ - 'type' => 'searchTerm', - 'title' => 'Search term', - ], - [ - 'type' => 'category', - 'title' => 'Category', - ], - [ - 'type' => 'brand', - 'title' => 'Brand', - ], - ], -]; - -$config[FactFinderWebComponentsConstants::RECORD_LIST_COMPONENT_CONFIG] = [ - 'properties' => [], - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::CHECKOUT_TRACKING_CONFIG] = [ - 'properties' => [ - 'disable-auto-tracking' => true, - ], - 'items' => [ - [ - 'recordId' => 'd44c3c7b5e52f7a6b27041c1e789e954', - 'count' => '2', - ], - [ - 'recordId' => '19532fa96a8e60a27328f01520cc4', - 'count' => '4', - ], - ], -]; - -$config[FactFinderWebComponentsConstants::RECORD_COMPONENT_CONFIG] = [ - 'subscribe' => 'true', - 'is-recommendation' => false, - 'infinite-scrolling' => true, - 'infinite-debounce-delay' => 32, - 'infinite-scroll-margin' => 0, -]; - -$config[FactFinderWebComponentsConstants::ASN_GROUP_COMPONENT_CONFIG] = [ - 'opened' => false, - 'collapsible' => true, - 'lazy-load' => true, -]; - -$config[FactFinderWebComponentsConstants::ASN_GROUP_ELEMENT_CONFIG] = [ - 'selected' => true, -]; - -$config[FactFinderWebComponentsConstants::ASN_REMOVE_ALL_FILTER_CONFIG] = [ - 'align' => 'vertical', - 'show-always' => true, - 'remove-params' => false, -]; - -$config[FactFinderWebComponentsConstants::ASN_SLIDER_CONFIG] = [ - 'properties' => [ - 'align' => 'vertical', - ], -]; - -$config[FactFinderWebComponentsConstants::ASN_SLIDER_CONTROL_CONFIG] = [ - 'submit-on-input' => true, -]; - -$config[FactFinderWebComponentsConstants::PAGING_COMPONENT_CONFIG] = [ - 'properties' => [ - ], -]; - -$config[FactFinderWebComponentsConstants::PRODUCTS_PER_PAGE_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'dropdown' => '', - 'list' => '', - 'item' => '', -]; - -$config[FactFinderWebComponentsConstants::SORT_BOX_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'items' => [ - [ - 'key' => 'default.template', - 'title' => 'factfinder.web-components.sort.box.default.style', - ], - [ - 'key' => 'Price.asc', - 'title' => 'factfinder.web-components.sort.box.overriden.for', - ], - [ - 'key' => 'null.desc', - 'title' => 'factfinder.web-components.sort.box.relevance', - ], - ], -]; - -$config[FactFinderWebComponentsConstants::SIMILAR_PRODUCTS_COMPONENT_CONFIG] = [ - 'properties' => [ - 'max-results' => 4, - ], - 'list' => '', - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::SIMILAR_PRODUCT_ID_CONFIG] = [ - 'recordId' => 'd44c3c7b5e52f7a6b27041c1e789e954', -]; - -$config[FactFinderWebComponentsConstants::RECOMMENDATION_CONFIG] = [ - 'properties' => [ - 'max-results' => 4, - ], - 'list' => '', - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::RECOMMENDATION_RECORD_ID_CONFIG] = [ - 'recordId' => '19532fa96a8e60a27328f01520cc4', -]; - -$config[FactFinderWebComponentsConstants::TAG_CLOUD_COMPONENT_CONFIG] = [ - 'properties' => [ - ], -]; - -$config[FactFinderWebComponentsConstants::PUSHED_PRODUCTS_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'list' => '', - 'record' => '', -]; - -$config[FactFinderWebComponentsConstants::CAMPAIGN_COMPONENT_CONFIG] = [ - 'properties' => [ - ], - 'answer' => '', - 'question' => '', - 'feedbacktext' => '', -]; -... -``` - -
- -## Integration into the project - -**frontend/settings.js** - -```js -// define project relative paths to context -const paths = { - ... - - // eco folders - eco: { - // all modules - modules: './vendor/spryker-eco' - }, - - // project folders - project: { - ... - } -}; - -// export settings -module.exports = { - ... - - // define settings for suite-frontend-builder finder - find: { - // webpack entry points (components) finder settings - componentEntryPoints: { - // absolute dirs in which look for - dirs: [ - ... - path.join(context, paths.eco.modules), - ... - ], - ... - }, - - ... - } -} -``` - -**src/Pyz/Yves/ShopUi/Theme/default/vendor.ts** - -```js -// add ff-web-components polyfill -import 'ff-web-components/dist/bundle'; -``` - -**package.json** - -```json -"dependencies": { - "ff-web-components": "git+https://github.com/FACT-Finder-Web-Components/ff-web-components.git#release/3.0" -}, -``` - -## Frontend integration - -Add the required communication element: - -```twig -{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include atom('communication', 'FactFinderWebComponents') with { - data: { - properties: { - component: 'url="http://search-web-components.fact-finder.de/FACT-Finder-7.2" version="7.2" default-query="trousers" channel="bergfreunde-co-uk" search-immediate="true"' - } - } - } only {% raw %}%}{% endraw %} - -{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} -``` - -Add a widget: -```twig -{% raw %}{%{% endraw %} block content {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include atom('communication', 'FactFinderWebComponents') with { - data: { - properties: { - component: 'url="http://search-web-components.fact-finder.de/FACT-Finder-7.2" version="7.2" default-query="trousers" channel="bergfreunde-co-uk" search-immediate="true"' - } - } - } only {% raw %}%}{% endraw %} - - {% raw %}{%{% endraw %} include atom('header-navigation', 'FactFinderWebComponents') with { - data: { - properties: { - component: 'group-count="4" group-size="4" hide-empty-groups="1" fetch-initial="1"' - } - } - } only {% raw %}%}{% endraw %} -{% raw %}{%{% endraw %} endblock {% raw %}%}{% endraw %} -``` diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md deleted file mode 100644 index f2537318cb9..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Installing and configuring FACT-Finder -description: This article provides details on the installation and configuration of the FACT-Finder module. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/fact-finder-installation-and-configuration -originalArticleId: 5d9650ca-e38b-4c41-ade5-e767e9878a73 -redirect_from: - - /2021080/docs/fact-finder-installation-and-configuration - - /2021080/docs/en/fact-finder-installation-and-configuration - - /docs/fact-finder-installation-and-configuration - - /docs/en/fact-finder-installation-and-configuration - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html -related: - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Installation - -Composer dependency: - -To install Spryker's FactFinder module, use [composer](https://getcomposer.org/): -```php -composer require spryker-eco/fact-finder-sdk -composer require spryker-eco/fact-finder -``` - -If you faced an issue with the FACT-Finder library dependency and it is not installed, please use the following instructions: - -1. Add `composer.json`> file to the respective section of your project, `FACT-Finder/FACT-Finder-PHP-Library": "1.3.*` -2. Add to the repositories section: - ```json -{"type": "git","url": "git@github.com:FACT-Finder/FACT-Finder-PHP-Library.git"} -``` -3. Run `composer update` command: -```bash -composer update -``` - -## Channel Configuration - -Channel Management in FACT-Finder admin panel can be used for creating and removing the channels. It also creates parent-child hierarchy and manages backups. - -By default, channel settings should be the following: - -* File encoding - `UTF-8` -* Enclosing (quote) character - `"` -* Field separator - `,` -* Number of header lines - `1` -* Data record ID - `ProductNumber` -* Product number for tracking - `ProductNumber` diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md deleted file mode 100644 index b1e6aeb5f6f..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.md +++ /dev/null @@ -1,569 +0,0 @@ ---- -title: Installing and configuring FACT-Finder NG API -description: Fact Finder NG API integration is used for search, tracking, and importing endpoints. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/fact-finder-ng -originalArticleId: 90e6b6fb-5a4a-4efc-a798-02fb8009c493 -redirect_from: - - /2021080/docs/fact-finder-ng - - /2021080/docs/en/fact-finder-ng - - /docs/fact-finder-ng - - /docs/en/fact-finder-ng - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Installation -To install the package use `composer require spryker-eco/fact-finder-ng` command. - -## Configuration -For using the package you have to set configuration parameters. -```php -$config[FactFinderNgConstants::FACT_FINDER_URL] = ''; # Fact-Finder URL -$config[FactFinderNgConstants::FACT_FINDER_CHANNEL] = ''; # Fact-Finder channel value -$config[FactFinderNgConstants::FACT_FINDER_USERNAME] = ''; # Fact-Finder user for authorization. -$config[FactFinderNgConstants::FACT_FINDER_PASSWORD] = ''; # Fact-Finder password for authorization. -``` -## Import Usage -Fact-Finder has an import API call. It can be used to update product information by URL set on the Fact-Finder side. To trigger the import, you have to add Console command to `ConsoleDependecyProvider`. - -**ConsoleDependencyProvider.php** - -```php -factFinderNgClient->trackCheckoutEvent($this->preparedCheckoutEventTransfers($quoteTransfer)); - - return parent::execute($request, $quoteTransfer); - } - - /** - * @param QuoteTransfer $quoteTransfer - * - * @return CartOrCheckoutEventTransfer[] - */ - protected function preparedCheckoutEventTransfers(QuoteTransfer $quoteTransfer): array - { - $eventTransfers = []; - foreach ($quoteTransfer->getItems() as $itemTransfer) { - $eventTransfer = new CartOrCheckoutEventTransfer(); - $eventTransfer->setCount($itemTransfer->getQuantity()); - $eventTransfer->setId($itemTransfer->getSku()); - $eventTransfer->setMasterId($itemTransfer->getAbstractSku()); - $eventTransfer->setPrice($itemTransfer->getUnitPriceToPayAggregation()); - $eventTransfer->setSid(uniqid()); - - $eventTransfers[] = $eventTransfer; - } - - return $eventTransfers; - } -} -``` - -## Search, Suggestion, Navigation Usage -For using search functions, you have to extend SearchClient on the project level. If you want to use different search engines, you might need to create search router, for choosing the right engine. - -**SearchRouter** - -```php -searchPlugins = $searchPlugins; - } - - /** - * Resolve here what the handler should be work - * - * @param \Spryker\Client\Search\Dependency\Plugin\QueryInterface $searchQuery - * @param array $resultFormatters - * @param array $requestParameters - * - * @return array|\Elastica\ResultSet - */ - public function search(QueryInterface $searchQuery, array $resultFormatters = [], array $requestParameters = []) - { - foreach ($this->searchPlugins as $searchPlugin) { - if ($searchPlugin->isApplicable($requestParameters)) { - return $searchPlugin->handle($searchQuery, $resultFormatters, $requestParameters); - } - } - - return []; - } -} -``` - -If you want to use ElasticSearch for specific cases, you have to create a plugin on the project level - -**ElasticSearchHandlerPlugin** - -```php -getFactory()->createElasticsearchSearchHandler()->search($searchQuery, $resultFormatters, $requestParameters); - } - - /** - * @param array $requestParameters - * - * @return bool - */ - public function isApplicable(array $requestParameters): bool - { - return true; - } -} -``` - -The Fact-Finder Ng module contains plugins for choosing search, suggestion, or navigation request should be used. By now you can create plugin stack in `SearchDependencyProvider` for using in `SearchRouter`. - -**SearchDependencyProvider** - -```php -provideFactFinderNgClient($container); - $container = $this->addSearchPlugins($container); - - return $container; - } - - /** - * @return \Pyz\Client\Search\Plugin\SearchHandlerPluginInterface[] - */ - protected function getSearchPlugins(): array - { - return [ - new FactFinderNgNavigationHandlerPlugin(), - new FactFinderNgSearchHandlerPlugin(), - new FactFinderNgSuggestHandlerPlugin(), - new ElasticSearchHandlerPlugin(), - ]; - } - - /** - * @param \Spryker\Client\Kernel\Container $container - * - * @return \Spryker\Client\Kernel\Container - */ - protected function provideFactFinderNgClient(Container $container): Container - { - $container[static::CLIENT_FACT_FINDER_NG] = function (Container $container) { - return $container->getLocator()->factFinderNg()->client(); - }; - - return $container; - } - - /** - * @param \Spryker\Client\Kernel\Container $container - * - * @return \Spryker\Client\Kernel\Container - */ - protected function addSearchPlugins(Container $container): Container - { - $container[static::PLUGINS_SEARCH] = function () { - return $this->getSearchPlugins(); - }; - - return $container; - } -} -``` - -Then SearchClient can be adjusted: - -**SearchRouter** - -```php -getFactory() - ->createSearchRouter() - ->search($searchQuery, $resultFormatters, $requestParameters); - } -} -``` - -The idea that you have to adjust places, where the search is called for adding needed params to request parameters. For example, you can adjust `SuggestionController` for adding a suggest parameter, so `FactFinderNgSuggestHandlerPlugin` will know that it should be called. - -**SuggestionController** - -```php -query->get(self::PARAM_SEARCH_QUERY); - - if (!$searchString) { - return $this->jsonResponse(); - } - - $requestParameters = array_merge($request->query->all(), ['suggest' => 1]); # Here you add new request parameter. - - $searchResults = $this - ->getFactory() - ->getCatalogClient() - ->catalogSuggestSearch($searchString, $requestParameters); - - return $this->jsonResponse([ - 'completion' => ($searchResults['completion'] ? $searchResults['completion'][0] : null), - 'suggestion' => $this->renderView('@CatalogPage/views/suggestion-results/suggestion-results.twig', $searchResults)->getContent(), - ]); - } -} -``` - -## Pagination, Sorting, and Filters -### Pagination -For the Yves layer, pagination should work out of the box. Request mapper cares about page and ipp (items for page) parameters and map it to Fact-Finder parameters. - -If you use the Glue layer, you have to add page and ipp value to request parameters. - -### Sorting -By default, the Yves layer doesn't care about sort options which suggested by Fact-Finder. If you want to use them, you have to change `SortedResultFormatterPlugin` in `CatalogDependencyProvider`. -```php -buildRoute('/factfinder', 'FactFinder', 'Search', 'index'); - $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_SEARCH, $route); - - $route = $this->buildRoute('/factfinder/suggestions', 'FactFinder', 'Suggestions', 'index'); - $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_SEARCH, $route); - - $route = $this->buildRoute('/factfinder/track', 'FactFinder', 'Track', 'index'); - $routeCollection->add(static::ROUTE_NAME_FACT_FINDER_TRACK, $route); - - $route = $this->buildRoute('/factfinder/recommendations', 'FactFinder', 'Recommendations', 'index'); - $routeCollection->add(static::ROUTE_FACT_FINDER_RECOMMENDATIONS, $route); - - return $routeCollection; - } -} -``` - -2. Then add the created route provider to the `RouterDependencyProvider` file: Expand a code sample - -```php -provideClients($container); - - return $container; - } - - /** - * @param \Spryker\Yves\Kernel\Container $container - * - * @return \Spryker\Yves\Kernel\Container - */ - protected function provideClients(Container $container) - { - $container[self::FACT_FINDER_SDK_CLIENT] = function () use ($container) { - return $container->getLocator() - ->factFinderSdk() - ->client(); - }; - - return $container; - } - -} -``` -2. Add it to your factory: - -```php -getProvidedDependency(FactFinderDependencyProvider::FACT_FINDER_SDK_CLIENT); - } - - ... - -} -``` diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md deleted file mode 100644 index 15d63f47b07..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: Using FACT-Finder campaigns -description: The FACT-Finder Campaign Manager module allows you to target the management of search results in order to improve the customer lead process or deliberately highlight products. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-campaigns -originalArticleId: c9ceca36-2c18-45b1-840b-be14f926645c -redirect_from: - - /2021080/docs/search-factfinder-campaigns - - /2021080/docs/en/search-factfinder-campaigns - - /docs/search-factfinder-campaigns - - /docs/en/search-factfinder-campaigns - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html -related: - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: FACT-Finder - link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html ---- - -## Prerequisites - -The FACT-Finder Campaign Manager module allows you to target the management of search results in order to improve the customer lead process or deliberately highlight products. -Campaigns are activated according to the specific criteria and are then returned accordingly in the search results. - -Campaigns are a powerful tool for visual merchandising. One of their numerous functions is automatic redirects to static pages for specific search terms, e.g. searching for "ToS" automatically redirects the user to the terms of service page. Even more importantly, campaigns allow for targeted placement of banners or the customization of search results. - -These types of the campaign can be created with the Campaign Assistant: - -* **Feedback Campaigns**: Display preset texts and banners with search results. Also used for pushed products. -* **Redirect Campaigns**: Redirect the user to the specific pages for certain search terms. -* **Advisor Campaigns**: Manages questions and answers that are presented to the shop visitor. Answers lead to specific product sets. -* **Product Campaigns**: Allows you to place campaigns on product pages instead of search result pages. - -### Feedback Campaign - -Feedback campaigns add predefined banners, texts, and products aimed to search results in reaction to specific search terms or other triggers. -These campaigns are best suited to pushing products. -A feedback campaign can also be used to place videos, point the customer towards the brand stores or to the designed zero-result pages. - -### Redirect Campaign - -Redirect campaigns react to triggers like search words and send users to specific pages, like Contact, ToS, etc. -Every webstore has a number of pages that should be available in this way. -Apart from the contact form and terms of service, payment and shipping conditions, as well as the about page, fall into that list. - -### Redirect Campaign - -Advisor campaigns give you the ability to set up questions as text or images which are presented to the customer in certain situations. -You group the questions with the preset answers the customer can choose. Each answer is combined with a product set which is displayed to the user on giving the answer. This gives you the ability to guide the user with targeted questions. -Advisor campaigns are especially useful to react to rising trends or frequently used filter combinations. - -### Product Campaign - -Product campaigns can be placed on any product detail page, shopping cart page or shop page and display a specific product set. -They employ the same method of defining product sets but are different in the way they are triggered. - -## Usage - -### Search Page - -Search result campaigns are fetched implicitly by invoking a search request. Examples of integration of advisor, redirect, feedback and pushed products campaigns can be found in `vendor/spryker-eco/fact-finder/src/SprykerEco/Yves/FactFinder/Theme/default/search/catalog.twig` - -### Product Details Page - -To fetch Fact-Finder campaigns for product page, you need to make a call using Fact-Finder client. To do that: - -1. Add FactFinder client to dependency provider: - -**Code sample** - -```php -provideClients($container); - - return $container; - } - - /** - * @param \Spryker\Yves\Kernel\Container $container - * - * @return \Spryker\Yves\Kernel\Container - */ - protected function provideClients(Container $container) - { - ... - - $container[self::CLIENT_FACT_FINDER] = function (Container $container) { - return $container->getLocator()->factFinderSdk()->client(); - }; - - return $container; - } - -} -``` - -2. Add methods to get FactFinder client and to create product campaign request transfer: - -**Code sample** - - ```php -getProvidedDependency(ProductDependencyProvider::CLIENT_FACT_FINDER); - } - - /** - * @return \Generated\Shared\Transfer\FactFinderSdkProductCampaignRequestTransfer - */ - public function createFactFinderSdkProductCampaignRequestTransfer() - { - return new FactFinderSdkProductCampaignRequestTransfer(); - } - -} - ``` - -3. Fetch product campaigns from controller: - -**Code sample** - - ```php -getFactory() - ->createFactFinderSdkProductCampaignRequestTransfer(); - $factFinderSdkProductCampaignRequestTransfer->addProductNumber($storageProductTransfer->getIdProductAbstract()); - $factFinderSdkProductCampaignRequestTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); - $factFinderProductCampaignResponseTransfer = $this->getFactory() - ->getFactFinderClient() - ->getProductCampaigns($factFinderSdkProductCampaignRequestTransfer); - $campaigns = $factFinderProductCampaignResponseTransfer->getCampaignIterator()->getCampaigns(); - - $productData = [ - ... - 'campaigns' => $campaigns, - ]; - - return $productData; - } -} -``` - -4. Inject feedback campaign templates into product details template, indicating position of campaign widget in `feedbackBlockPositionId` parameter e.g.: - -```php -{% raw %}{%{% endraw %} if campaigns is defined {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include '@FactFinder/campaigns/partials/feedback.twig' with { - campaigns: campaigns, - feedbackBlockPositionId: 'product detail - above product', - } {% raw %}%}{% endraw %} -{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} -``` -Additionally, you might need to add some more feedback widgets to general layout in `src/Pyz/Yves/Application/Theme/default/layout/layout.twig` -5. Inject pushed products campaign template into product details template, e.g.: - -```php -{% raw %}{%{% endraw %} if campaigns is defined {% raw %}%}{% endraw %} - {% raw %}{%{% endraw %} include '@FactFinder/campaigns/partials/pushed-products.twig' with { - campaigns: campaigns, - } {% raw %}%}{% endraw %} -{% raw %}{%{% endraw %} endif {% raw %}%}{% endraw %} -``` - -### Cart Page - -To fetch Fact-Finder campaigns for cart page, perform the same actions as for product page, but under Cart module namespace. diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md deleted file mode 100644 index b34295ac476..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: Using FACT-Finder recommendation engine -description: The FACT-Finder recommendation engine analyzes product and category relationships. The results are rendered in recommendations widget, which can be displayed on product details pages, homepage or in the shopping cart. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-recommendation -originalArticleId: e3d079b4-2197-4009-a2f9-df27739a4b7f -redirect_from: - - /2021080/docs/search-factfinder-recommendation - - /2021080/docs/en/search-factfinder-recommendation - - /docs/search-factfinder-recommendation - - /docs/en/search-factfinder-recommendation - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: FACT-Finder - link: docs/pbc/all/miscellaneous/page.version/third-party-integrations/marketing-and-conversion/analytics/fact-finder/fact-finder.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html ---- - -## Prerequisites - -The FACT-Finder recommendation engine analyzes product and category relationships. The results are rendered in recommendations widget, which can be displayed on product details pages, homepage or in the shopping cart. - -## Usage - -To add recommendations widget to product page, insert the following code into `src/Pyz/Yves/Product/Theme/default/product/detail.twig`: -```html -{% raw %}{{{% endraw %} fact_finder_recommendations({id: product.sku, mainId: product.idProductAbstract}, '@FactFinder/recommendations/products.twig') {% raw %}}}{% endraw %} -``` -To add recommendations widget to cart page, modify cart controller (`src/Pyz/Yves/Cart/Controller/CartController.php`) to add array of product ids into template variables: - -
-Click here to expand the code sample - -```php -getClient() - ->getQuote(); - - $factFinderSid = $request->cookies->get(FactFinderConstants::COOKIE_SID_NAME); - $quoteTransfer->setFactFinderSid($factFinderSid); - - $voucherForm = $this->getFactory() - ->getVoucherForm(); - - $cartItems = $this->getFactory() - ->createProductBundleGrouper() - ->getGroupedBundleItems($quoteTransfer->getItems(), $quoteTransfer->getBundleItems()); - - $cartItemsIds = []; - $cartItemsNames = []; - foreach ($cartItems as $cartItem) { - $cartItemsNames[] = $cartItem->getName(); - $cartItemsIds[] = $cartItem->getSku(); - } - - $stepBreadcrumbsTransfer = $this->getFactory() - ->getCheckoutBreadcrumbPlugin() - ->generateStepBreadcrumbs($quoteTransfer); - - $itemAttributesBySku = $this->getFactory() - ->createCartItemsAttributeProvider() - ->getItemsAttributes($quoteTransfer, $selectedAttributes); - - $promotionStorageProducts = $this->getFactory() - ->getProductPromotionMapperPlugin() - ->mapPromotionItemsFromProductStorage( - $quoteTransfer, - $request - ); - - $factFinderSdkProductCampaignRequestTransfer = $this->getFactory() - ->createFactFinderSdkProductCampaignRequestTransfer(); - $factFinderSdkProductCampaignRequestTransfer->setProductNumber($cartItemsIds); - $factFinderSdkProductCampaignRequestTransfer->setSid($factFinderSid); - - $campaigns = $this->getCampaigns( - $factFinderSdkProductCampaignRequestTransfer, - $cartItems - ); - - return $this->viewResponse([ - 'cart' => $quoteTransfer, - 'cartItems' => $cartItems, - 'attributes' => $itemAttributesBySku, - 'cartItemsIds' => $cartItemsIds, - 'cartItemsNames' => $cartItemsNames, - 'voucherForm' => $voucherForm->createView(), - 'stepBreadcrumbs' => $stepBreadcrumbsTransfer, - 'promotionStorageProducts' => $promotionStorageProducts, - 'campaigns' => $campaigns, - ]); - } - -... -``` -
-
- -Then add recommendations widget to cart page template `src/Pyz/Yves/Cart/Theme/default/cart/index.twig`: - -```twig -{% raw %}{{{% endraw %} fact_finder_recommendations({id: cartItemsIds, mainId: cartItemsIds}, '@FactFinder/recommendations/products.twig') {% raw %}}}{% endraw %} -``` diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md deleted file mode 100644 index 7d26e9ad964..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Using FACT-Finder search suggestions -description: The FACT-Finder Suggest module enables you to provide customers with suggested search terms while they are entering a search term. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-suggest -originalArticleId: f607990d-14ec-467f-95d7-ab9ea783745e -redirect_from: - - /2021080/docs/search-factfinder-suggest - - /2021080/docs/en/search-factfinder-suggest - - /docs/search-factfinder-suggest - - /docs/en/search-factfinder-suggest - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html -related: - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html ---- - -## Prerequisites - -The FACT-Finder Suggest module enables you to provide customers with suggested search terms while they are entering a search term. In this way, users do not necessarily have to enter the entire search term themselves but can choose a suggestion. As the users are presented with similar search queries, it enables them to select a suitable, more precise search term and save time when searching. The FACT-Finder Suggest entries are provided by the product information in the Search database as well as from the recent frequently searched and found search terms. The suggestions in this database are no longer linked to the data in the product database, which is why filtering by attributes (such as category) is unfortunately not possible by default. - -## Usage - -To check example implementation, please see [Fact Finder - Search Integration](/docs/scos/dev/technology-partner-guides/{{page.version}}/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html). Typing in a search box triggers an API suggest request. By default , use `/fact-finder/suggestions` to get suggestions. Or you can use the `FactFinderSdk` module to make a suggest request. - -It will return a `FactFinderSdkSuggestResponseTransfer` object that contains an array of suggestions. - -Basic parameters: - -* `query` - Query text. -* `sid` - FACT-Finder session id. - -Controller example: -```php -query->get('query', '*'); - - $factFinderSuggestRequestTransfer->setQuery($query); - $factFinderSuggestRequestTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); - - $response = $this->getFactory() - ->getFactFinderClient() - ->getSuggestions($factFinderSuggestRequestTransfer); - - return $this->jsonResponse($response->getSuggestions()); -} - -... -``` - -`FactFinderSdkSuggestResponse` has array with suggests. FACT-Finder supports multiple suggest types. -The standard types are: Product name, Manufacturer, Category, Search term. We have created suggestion for Product name, Category, Search term, Brand in our demo. diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md deleted file mode 100644 index c326f078217..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: Using FACT-Finder search -description: FACT-Finder suggests error-tolerant on-site search. FACT-Finder delivers relevant results even when spelling errors and typos occur. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-search -originalArticleId: 4d1987e5-ae5c-4884-84ae-d5bc2eaa99a6 -redirect_from: - - /2021080/docs/search-factfinder-search - - /2021080/docs/en/search-factfinder-search - - /docs/search-factfinder-search - - /docs/en/search-factfinder-search - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html -related: - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder tracking - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Prerequisites - -FACT-Finder suggests error-tolerant on-site search. The online shop's search function is its most powerful sales tool. - -FACT-Finder delivers relevant results even when spelling errors and typos occur. - -## Usage - -By default, you can use the `/fact-finder` route to see an example catalog page. Another option is to use FactFinderSdk module client to request FACT-Finder API. All parameters from `GET` request will be sent to the FACT-Finder API. - -As a response, you'll receive a `FactFinderSdkSearchResponseTransfer` object that contains data, after search navigation, bread crumbs, paging. - -Basic parameters: - -* `query` - The search term indicates the term or phrase that is to be used to search in the FACT- Finder database. -* `channel` - If your search environment consists of multiple channels, you can define what channel to search here. If no channel is specified, the first channel in the channel list is used. -* `page` - If a search result contains many results, they will be divided into pages. It limits the amount of data that has to be sent in one go. You can indicate what page should be returned. Page numbering starts with 1. -* `productsPerPage` - In the FACT-Finder Management Interface, you can define the number of results that will be returned on a page by default. To change the number, you can set it with this parameter. -* `sort` - By default, the result that is returned has been sorted for relevance. However, you can specify a different sort order here. -* `filter` - When a filter parameter is sent to FACT-Finder, the Search engine only returns results that correspond to the filter indicated. -* `searchField` - Normally FACT-Finder searches all fields defined as searchable. However, it is possible to search only one specific field as well. -* `noArticleNumberSearch` - Normally an article number search is carried out if the search term matches one or more set formats. You can also use parameters to prevent an article number search from being carried out. -* `sid` - Session ID. -* `useAsn` - Controls whether or not the ASN (after-search navigation block) is created. -* `useFoundWords` - FACT-Finder is able to return the words that were used to find the data record for the located records. -* `useCampaigns` - If you want to prevent the Campaign Manager from checking whether the search query matches a campaign, use this parameter. -* `navigation` - FACT-Finder can also replicate your entire shop navigation. -* `idsOnly` - The result normally contains all field information about the products that have been found. -* `generateAdvisorTree` - This parameter is used in conjunction with advisor campaigns. -* `disableCache` - This parameter controls whether or not the search result cache is used. -* `followSearch` - The parameter is automatically attached to all follow-up parameter sets of a search result. The parameter must not be passed on initial requests. -* `usePersonalization` - Allows the activation / deactivation of the queries personalization. -* `useSemanticEnhancer` - Allows activation / deactivation of the semantic enhancement of queries. -* `useAso` - Allows the activation / deactivation of the automatic search optimization. - -Controller example: - -**Code sample** - - ```php -query->all(); - - $factFinderSearchRequestTransfer->setRequest($requestArray); - - $ffSearchResponseTransfer = $this->getFactory() - ->getFactFinderClient() - ->search($factFinderSearchRequestTransfer); - - if ($ffSearchResponseTransfer->getCampaignIterator()->getHasRedirect()) { - return $this->redirectResponseExternal($ffSearchResponseTransfer->getCampaignIterator()->getRedirectUrl()); - - } - - $feedbackForm = $this->getFactory() - ->createFeedbackForm(); - - if (!$ffSearchResponseTransfer->getResult()) { - $this->addErrorMessage('Search is not available at the moment'); - } - - return [ - 'searchResponse' => $ffSearchResponseTransfer, - 'pagingRote' => 'fact-finder', - 'lang' => Store::getInstance()->getCurrentLanguage(), - 'query' => isset($requestArray['query']) ? $requestArray['query'] : '', - 'page' => isset($requestArray['page']) ? $requestArray['page'] : '', - 'feedbackForm' => $feedbackForm->createView(), - ]; - } - -... -``` - -The FactFinder module includes templates. Templates can be used for changing the default partial templates in the following way: - -In `src/Pyz/Yves/Catalog/Theme/default/catalog/catalog.twig` you can put: - -```php -{% raw %}{%{% endraw %} include '@FactFinder/layout/catalog/filters.twig' with { - afterSearchNavigation: factFinderSearchResponse.getAfterSearchNavigation -} {% raw %}%}{% endraw %} - -{% raw %}{%{% endraw %} include '@FactFinder/layout/partials/sort.twig' {% raw %}%}{% endraw %} - -{% raw %}{%{% endraw %} include '@FactFinder/search/partials/pagination.twig' with { - showAlwaysFirstAndLast: true - } {% raw %}%}{% endraw %} -``` - -According to the template examples, you can set up default demoshop template for using FACT-Finder responses. - -## After Search - -`FactFinderSdkSearchResponseTransfer` has campaign iterator, bread crumbs, paging, search result, sorting parameters, result per page option, filter groups. - -You can build any front end and templates using those options in the response transfer object. - -### Filter Groups - -Default settings in the FACT-Finder admin panel are: - -For categories filter: - -* Source field -`CategoryPath` -* Field type -`CategoryPath` - -For price filter: - -* Source field - Price -* Field type - Number -* Range type - Slider - -For stock filter: - -* Source field - Stock -* Field type - Text -* Selection Type - Multi-select - -Filter groups have the following options (name - type): - -* filters -`FactFinderSdkDataFilter[]` -* name - string -* `detailedLinkCount` - int -* unit - string -* `isRegularStyle` - bool -* `isSliderStyle` - bool -* `isTreeStyle` - bool -* `isMultiSelectStyle` - bool -* `hasPreviewImages` - bool -* `hasSelectedItems` - bool -* `isSingleHideUnselectedType` - bool -* `isSingleShowUnselectedType` - bool -* `isMultiSelectOrType` - bool -* `isMultiSelectAndType` - bool -* `isTextType` - bool -* `isNumberType` - bool - -Filter has the following options (name - type): - -* item -`FactFinderSdkDataItem` -* `fieldName` - string -* `matchCount` - int -* `clusterLevel` - int -* `previewImage` - string -* `hasPreviewImage` - bool -* `absoluteMinimum` - string -* `absoluteMaximum` - string -* `selectedMinimum` - string -* `selectedMaximum` - string - -### Bread Crumbs - -Bread crumbs have following options (name - type): - -* item -`FactFinderSdkDataItem` -* `isSearchBreadCrumb` - bool -* `isFilterBreadCrumb` - bool -* `fieldName` - string - -### Paging - -Paging has the following options (name - type): - -* `pageCount` - int -* `firstPage` -`FactFinderSdkDataPage` -* `lastPage` -`FactFinderSdkDataPage` -* `previousPage` -`FactFinderSdkDataPage` -* `currentPage` -`FactFinderSdkDataPage` -* `nextPage` -`FactFinderSdkDataPage` - -Data page has the following options (name - type): - -* item -`FactFinderSdkDataItem` -* `pageNumber` - int - -Data item has the following options (name - type): - -* label - string -* url - string -* selected - bool - -### Sorting Options - -Is array of data items. diff --git a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md b/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md deleted file mode 100644 index 932b60cf8f6..00000000000 --- a/docs/scos/dev/technology-partner-guides/202212.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -title: Using FACT-Finder tracking -description: Tracking information lets the FACT-Finder Search tool automatically learn from the user behavior. -last_updated: Jun 16, 2021 -template: howto-guide-template -originalLink: https://documentation.spryker.com/2021080/docs/search-factfinder-tracking -originalArticleId: c84875c9-9cd3-40b6-a74f-8ea4abffe195 -redirect_from: - - /2021080/docs/search-factfinder-tracking - - /2021080/docs/en/search-factfinder-tracking - - /docs/search-factfinder-tracking - - /docs/en/search-factfinder-tracking - - /docs/scos/dev/technology-partner-guides/202200.0/marketing-and-conversion/analytics/fact-finder/using-fact-finder-tracking.html -related: - - title: Integrating FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/integrating-fact-finder.html - - title: Installing and configuring FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder.html - - title: Installing and configuring FACT-Finder web components - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-fact-finder-web-components.html - - title: Installing and configuring FACT-Finder NG API - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/installing-and-configuring-the-fact-finder-ng-api.html - - title: Using FACT-Finder campaigns - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-campaigns.html - - title: Exporting product data for FACT-Finder - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/exporting-product-data-for-fact-finder.html - - title: Using FACT-Finder search - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search.html - - title: Using FACT-Finder recommendation engine - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-recommendation-engine.html - - title: Using FACT-Finder search suggestions - link: docs/scos/dev/technology-partner-guides/page.version/marketing-and-conversion/analytics/fact-finder/using-fact-finder-search-suggestions.html ---- - -## Prerequisites - -Tracking information lets the FACT-Finder Search tool automatically learn from the user behavior. - -The data provided through this interface can be used for a variety of purposes. They include the tracking of events such as users clicking on a detail page, placing a product into the shopping cart and purchasing it. The information can form the basis for automated search optimization. It automatically improves the search result on the basis of the established consumer behavior. Information about product clicks, shopping cart, and purchase events, in other words, the user behavior, is required for the Personalization module, which provides tailored search results for each user. The information on product purchases can also be used as a basis for the Recommendation Engine module. - -Please note, that the personalization can only work if a proper session ID is sent with each search request. - -## Usage - -By default, you can use the `/fact-finder/track` route. According to the FACT-Finder documentation, you can use tracking `GET` parameters . The user session ID will be appended on a server side. - -* **General Parameters**: - - `id` - ID of the item for which information is to be sent. - - `masterId` (optional) - If your shop contains item versions and you need to transmit the item version number with the id parameter, you will need to transmit the master item number using this parameter to ensure that the products and the possible events can be assigned to each other. - - `channel` - The name of the FACT-Finder channel in which the search was conducted. - - `sid` - Use it to pass the user's session identifier. - - `event` - This parameter specifies the event type. Use the following values for the various types: - + click - + cart - + checkout - + login - + recommendationClick - + feedback - - `title` (optional) - The item name. - - `userId` (optional) - Use it to pass a user identifier. As with the session ID, it can be anonymized. - - `cookieId` (optional) - You use this parameter to pass a token that identifies the user over a longer period of time, even when not being logged in to the shop. -* Click on the detail page: - - `sid` - Use it to pass the user's session identifier. - - `query` - The search term for which the user has searched. - - `pos` - The position of the product in the search results. - - `origPos` - It transmits the original position of the item in the search result. - - `page` - The number of the search result page on which the selected product was displayed. - - `pageSize` (optional) - The number of products per search result page at the time the click was executed. - - `origPageSize` - The default number of products per search result page. - - `simi` (optional) - The FACT-Finder similarity value for the respective product. - - `campaign` - This field has the campaign ID as its value. -* Shopping basket and purchase information: - - `count` - Quantity of product purchased. - - `price` (optional) - Product price. - - `campaign` - The search result via a campaign. This field has the campaign ID as its value. -* User login: - - `sid` - Use this to pass the user's session identifier. - - `userId` - Use this to pass a user identifier. Like the session ID, this can be anonymized. -* Recommendation Engine click: - - `mainId` - ID of the article for which the clicked article was recommended. -* Search result feedback: - - `query` - The search term for which a search was conducted and on which feedback has been provided. - - `positive` - Send the value true at this point if the customer provided positive feedback. Send false if negative feedback was provided on the result. - - `message` (optional) - If the customer left a message as justification of their opinion, you can send it using this parameter. -* Shop cachehit: - - `page` - The number of the search result page on which the selected product was displayed. - - `pageSize` - The number of products per search result page at the time the click was executed. - - `query` - The search term for which a search was conducted and on which feedback has been provided. - - `hitCount` - The amount of products found in the search result. - - `searchTime` - The time which was needed to create the search result. - - `bestSimi` - Similarity of the best product. - - `minSimi` - Similarity of the last product. - - `filterfieldName` (optional) - Information about active filters in the search result. - - `searchField` (optional) - The field for which the search was performed in case the search was limited to a specific field. - - `customSorting` (optional) - If the default sorting was not used for the search result, then please send a true. - - `additionalInfo`` (optional) - You may use this parameter to add something to the log entry, such as to enable searching the log for a specific entry. -* Suggest Tracking: - - `queryFromSuggest` - This parameter indicates that the FACT-Finder query was triggered through a selection from the suggestion list. In this case send the parameter with the value true. - - `userInput` - Please use this parameter to send the order of letters the shop user entered until the search query was triggered. - -To use tracking on the back-end, provide the dependency to your module dependency provider. - -**Code sample** - - ```php -getLocator()->factFinderSdk()->client(); - }; - - return $container; - } - -{% raw %}{%{% endraw %} endhighlight {% raw %}%}{% endraw %} - -Add a new function to your module factory. - -{% raw %}{%{% endraw %} highlight php linenos {% raw %}%}{% endraw %} -getProvidedDependency(YourBundleDependencyProvider::FACT_FINDER_CLIENT); - } -``` - -Login tracking could be added to a `Pyz\Yves\Customer\Plugin\Provider\CustomerAuthenticationSuccessHandler` on `AuthenticationSuccess` function. - -Example of a user login tracking function: - -```php -setEvent(CustomerConstants::LOGIN_TRACKING); - $trackingTransfer->setSid($request->cookies->get(FactFinderConstants::COOKIE_SID_NAME)); - $trackingTransfer->setUserId(md5($customer->getEmail())); - - $this->factFinderSdkClient->track($trackingTransfer); - } -``` - -Shopping basket tracking function could be added to a `Yves\Cart\Handler\CartOperationHandler` changeQuantity and add functions. - -Add a session client and a fact finder sdk client to the `CartOperationHandler` class via a `DependencyProvider`. - -Example of an add to cart tracking function: - -```php -getCurrentItemTransfer($quoteTransfer, $sku); - - if ($trackItemTransfer) { - $trackRequestTransfer = new FactFinderSdkTrackingRequestTransfer(); - $trackRequestTransfer->setId($trackItemTransfer->getSku()) - ->setMasterId() // generate and add an abstract product sku - ->setEvent(static::CART_TRACK_EVENT_NAME) // static::CART_TRACK_EVENT_NAME === 'cart' - ->setCount($quantity) - ->setPrice($trackItemTransfer->getUnitPrice() / 100) - ->setSid($this->sessionClient->getId()); - - return $this->factFinderSdkClient->track($trackRequestTransfer); - } - - return new FactFinderSdkTrackingResponseTransfer(); - } -``` From 7a864fb6b9d246461a686f7c7c7898ca0846d0cf Mon Sep 17 00:00:00 2001 From: Vadym Sachenko Date: Tue, 25 Jul 2023 15:20:50 +0300 Subject: [PATCH 4/5] Update _data/sidebars/pbc_all_sidebar.yml --- _data/sidebars/pbc_all_sidebar.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 15e64b680c1..07fae96fd4b 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1420,7 +1420,7 @@ entries: - title: Install and upgrade nested: - title: Install features - nested: + nested: - title: Marketplace Merchant Portal Product Offer Management - Merchant Portal url: /docs/pbc/all/offer-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - title: Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - Merchant Portal From 57805698d44541e593582c343d67b195784f4521 Mon Sep 17 00:00:00 2001 From: Vadym Sachenko Date: Tue, 25 Jul 2023 17:14:43 +0300 Subject: [PATCH 5/5] Update pbc_all_sidebar.yml fix broken links --- _data/sidebars/pbc_all_sidebar.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 15e64b680c1..db2053a4de3 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -1178,7 +1178,7 @@ entries: - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-portal-product-offer-management-feature.html - title: Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management - url: /docs/pbc/all/merchant-management/202212.0/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html + url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-portal-marketplace-merchant-portal-product-offer-management-merchant-portal-order-management-feature.html - title: Merchant Switcher url: /docs/pbc/all/merchant-management/marketplace/install-and-upgrade/install-features/install-the-merchant-switcher-feature.html - title: Merchant Switcher + Customer Account Management @@ -1306,7 +1306,7 @@ entries: - title: Edit translations url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html - title: Retrieve store configuration using Glue API - url: /docs/pbc/all/miscellaneous/202212.0/glue-api-retrieve-store-configuration.html + url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html - title: Third-party integrations nested: - title: Customer service