diff --git a/docs/commerce/commerce.md b/docs/commerce/commerce.md index 531549b6..b424b25a 100644 --- a/docs/commerce/commerce.md +++ b/docs/commerce/commerce.md @@ -9,7 +9,7 @@ edition: commerce You can use them to create a unified and streamlined e-commerce platform. Modules interact with each other, for example, to decrease stock following a sale, reduce prices when the cart reaches a certain value, or cancel shipments and payments when orders are cancelled. -The solution complements functionalities provided by the [PIM](products.md) offering, and allows you to sell products through the website. +The solution complements functionalities provided by the [product catalog](products.md) offering, and allows you to sell products through the website. With Commerce, you can build your own storefront from a set of generic components, which you can then customize to cover all aspects of the e-commerce experience. Out of the box, Commerce is configured to follow a specific workflow and support a certain number of processing method types, for example, flat rate, free shipping methods, and offline payment methods. diff --git a/docs/commerce/discounts/discounts.md b/docs/commerce/discounts/discounts.md index b5989767..9b568a4e 100644 --- a/docs/commerce/discounts/discounts.md +++ b/docs/commerce/discounts/discounts.md @@ -22,3 +22,5 @@ The **Discounts** module interacts with other parts of the system, so that store - in the product catalog, see base prices of products together with prices reduced according to active catalog discounts - in the cart, see prices reduced according to catalog and/or cart discounts, apply discount codes, and observe as prices change when various cart discount conditions are met - at checkout, see a total value of all applied discounts and prices reduced as a result of those discounts + +For more information about discounts, see [Work with discounts](work_with_discounts.md). diff --git a/docs/commerce/discounts/work_with_discounts.md b/docs/commerce/discounts/work_with_discounts.md index 72cdb361..2d1a7d05 100644 --- a/docs/commerce/discounts/work_with_discounts.md +++ b/docs/commerce/discounts/work_with_discounts.md @@ -64,7 +64,7 @@ If your store supports multiple languages and you want different discount names ## Create new discount -When you create discounts, you must first decide whether they apply to all [products](../../pim/products.md) from the catalog, or the products that the customer has put into their cart. +When you create discounts, you must first decide whether they apply to all [products](../../product_catalog/products.md) from the catalog, or the products that the customer has put into their cart. You are then taken through a series of steps, where you define the discount, for example, decide if it applies to selected [customer groups]([[= developer_doc =]]/users/customer_groups/) and specific products. Cart discount applicability can be further limited by setting a number of conditions, such as: diff --git a/docs/content_management/block_reference.md b/docs/content_management/block_reference.md index 63c6e049..eb8e62c7 100644 --- a/docs/content_management/block_reference.md +++ b/docs/content_management/block_reference.md @@ -1,6 +1,7 @@ --- description: Pick from a list of dynamic page blocks to create landing pages. edition: experience +month_change: true --- # Block reference @@ -22,12 +23,13 @@ The following blocks are provided with a clean installation of [[= product_name |[Form](#form-block)|Embeds a Form content item that you select from the content structure. | |[Gallery](#gallery-block)|Displays all images contained in a selected folder. | |[[[= product_name_connect =]]](#ibexa-connect-block)|Retrieves and displays data from an [[= product_name_connect =]] webhook. | -|[Last purchased](#last-purchased-block)|Displays a list of products that were recently purchased from PIM. | -|[Last viewed](#last-viewed-block)|Displays a list of products from PIM that were recently viewed. | +|[Last purchased](#last-purchased-block)|Displays a list of products that were recently purchased from the product catalog. | +|[Last viewed](#last-viewed-block)|Displays a list of products from the product catalog that were recently viewed. | |[Orders](#orders-block)|Displays a list of orders associated with a particular company or individual customer. | |[Personalized](#personalized-block)|Displays a list of content items/products that are recommended to end users when specific scenarios are triggered. | |[Product collection](#product-collection-block)|Displays a list of specifically selected products.| -|[Recently added](#recently-added-block)|Displays a list of products that were recently added to PIM. | +|[Product embed](#product-embed)|Displays a specific product.| +|[Recently added](#recently-added-block)|Displays a list of products that were recently added to the product catalog. | |[RSS](#rss-block)|Loads and displays news from RSS feeds (channels). | |[Sales representative](#sales-representative)|Loads and displays company's sales representative.| |[SeenThis!](#seenthis-block)|Displays video with exceeded standard video restrictions of 3.5MB.| @@ -35,7 +37,7 @@ The following blocks are provided with a clean installation of [[= product_name |[Text](#text-block)|Enables you to add to the page a Rich Text block. | |[Video](#video-block)|Embeds a video into the page with standard playback controls. | -[[= include_file('docs/content_management/create_edit_pages.md', 86, 96) =]] +[[= include_file('docs/content_management/create_edit_pages.md', 85, 96) =]] ## Block basics @@ -66,7 +68,9 @@ In the block configuration, on the **Design** tab, under the **View** field, you In the block configuration, on the **Scheduler** tab, you can set a date for the block to be revealed or hidden. -## Banner block +## Standard blocks + +### Banner block The banner block showcases an image linked to a specific URL. It can be used for creating visually appealing banners or promotional sections on websites that require linked images to direct users to specific pages or content. @@ -76,7 +80,7 @@ On the **Properties** tab, set values in the following fields: - **Image** — Click **Select content**, browse the available content, and choose an image for display. - **URL** — Enter a URL that opens when users click on the banner block. -## Bestsellers block +### Bestsellers block Displays products that were recently top sellers, to help users discover popular items quickly. On the **Properties** tab, set values in the following fields: @@ -88,7 +92,7 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. -## Campaign block +### Campaign block Displays a campaign created and configured in [[[= product_name_engage =]]](../ibexa_engage/ibexa_engage.md). On the **Properties** tab, set values in the following fields: @@ -96,12 +100,12 @@ On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the campaign. - **Campaign** – Select a campaign that you want to display on the page. The list contains only those campaigns from your Qualifio account, which are active or scheduled to launch in the future. -## Catalog block +### Catalog block Shows products from a chosen catalog tailored for a particular group of customers, ensuring a personalized browsing experience. Before you configure this block, make sure that there are [catalogs](work_with_catalogs.md) that are defined -and published in your PIM. +and published in your product catalog. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. @@ -111,7 +115,7 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. -## Code block +### Code block Enables you to use custom HTML to add customized text, links, images, and more to your page. On the **Properties** tab, set values in the following fields: @@ -119,7 +123,7 @@ On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Content** — Enter the HTML code for the content you want to display. -## Collection block +### Collection block Displays a collection of content items manually selected from the content structure, allowing you to feature specific content for promotional campaigns or highlight essential information on your website. On the **Properties** tab, set values in the following fields: @@ -130,7 +134,7 @@ On the **Properties** tab, set values in the following fields: All selected content items appear in the **Selected items** box at the bottom of the window. When done selecting, click **Confirm**. -## Content List block +### Content List block Displays content items of specified content type from a selected folder, simplifying access to categorized information or targeted content presentation on your site. On the **Properties** tab, set values in the following fields: @@ -140,7 +144,7 @@ On the **Properties** tab, set values in the following fields: - **Limit** — Set the number of products to be displayed. - **Content types to be displayed** — Select content type(s) to be displayed. -## Dynamic targeting block +### Dynamic targeting block Dynamic targeting block provides recommended items based on users related to the configured segments. @@ -156,7 +160,7 @@ The rules are checked in order, so when a user belongs to more than one segment, ![Dynamic targeting](img/page_builder_dynamic_targeting.png) -## Embed block +### Embed block Place any content item directly on the page. This function works across all content types seamlessly. On the **Properties** tab, set values in the following fields: @@ -164,7 +168,7 @@ On the **Properties** tab, set values in the following fields: - **Name** — Enter a name for the page block. - **Content** — Click **Select content**, browse the content, and select a content item. -## Form block +### Form block Place a selected form from the content structure onto the page. Integrate specific forms into your content to enhance client interaction. @@ -181,7 +185,7 @@ On the **Properties** tab, set values in the following fields: For more information about creating form blocks, see [Creating a newsletter form]([[= developer_doc =]]/content_management/pages/create_custom_page_block/) in Developer Documentation. -## Gallery block +### Gallery block Presents a comprehensive visual array by displaying all images from your selected folder. On the **Properties** tab, set values in the following fields: @@ -192,9 +196,10 @@ On the **Properties** tab, set values in the following fields: After submitting the settings, all images in the folder are shown in the Gallery block. Selecting a folder containing content items other than images results in displaying only a link to the folder where they're stored. -## [[= product_name_connect =]] block +### [[= product_name_connect =]] block -Access and showcase data retrieved from an [[= product_name_connect =]] webhook. Streamline information presentation for seamless insights and improved decision-making. +Access and showcase data retrieved from an [[= product_name_connect =]] webhook. +Streamline information presentation for seamless insights and improved decision-making. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. @@ -204,20 +209,20 @@ On the **Properties** tab, set values in the following fields: For more information about using [[= product_name_connect =]] scenario block, see [[[= product_name_connect =]] scenario block]([[= developer_doc =]]/content_management/pages/ibexa_connect_scenario_block/) in Developer Documentation. -## Last purchased block +### Last purchased block -Showcases a list of recently purchased products from PIM. +Showcases a list of recently purchased products from the product catalog. Helps keep track of recent sales and improve product visibility. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. -- **Personalization scenario** – Select "Last purchased" to display products that were recently purchased from PIM by any user, or "Last purchased by user" to display products that were recently purchased by the current user. +- **Personalization scenario** – Select "Last purchased" to display products that were recently purchased from the product catalog by any user, or "Last purchased by user" to display products that were recently purchased by the current user. - **Product Types to be displayed** – Select the type of products to be displayed on the list. - **Limit** – Set the number of products to be displayed. -## Last viewed block +### Last viewed block -Showcases a list of recently viewed products from PIM. +Showcases a list of recently viewed products from the product catalog. Helps track and show recent product interests for quick access and informed decisions. On the **Properties** tab, set values in the following fields: @@ -226,7 +231,7 @@ On the **Properties** tab, set values in the following fields: - **Product Types to be displayed** – Select the type of products to be displayed on the list. - **Limit** – Set the number of products to be displayed. -## Orders block +### Orders block Showcases a list of orders linked to a specific company or individual customer. Helps track purchase history for streamlined customer service and personalized interactions. @@ -238,7 +243,7 @@ On the **Properties** tab, set values in the following fields: - **Number of orders** — Set the number of orders to be displayed. - **Sort order** — Set the sort order for the displayed orders. -## Personalized block +### Personalized block Showcases recommended content items or products triggered by specific scenarios for end users. Enhances user experience by suggesting tailored options for various situations. @@ -251,30 +256,34 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, change the layout to "Products" and submit your changes. -## Product collection block +### Product collection block Presents curated collections of items for easier exploration and discovery. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. -- **Product list** — Create a list of products. Enter a comma-separated list of product/variant codes and click **Add** or click **Select product**. Then, in content browser, select products, and click **Confirm**. +- **Product list** — Create a list of products. Either enter a comma-separated list of product codes and click **Add**, or click **Select products**, select products, and click **Confirm**. -!!! note +## Product embed - Due to a technical limitation, content browser doesn't display product variants. +Presents a single product, allowing you to highlight its key features. +On the **Properties** tab, set values in the following fields: -## Recently added block +- **Name** – Enter a name for the page block. +- **Product code** — Enter the product code and click **Add** or click **Select products**. Then, select a single product, and click **Confirm**. -Highlights recently added products from PIM. +### Recently added block + +Highlights recently added products from the product catalog. Quickly informs users about new additions for quicker distribution and popularizing added products. On the **Properties** tab, set values in the following fields: - **Name** – Enter a name for the page block. -- **Personalization Scenario** – Select "Recently added items" to display products that were recently added to PIM. +- **Personalization Scenario** – Select "Recently added items" to display products that were recently added to the product catalog. - **Product Types to be displayed** – Select the type of products to be displayed on the list. - **Limit** – Set the number of products to be displayed. -## RSS block +### RSS block Imports and showcases news content from RSS feeds (channels), helping users stay informed with the latest updates and diverse news sources. On the **Properties** tab, set values in the following fields: @@ -284,7 +293,7 @@ On the **Properties** tab, set values in the following fields: - **Limit** — Set the number of news items to be displayed. - **Offset** — Set the limit of featured news items to be displayed. -## Sales representative +### Sales representative Imports and showcases sales representatives for the company in the Customer Portal. Gives users a way to connect with the team that handles their sales needs. @@ -294,7 +303,7 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present the Sales representative's details view and submit your changes. -## SeenThis! block +### SeenThis! block Integration with [SeenThis!](https://seenthis.co/) service. SeenThis! block provides an adaptive streaming technology with no limitations as conventional streaming service. It allows to preserve the best video quality with minimum amount of data transfer. @@ -320,7 +329,7 @@ On the **Properties** tab, set values in the following fields: SeenThis! technology might be blocked by some ad blocker solutions. If you can't see the block once configured, check the ad blocker configuration. -## Targeting block +### Targeting block Targeting block provides recommendation of content based on users related to the configured segments. @@ -336,7 +345,7 @@ You can preview the page for each of the available segments: ![Previewing page for a given segment](img/page_builder_segment_preview.png) -## Text block +### Text block Adds a Rich Text block to the page. On the **Properties** tab, set values in the following fields: @@ -352,7 +361,7 @@ For details, see [Editing Rich Text Fields](create_edit_content_items.md#edit-ri For more information, see [AI Assistant](create_edit_content_items.md#ai-assistant). -## Video block +### Video block Integrates a video into the page with standard playback controls. Helps enhance content variety and captivate audiences with seamless video viewing. @@ -362,3 +371,8 @@ On the **Properties** tab, set values in the following fields: - **Video** — Click **Select content**, browse the content, and select a video to display in the block. On the **Properties** tab you can preview the selected video before adding it to the page. + +## Recommendation blocks + +One of the elements of the Raptor integration is the addition of recommendation blocks. +For more information, see [Recommendation blocks](raptor_recommendation_blocks.md). diff --git a/docs/content_management/create_edit_content_items.md b/docs/content_management/create_edit_content_items.md index 6a319c96..953ddd22 100644 --- a/docs/content_management/create_edit_content_items.md +++ b/docs/content_management/create_edit_content_items.md @@ -1,5 +1,6 @@ --- description: Create content for your website with different fields, rich text, tags, and then publish it. +month_change: true --- # Create and edit content items @@ -110,6 +111,7 @@ To do it, choose one of the available elements: - Ordered list - Table - Embed +- Embed product - Image - YouTube - X @@ -149,9 +151,17 @@ This option is also available when you want to set up a [relation](configure_ct_ ![Edit embedded content item - set up a relation](img/edit_embedded_items_relation.png "Edit embedded content item - set up a relation") -#### Distraction free mode +#### Embed products + +You can embed [products](products.md) from the product catalog directly inside a Rich Text field. +Use this feature when building landing pages or articles that reference specific products, for example, a blog post that highlights a new product launch. + +Two embed styles are available: -While editing Rich Text fields, you can switch to distraction free mode. +- **Embed** embeds a product as a standalone element between paragraphs. +- **Inline embed** embeds a product within a sentence or paragraph. + +#### Distraction free mode Distraction free mode expands the workspace to full screen and shows only editor toolbar. It's helpful when you need to work with longer texts that take more space and when you want to focus your attention on editing text. diff --git a/docs/getting_started/dashboard/dashboard_block_reference.md b/docs/getting_started/dashboard/dashboard_block_reference.md index 8543886a..4de1a5d4 100644 --- a/docs/getting_started/dashboard/dashboard_block_reference.md +++ b/docs/getting_started/dashboard/dashboard_block_reference.md @@ -82,6 +82,8 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. +This block is not supported when using [[[= pim_product_name =]]](../../product_catalog/quable_pim_integration.md) as the source of product information. + ## Products with lowest stock block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] Displays a table of products with the lowest stock. @@ -97,6 +99,8 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes. +This block is not supported when using [[[= pim_product_name =]]](../../product_catalog/quable_pim_integration.md) as the source of product information. + ## Quick actions block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] Displays selected mostly used actions and shortcuts, for example, **Create content**. @@ -166,4 +170,4 @@ On the **Properties** tab, set values in the following fields: - **Name** - Enter a name for the block. - **Customer ID** - Select customer ID whose top 10 clicks are displayed. -On the **Design** tab, in the **View** field, select the layout to be used to present a list of content items for review and submit your changes. \ No newline at end of file +On the **Design** tab, in the **View** field, select the layout to be used to present a list of content items for review and submit your changes. diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md index b52822a9..493b757a 100644 --- a/docs/getting_started/discover_ui.md +++ b/docs/getting_started/discover_ui.md @@ -63,7 +63,7 @@ Depending on the product edition and your [permissions](../permission_management - **Content**, which gives you access to the content repository. It lets you navigate the content tree, and, for example, create, edit, move, copy, or delete content. - [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] **Site management**, which enables you to create and edit block-based pages and manage multiple websites. -- **PIM**, which enables you to handle products presented on the website, including their specifications and pricing. +- **Product catalog**, which enables you to handle products presented on the website, including their specifications and pricing. - **Admin**, which is the administration panel where you can manage, for example, Users, Sections, or permissions. ## Content tree @@ -148,7 +148,7 @@ Focus mode is enabled by default when you first log into [[= product_name =]], b ## Help center [[% include 'snippets/lts-update_badge.md' %]] -If the Integrated help [LTS update]([[= developer_doc =]]/ibexa_products/editions/#lts-updates) has been installed in your application, you may notice that the ![Help center](about-info.png){.inline-image} icon appears at the bottom right of multiple screens. +If the Integrated help [LTS update]([[= developer_doc =]]/ibexa_products/editions/#lts-updates) has been configured in your application, you may notice that the ![Help center](about-info.png){.inline-image} icon appears at the bottom right of multiple screens. Click it to access documentation, trainings, and other relevant resources straight from the back office. Help center is also [another place]([[= developer_doc =]]/administration/admin_panel/system_information_admin_panel/) where you can check the [[= product_name =]] version that you're on. @@ -161,9 +161,9 @@ Contents of the help center are contextual: Help center can be [customized]([[= developer_doc =]]/administration/back_office/customize_integrated_help/) to fit the needs of your organization, for example, to include links to your internal style guides. -### Enable help center +### Disable help center -Help center is disabled by default, but you can toggle it in [user settings](get_started.md#browsing). +Help center is enabled by default, but you can toggle it in [user settings](get_started.md#browsing). ### Dismiss help icon diff --git a/docs/getting_started/get_started.md b/docs/getting_started/get_started.md index f9354976..5aa17c7e 100644 --- a/docs/getting_started/get_started.md +++ b/docs/getting_started/get_started.md @@ -1,5 +1,6 @@ --- description: Get started with Ibexa DXP by logging in to the back office. +month_change: true --- # Get started @@ -12,7 +13,7 @@ It features a customizable user interface where you can work with the content, p Depending on the product edition, [[= product_name =]] can provide advanced capabilities in such areas as: - [content management](content_management.md) -- [product management](pim.md) +- [product management](product_catalog.md) - [customer management](customer_management.md) !!! note "Installation" @@ -31,6 +32,13 @@ Otherwise, to log in, you must get your user credentials from the administrator, ![Login screen](img/login_form.png "Login screen") +### Onboarding + +When you log in to [[= product_name =]] for the first time, interactive product tours may appear if the Integrated help [LTS update]([[= developer_doc =]]/ibexa_products/editions/#lts-updates) is configured in your installation. +This in-app walkthroughs guide you through key features and help you get started quickly. + +You can complete each step of the onboarding tutorials, skip them entirely if you prefer to explore on your own, or restart them anytime from your [user settings](#user-settings) under the **Browsing** section. + ### View and edit user profile If you're an editor, depending on the system configuration, you may be able to view and edit the user profile, which can contain the following information: @@ -114,7 +122,9 @@ Here you can [change your user password](get_started.md#change-the-password) and --------|-----------| |Number of items displayed in the table|Sets the number of items displayed in sub-items.| |Location preview|Enables or disables a thumbnail preview on the content tree.| -|Help center|Disables or enables the [help center](discover_ui.md#help-center). [[% include 'snippets/lts-update_badge.md' %]]| +|Help center|Enables or disables the [help center](discover_ui.md#help-center). [[% include 'snippets/lts-update_badge.md' %]]| +|Product tour|Enables or disables the [product tour onboarding](#onboarding) walkthroughs. [[% include 'snippets/lts-update_badge.md' %]]| +|Product tour scenarios settings|Separate setting for each available product tour scenario. Allows you to mark each scenario as completed or reset its progress. [[% include 'snippets/lts-update_badge.md' %]]| #### Mode diff --git a/docs/index.md b/docs/index.md index d4186db1..152c4078 100644 --- a/docs/index.md +++ b/docs/index.md @@ -136,8 +136,8 @@
@@ -203,7 +203,7 @@

- + @@ -212,9 +212,9 @@

diff --git a/docs/persona_paths/explorer.md b/docs/persona_paths/explorer.md index d554aaa7..f11d25ed 100644 --- a/docs/persona_paths/explorer.md +++ b/docs/persona_paths/explorer.md @@ -17,7 +17,7 @@ Whether you're a new or seasoned user of [[= product_name =]], feel free to brow "personalization/personalization", "personalization/configure_personalization", "search_engine_optimization/seo", - "pim/products", + "product_catalog/products", "persona_paths/manage_products", "customer_management/customer_portal", "website_organization/multisite", diff --git a/docs/persona_paths/manage_products.md b/docs/persona_paths/manage_products.md index cd027a91..ea9d6f5d 100644 --- a/docs/persona_paths/manage_products.md +++ b/docs/persona_paths/manage_products.md @@ -4,18 +4,18 @@ description: Add and configure products in your catalog, set up their attributes # Manage products -In [[= product_name =]] you store aggregate product information in PIM. +In [[= product_name =]] you store aggregate product information in product catalog. Learn to add, categorize and organize products, so that you have control over your stock and customers can easily browse your catalogs. [[= cards([ - "pim/create_product_types", - "pim/work_with_product_attributes", - "pim/create_edit_product", - "pim/work_with_product_assets", - "pim/work_with_product_categories", - "pim/work_with_product_variants", - "pim/manage_prices", - "pim/manage_availability_and_stock", - "pim/work_with_catalogs" + "product_catalog/create_product_types", + "product_catalog/work_with_product_attributes", + "product_catalog/create_edit_product", + "product_catalog/work_with_product_assets", + "product_catalog/work_with_product_categories", + "product_catalog/work_with_product_variants", + "product_catalog/manage_prices", + "product_catalog/manage_availability_and_stock", + "product_catalog/work_with_catalogs" ], style="path") =]] diff --git a/docs/persona_paths/shop_manager.md b/docs/persona_paths/shop_manager.md index db480522..bc82b26c 100644 --- a/docs/persona_paths/shop_manager.md +++ b/docs/persona_paths/shop_manager.md @@ -15,10 +15,10 @@ In [[= product_name =]], it means that you must focus on many things, including ## What would you like to do today? [[= cards([ - "pim/products", + "product_catalog/products", "persona_paths/manage_products", - "pim/manage_currencies", - "pim/manage_prices", + "product_catalog/manage_currencies", + "product_catalog/manage_prices", "customer_management/manage_customers", "commerce/shipping_management/work_with_shipping_methods", "commerce/payment/work_with_payment_methods", diff --git a/docs/pim/pim.md b/docs/pim/pim.md deleted file mode 100644 index 5b1aaf6c..00000000 --- a/docs/pim/pim.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: PIM enables handling of products presented in the website anf offered in the storefront, including their specifications and pricing. ---- - -# PIM (Product Information Management) - -With PIM you can create, configure and manage products that are offered in the [[= product_name =]]-based website and/or storefront, including their specifications, attributes, assets, variants, and pricing. - -You can group products into categories and catalogs. -Catalogs are collections of products selected using configurable filters. -Categories let you organize products within PIM and create relationships between them, for example, to help customers in searching for products. - -PIM's features are available from the left-hand menu. - -![PIM in the menu](img/catalog_menu.png "PIM in the menu") - -[[= cards([ - "pim/product_types", - "pim/create_product_types", - "pim/products", - "pim/create_edit_product", - "pim/work_with_catalogs", - "pim/work_with_product_categories" -], columns=3) =]] \ No newline at end of file diff --git a/docs/pim/create_edit_product.md b/docs/product_catalog/create_edit_product.md similarity index 79% rename from docs/pim/create_edit_product.md rename to docs/product_catalog/create_edit_product.md index e4e1a2dd..edf4bcf3 100644 --- a/docs/pim/create_edit_product.md +++ b/docs/product_catalog/create_edit_product.md @@ -8,11 +8,17 @@ description: Create new products or modify existing ones. Individual products are instances of [product types](create_product_types.md#create-product-types). You can only create or modify products when your [user role](../permission_management/work_with_permissions.md) has the `Product/Edit` permission. +!!! note "Quable PIM integration" + + When [Quable is configured as the source of product information](quable_pim_integration.md), creating and editing products in [[= product_name =]] is not available. + Products are managed in the [[= pim_product_name =]] back office and are automatically available in [[= product_name =]]. + You can still [manage prices](manage_prices.md) and [availability](manage_availability_and_stock.md) for [[= pim_product_name =]] products in [[= product_name =]]. + To create a product, depending on how the product type is defined, you [may need to provide](products.md#product-completeness) certain pieces of information in their respective [fields](../content_management/content_model.md#fields-and-field-types). You can create products using either manual or bulk method. Bulk method can be used only at the developer level. -See [Products]([[= developer_doc =]]/pim/product_api/#products) for a technical guide on how to do this. +See [Products]([[= developer_doc =]]/product_catalog/product_api/#products) for a technical guide on how to do this. 1\. Click **Product catalog** -> **Products**. @@ -43,4 +49,4 @@ After you create a product, you can [add image assets to a product](work_with_pr Feature availability may differ depending on the specifics of your installation. -For in-depth information, see [Products]([[= developer_doc =]]/pim/products/) in Developer Documentation. +For in-depth information, see [Products]([[= developer_doc =]]/product_catalog/products/) in Developer Documentation. diff --git a/docs/pim/create_product_types.md b/docs/product_catalog/create_product_types.md similarity index 89% rename from docs/pim/create_product_types.md rename to docs/product_catalog/create_product_types.md index 48d8b83c..8f166b48 100644 --- a/docs/pim/create_product_types.md +++ b/docs/product_catalog/create_product_types.md @@ -6,6 +6,11 @@ description: Build new product types or modify existing ones. If your [user role](../permission_management/work_with_permissions.md) has the `ProductType/Edit` permission, you can modify product types and add individual attributes or attribute groups. +!!! note "Quable PIM integration" + + When [Quable is configured as the source of product information](quable_pim_integration.md), product types are defined in [[= pim_product_name =]] and cannot be created or modified in [[= product_name =]]. + Manage product types in the [[= pim_product_name =]] back office instead. + 1\. In the left panel, go to **Product catalog** -> **Product Types** and click **Create**. ![Create new product type](create_new_product_type.png "Create new product type") diff --git a/docs/pim/create_virtual_product.md b/docs/product_catalog/create_virtual_product.md similarity index 100% rename from docs/pim/create_virtual_product.md rename to docs/product_catalog/create_virtual_product.md diff --git a/docs/pim/img/adding_attributes.png b/docs/product_catalog/img/adding_attributes.png similarity index 100% rename from docs/pim/img/adding_attributes.png rename to docs/product_catalog/img/adding_attributes.png diff --git a/docs/pim/img/attribute_types.png b/docs/product_catalog/img/attribute_types.png similarity index 100% rename from docs/pim/img/attribute_types.png rename to docs/product_catalog/img/attribute_types.png diff --git a/docs/pim/img/catalog.png b/docs/product_catalog/img/catalog.png similarity index 100% rename from docs/pim/img/catalog.png rename to docs/product_catalog/img/catalog.png diff --git a/docs/pim/img/catalog_create.png b/docs/product_catalog/img/catalog_create.png similarity index 100% rename from docs/pim/img/catalog_create.png rename to docs/product_catalog/img/catalog_create.png diff --git a/docs/pim/img/catalog_menu.png b/docs/product_catalog/img/catalog_menu.png similarity index 100% rename from docs/pim/img/catalog_menu.png rename to docs/product_catalog/img/catalog_menu.png diff --git a/docs/pim/img/catalogs_filters.png b/docs/product_catalog/img/catalogs_filters.png similarity index 100% rename from docs/pim/img/catalogs_filters.png rename to docs/product_catalog/img/catalogs_filters.png diff --git a/docs/pim/img/catalogs_product_list.png b/docs/product_catalog/img/catalogs_product_list.png similarity index 100% rename from docs/pim/img/catalogs_product_list.png rename to docs/product_catalog/img/catalogs_product_list.png diff --git a/docs/pim/img/collection_dnd.png b/docs/product_catalog/img/collection_dnd.png similarity index 100% rename from docs/pim/img/collection_dnd.png rename to docs/product_catalog/img/collection_dnd.png diff --git a/docs/pim/img/create_attribute.png b/docs/product_catalog/img/create_attribute.png similarity index 100% rename from docs/pim/img/create_attribute.png rename to docs/product_catalog/img/create_attribute.png diff --git a/docs/pim/img/create_custom_url.png b/docs/product_catalog/img/create_custom_url.png similarity index 100% rename from docs/pim/img/create_custom_url.png rename to docs/product_catalog/img/create_custom_url.png diff --git a/docs/pim/img/create_new_attribute.png b/docs/product_catalog/img/create_new_attribute.png similarity index 100% rename from docs/pim/img/create_new_attribute.png rename to docs/product_catalog/img/create_new_attribute.png diff --git a/docs/pim/img/create_new_product.png b/docs/product_catalog/img/create_new_product.png similarity index 100% rename from docs/pim/img/create_new_product.png rename to docs/product_catalog/img/create_new_product.png diff --git a/docs/pim/img/create_new_product_type.png b/docs/product_catalog/img/create_new_product_type.png similarity index 100% rename from docs/pim/img/create_new_product_type.png rename to docs/product_catalog/img/create_new_product_type.png diff --git a/docs/pim/img/create_product.png b/docs/product_catalog/img/create_product.png similarity index 100% rename from docs/pim/img/create_product.png rename to docs/product_catalog/img/create_product.png diff --git a/docs/pim/img/create_product_type.png b/docs/product_catalog/img/create_product_type.png similarity index 100% rename from docs/pim/img/create_product_type.png rename to docs/product_catalog/img/create_product_type.png diff --git a/docs/pim/img/custom_url.png b/docs/product_catalog/img/custom_url.png similarity index 100% rename from docs/pim/img/custom_url.png rename to docs/product_catalog/img/custom_url.png diff --git a/docs/pim/img/edit_product.png b/docs/product_catalog/img/edit_product.png similarity index 100% rename from docs/pim/img/edit_product.png rename to docs/product_catalog/img/edit_product.png diff --git a/docs/pim/img/enable_currency.png b/docs/product_catalog/img/enable_currency.png similarity index 100% rename from docs/pim/img/enable_currency.png rename to docs/product_catalog/img/enable_currency.png diff --git a/docs/pim/img/manage_currencies.png b/docs/product_catalog/img/manage_currencies.png similarity index 100% rename from docs/pim/img/manage_currencies.png rename to docs/product_catalog/img/manage_currencies.png diff --git a/docs/pim/img/measurement_types.png b/docs/product_catalog/img/measurement_types.png similarity index 100% rename from docs/pim/img/measurement_types.png rename to docs/product_catalog/img/measurement_types.png diff --git a/docs/pim/img/new_payment_method.png b/docs/product_catalog/img/new_payment_method.png similarity index 100% rename from docs/pim/img/new_payment_method.png rename to docs/product_catalog/img/new_payment_method.png diff --git a/docs/pim/img/product_assets.png b/docs/product_catalog/img/product_assets.png similarity index 100% rename from docs/pim/img/product_assets.png rename to docs/product_catalog/img/product_assets.png diff --git a/docs/pim/img/product_assets_collections.png b/docs/product_catalog/img/product_assets_collections.png similarity index 100% rename from docs/pim/img/product_assets_collections.png rename to docs/product_catalog/img/product_assets_collections.png diff --git a/docs/pim/img/product_availability.png b/docs/product_catalog/img/product_availability.png similarity index 100% rename from docs/pim/img/product_availability.png rename to docs/product_catalog/img/product_availability.png diff --git a/docs/pim/img/product_availability_tab.png b/docs/product_catalog/img/product_availability_tab.png similarity index 100% rename from docs/pim/img/product_availability_tab.png rename to docs/product_catalog/img/product_availability_tab.png diff --git a/docs/pim/img/product_categories.png b/docs/product_catalog/img/product_categories.png similarity index 100% rename from docs/pim/img/product_categories.png rename to docs/product_catalog/img/product_categories.png diff --git a/docs/pim/img/product_categories_product_list.png b/docs/product_catalog/img/product_categories_product_list.png similarity index 100% rename from docs/pim/img/product_categories_product_list.png rename to docs/product_catalog/img/product_categories_product_list.png diff --git a/docs/pim/img/product_category_selection.png b/docs/product_catalog/img/product_category_selection.png similarity index 100% rename from docs/pim/img/product_category_selection.png rename to docs/product_catalog/img/product_category_selection.png diff --git a/docs/pim/img/product_completeness.png b/docs/product_catalog/img/product_completeness.png similarity index 100% rename from docs/pim/img/product_completeness.png rename to docs/product_catalog/img/product_completeness.png diff --git a/docs/pim/img/product_completeness_bar.png b/docs/product_catalog/img/product_completeness_bar.png similarity index 100% rename from docs/pim/img/product_completeness_bar.png rename to docs/product_catalog/img/product_completeness_bar.png diff --git a/docs/pim/img/product_price.png b/docs/product_catalog/img/product_price.png similarity index 100% rename from docs/pim/img/product_price.png rename to docs/product_catalog/img/product_price.png diff --git a/docs/pim/img/product_type_attr_used_for_variants.png b/docs/product_catalog/img/product_type_attr_used_for_variants.png similarity index 100% rename from docs/pim/img/product_type_attr_used_for_variants.png rename to docs/product_catalog/img/product_type_attr_used_for_variants.png diff --git a/docs/pim/img/product_variants_delete.png b/docs/product_catalog/img/product_variants_delete.png similarity index 100% rename from docs/pim/img/product_variants_delete.png rename to docs/product_catalog/img/product_variants_delete.png diff --git a/docs/pim/img/product_variants_generate.png b/docs/product_catalog/img/product_variants_generate.png similarity index 100% rename from docs/pim/img/product_variants_generate.png rename to docs/product_catalog/img/product_variants_generate.png diff --git a/docs/pim/img/setting_product_price.png b/docs/product_catalog/img/setting_product_price.png similarity index 100% rename from docs/pim/img/setting_product_price.png rename to docs/product_catalog/img/setting_product_price.png diff --git a/docs/pim/img/taxonomy_suggestions_products.png b/docs/product_catalog/img/taxonomy_suggestions_products.png similarity index 100% rename from docs/pim/img/taxonomy_suggestions_products.png rename to docs/product_catalog/img/taxonomy_suggestions_products.png diff --git a/docs/pim/img/url_alias_name_pattern.png b/docs/product_catalog/img/url_alias_name_pattern.png similarity index 100% rename from docs/pim/img/url_alias_name_pattern.png rename to docs/product_catalog/img/url_alias_name_pattern.png diff --git a/docs/pim/img/url_attributes.png b/docs/product_catalog/img/url_attributes.png similarity index 100% rename from docs/pim/img/url_attributes.png rename to docs/product_catalog/img/url_attributes.png diff --git a/docs/pim/img/url_tab.png b/docs/product_catalog/img/url_tab.png similarity index 100% rename from docs/pim/img/url_tab.png rename to docs/product_catalog/img/url_tab.png diff --git a/docs/pim/img/vat_rates_product_details.png b/docs/product_catalog/img/vat_rates_product_details.png similarity index 100% rename from docs/pim/img/vat_rates_product_details.png rename to docs/product_catalog/img/vat_rates_product_details.png diff --git a/docs/pim/img/vat_rates_product_type.png b/docs/product_catalog/img/vat_rates_product_type.png similarity index 100% rename from docs/pim/img/vat_rates_product_type.png rename to docs/product_catalog/img/vat_rates_product_type.png diff --git a/docs/pim/img/virtual_product.png b/docs/product_catalog/img/virtual_product.png similarity index 100% rename from docs/pim/img/virtual_product.png rename to docs/product_catalog/img/virtual_product.png diff --git a/docs/pim/img/virtual_product_purchase.png b/docs/product_catalog/img/virtual_product_purchase.png similarity index 100% rename from docs/pim/img/virtual_product_purchase.png rename to docs/product_catalog/img/virtual_product_purchase.png diff --git a/docs/pim/img/virtual_product_type.png b/docs/product_catalog/img/virtual_product_type.png similarity index 100% rename from docs/pim/img/virtual_product_type.png rename to docs/product_catalog/img/virtual_product_type.png diff --git a/docs/pim/manage_availability_and_stock.md b/docs/product_catalog/manage_availability_and_stock.md similarity index 100% rename from docs/pim/manage_availability_and_stock.md rename to docs/product_catalog/manage_availability_and_stock.md diff --git a/docs/pim/manage_currencies.md b/docs/product_catalog/manage_currencies.md similarity index 100% rename from docs/pim/manage_currencies.md rename to docs/product_catalog/manage_currencies.md diff --git a/docs/pim/manage_prices.md b/docs/product_catalog/manage_prices.md similarity index 85% rename from docs/pim/manage_prices.md rename to docs/product_catalog/manage_prices.md index 6d771239..7d2b6f2e 100644 --- a/docs/pim/manage_prices.md +++ b/docs/product_catalog/manage_prices.md @@ -5,7 +5,7 @@ description: Products can have a base price and custom prices defined per custom # Work with product prices [Products](products.md) and product [variants](work_with_product_variants.md) can have a base price and multiple custom prices. -Prices can differ depending on [customer group](../customer_management/manage_customers.md) and [currency](../pim/manage_currencies.md) and be applied according to the rules. +Prices can differ depending on [customer group](../customer_management/manage_customers.md) and [currency](manage_currencies.md) and be applied according to the rules. With these basic price management features, you set up product prices manually. For a more refined price management tool that you can use when managing a store, see [Discounts](../commerce/discounts/discounts.md). @@ -15,9 +15,9 @@ For a more refined price management tool that you can use when managing a store, To set up product prices, your system must have at least one currency enabled. To set a price, navigate to the product's or product variant's **Prices** tab. -Here you can see the existing prices for the selected [currency](../pim/manage_currencies.md). +Here you can see the existing prices for the selected [currency](manage_currencies.md). -Select a currency in the dropdown menu to preview the price and click the **Edit** button to modify it. +Select a currency in the drop-down menu to preview the price and click the **Edit** button to modify it. ![Prices tab](img/product_price.png "Prices tab") diff --git a/docs/product_catalog/product_catalog.md b/docs/product_catalog/product_catalog.md new file mode 100644 index 00000000..7f5862e5 --- /dev/null +++ b/docs/product_catalog/product_catalog.md @@ -0,0 +1,28 @@ +--- +description: Product catalog enables handling of products presented in the website and offered in the storefront, including their specifications and pricing. +--- + +# Product catalog + +With Product catalog you can create, configure, and manage products that are offered in the [[= product_name =]]-based website and/or storefront, including their specifications, attributes, assets, variants, and pricing. + +You can group products into categories and catalogs. +Catalogs are collections of products selected with configurable filters. +Categories let you organize products within product catalog and create relationships between them, for example, to help customers in searching for products. + +Product catalog's features are available from the left-hand menu. + +![Product catalog in the menu](img/catalog_menu.png "Product catalog in the menu") + +You can use [[= product_name =]]'s built-in product management, or connect it to an external product information management (PIM) system. +[[[= pim_product_name =]] PIM integration](quable_pim_integration.md) allows you to use [[= pim_product_name =]] as the source of product data, while using [[= product_name =]] for marketing activities, [managing prices](manage_prices.md), and [availability and stock](manage_availability_and_stock.md). + +[[= cards([ + "product_catalog/quable_pim_integration", + "product_catalog/product_types", + "product_catalog/create_product_types", + "product_catalog/products", + "product_catalog/create_edit_product", + "product_catalog/work_with_catalogs", + "product_catalog/work_with_product_categories", +], columns=3) =]] diff --git a/docs/pim/product_types.md b/docs/product_catalog/product_types.md similarity index 78% rename from docs/pim/product_types.md rename to docs/product_catalog/product_types.md index 1ca618b7..5c0fae44 100644 --- a/docs/pim/product_types.md +++ b/docs/product_catalog/product_types.md @@ -9,6 +9,12 @@ By default, product types contain such fields as name, specification, image, or You can modify them as required. You need different product types, because products of type "Laptops" contain different fields and attributes than those of type "White appliances". +!!! note "Quable PIM integration" + + When [Quable is configured as the source of product information](quable_pim_integration.md), product types are defined from [[= pim_product_name =]] and are read-only in [[= product_name =]]. + To add or modify product types, use the [[= pim_product_name =]] back office. + Changes are automatically reflected in [[= product_name =]]. + When you create a new product type, you can choose between two available product type flavors: Physical and Virtual: - Physical - tangible products. @@ -23,8 +29,7 @@ When a product type is created, you can review its fields, attributes, and VAT r ![VAT rates in product type's details view](img/vat_rates_product_details.png "VAT rates in product type's details view") -If your [user role](../permission_management/work_with_permissions.md) has the `ProductType/Edit` -permission, you can [modify product types and add individual attributes or attribute groups](create_product_types.md). +If your [user role](../permission_management/work_with_permissions.md) has the `ProductType/Edit` permission, you can [modify product types and add individual attributes or attribute groups](create_product_types.md). ### Attributes @@ -35,4 +40,4 @@ They can also be used to define product variants. Attribute types define what kind of information you can store in an attribute. Typical product attribute examples include dimensions, weight, color, or format. -For more information, see [Work with product attributes](work_with_product_attributes.md). \ No newline at end of file +For more information, see [Work with product attributes](work_with_product_attributes.md). diff --git a/docs/pim/products.md b/docs/product_catalog/products.md similarity index 70% rename from docs/pim/products.md rename to docs/product_catalog/products.md index 3818707a..61b55e30 100644 --- a/docs/pim/products.md +++ b/docs/product_catalog/products.md @@ -14,11 +14,20 @@ For each product and product variant, you can define its [availability](manage_a When you create or edit products, you can add [assets](work_with_product_assets.md) in a form of images. Assets can be assigned to the base product, and to one or more of its variants. +Products can also be [embedded in content items](create_edit_content_items.md#embed-products) and [landing pages](block_reference.md#product-embed) to showcase them within editorial content, such as articles and landing pages. + +!!! note "Quable PIM integration" + + When [Quable is configured as the source of product information](quable_pim_integration.md), creating and editing products in [[= product_name =]] is not available. + + Product data is managed in the [[= pim_product_name =]] back office, with the exception of [managing prices](manage_prices.md) and [availability](manage_availability_and_stock.md) which happen in [[= product_name =]]. + In addition, you can use [[= product_name =]] to browse, search, filter, and embed [[= pim_product_name =]] products in content items, including landing pages. + For more information about creating products, see [Create product](create_edit_product.md#create-and-edit-products). ### Product completeness -Before your customers can purchase products, the website [administrator must configure]([[= developer_doc =]]/pim/enable_purchasing_products/) at least one region and one currency for the shop, and VAT rates for each of the regions. +Before your customers can purchase products, the website [administrator must configure]([[= developer_doc =]]/product_catalog/enable_purchasing_products/) at least one region and one currency for the shop, and VAT rates for each of the regions. You must then set: - VAT rates for the product type @@ -48,4 +57,4 @@ You can click the **Edit** button next to an unfinished task in the **Completene Product completeness does not impact product availability or visibility on the storefront. It is intended to help you ensure that product data is properly populated. - As long as your product meets the pricing and stock requirements, it can be published and made available for purchase regardless of its completeness score. \ No newline at end of file + As long as your product meets the pricing and stock requirements, it can be published and made available for purchase regardless of its completeness score. diff --git a/docs/product_catalog/quable_pim_integration.md b/docs/product_catalog/quable_pim_integration.md new file mode 100644 index 00000000..0ce697d9 --- /dev/null +++ b/docs/product_catalog/quable_pim_integration.md @@ -0,0 +1,46 @@ +--- +description: Quable PIM integration allows you to use products managed in Quable as the source of product data in Ibexa DXP. +month_change: true +--- + +# Quable PIM integration + +[[= product_name =]] can be connected to [[[= pim_product_name =]]](https://www.quable.com/en) as an external product information management (PIM) system. +After the feature is [configured]([[= developer_doc =]]/product-catalog/install-quable), [[= pim_product_name =]] becomes the central place for managing product data. +All product information is maintained in [[= pim_product_name =]] and automatically made available in [[= product_name =]]. + +This allows teams to work with consistent product data in the [[= product_name =]] interface, without duplicating or manually transferring information between systems. + +## Work with [[= pim_product_name =]] products + +When [[= pim_product_name =]] is configured as the source of product information, you can use product data directly in [[= product_name =]]. + +### Browse and search products + +Products from [[= pim_product_name =]] are available in [[= product_name =]] and can be browsed and searched for using categories and filters. +This makes it easier to find and work with the right products when creating content. + +### Use products in content + +You can select and [embed products in content items](../content_management/create_edit_content_items.md#embed-products), for example when creating articles or promotional pages. +Product data is always up to date and reflects the current state in [[= pim_product_name =]]. + +### Manage prices and availability + +[Product prices](manage_prices.md) and [availability and stock](manage_availability_and_stock.md) can be managed in [[= product_name =]]. + +You can define pricing rules, such as [discounts](discounts.md) for specific regions or customer groups. + +## Managing product data + +When [[= pim_product_name =]] is the source of product information, product data is not managed in [[= product_name =]]. + +The following actions must be performed in [[= pim_product_name =]]: + +- creating, editing, or deleting products +- updating product attributes and translations +- managing product categories + +This ensures that product data remains consistent across all systems and channels. + +To learn more about the limitations of the integration with [[= pim_product_name =]], see [known limitations]([[= developer_doc =]]/product-catalog/quable-guide#known-limitations) in the developer documentation. diff --git a/docs/pim/work_with_catalogs.md b/docs/product_catalog/work_with_catalogs.md similarity index 100% rename from docs/pim/work_with_catalogs.md rename to docs/product_catalog/work_with_catalogs.md diff --git a/docs/pim/work_with_product_assets.md b/docs/product_catalog/work_with_product_assets.md similarity index 100% rename from docs/pim/work_with_product_assets.md rename to docs/product_catalog/work_with_product_assets.md diff --git a/docs/pim/work_with_product_attributes.md b/docs/product_catalog/work_with_product_attributes.md similarity index 98% rename from docs/pim/work_with_product_attributes.md rename to docs/product_catalog/work_with_product_attributes.md index 226469c0..4f2462dd 100644 --- a/docs/pim/work_with_product_attributes.md +++ b/docs/product_catalog/work_with_product_attributes.md @@ -22,7 +22,7 @@ Available attribute types are: - Selection - one of a list of customizable options - Symbol - value of product's symbol attribute -If the default list of attributes is not sufficient, ask your development team to [create a custom attribute type]([[= developer_doc =]]/pim/create_custom_attribute_type/). +If the default list of attributes is not sufficient, ask your development team to [create a custom attribute type]([[= developer_doc =]]/product_catalog/create_custom_attribute_type/). !!! note "Attribute translations" diff --git a/docs/pim/work_with_product_categories.md b/docs/product_catalog/work_with_product_categories.md similarity index 91% rename from docs/pim/work_with_product_categories.md rename to docs/product_catalog/work_with_product_categories.md index c84b5fc3..37db02f2 100644 --- a/docs/pim/work_with_product_categories.md +++ b/docs/product_catalog/work_with_product_categories.md @@ -9,9 +9,15 @@ The **Categories** screen is where you manually create a hierarchy of categories ![Product category tree](img/product_categories.png "Product category tree") +!!! note "Quable PIM integration" + + When [Quable is configured as the source of product information](quable_pim_integration.md), product categories are synchronized automatically from [[= pim_product_name =]] product classifications into [[= product_name =]]. + You can't create or modify categories manually, and can't assign products to categories in [[= product_name =]]. + To change the category structure, update classifications in the [[= pim_product_name =]] back office. + ## Product categories -With product categories you can organize products within PIM and create relationships between them. +With product categories you can organize products within product catalog and create relationships between them. One of the reasons for applying product categories is assisting visitors in searching for products. Each category can be assigned to multiple products, and each product can belong to multiple categories of different or similar character, for example: @@ -24,7 +30,7 @@ You can enable the use of product categories, assign products to categories and ## Enable product categories -Before you can assign categories to products, make sure that the *Taxonomy Entry Assignment* field is added and set as required in all the [product types](product_types.md) that define products from PIM which you want to categorize. +Before you can assign categories to products, make sure that the *Taxonomy Entry Assignment* field is added and set as required in all the [product types](product_types.md) that define products from product catalog which you want to categorize. The field could be absent if product types were migrated from an older version of [[= product_name =]]. Depending on your permissions, you might be able to verify the presence of the field and add the field yourself: diff --git a/docs/pim/work_with_product_page_urls.md b/docs/product_catalog/work_with_product_page_urls.md similarity index 100% rename from docs/pim/work_with_product_page_urls.md rename to docs/product_catalog/work_with_product_page_urls.md diff --git a/docs/pim/work_with_product_variants.md b/docs/product_catalog/work_with_product_variants.md similarity index 100% rename from docs/pim/work_with_product_variants.md rename to docs/product_catalog/work_with_product_variants.md diff --git a/docs/recommendations/raptor_integration/img/advanced_settings.png b/docs/recommendations/raptor_integration/img/advanced_settings.png new file mode 100644 index 00000000..d63a18e4 Binary files /dev/null and b/docs/recommendations/raptor_integration/img/advanced_settings.png differ diff --git a/docs/recommendations/raptor_integration/img/raptor_module.png b/docs/recommendations/raptor_integration/img/raptor_module.png new file mode 100644 index 00000000..0cddfb73 Binary files /dev/null and b/docs/recommendations/raptor_integration/img/raptor_module.png differ diff --git a/docs/recommendations/raptor_integration/img/recommendation_blocks.png b/docs/recommendations/raptor_integration/img/recommendation_blocks.png new file mode 100644 index 00000000..db8ef552 Binary files /dev/null and b/docs/recommendations/raptor_integration/img/recommendation_blocks.png differ diff --git a/docs/recommendations/raptor_integration/raptor_recommendation_blocks.md b/docs/recommendations/raptor_integration/raptor_recommendation_blocks.md new file mode 100644 index 00000000..0cd4528a --- /dev/null +++ b/docs/recommendations/raptor_integration/raptor_recommendation_blocks.md @@ -0,0 +1,215 @@ +--- +description: Recommendation Page Builder blocks - Raptor integration. +edition: experience +month_change: true +--- + +# Recommendation block reference + +The [Raptor](https://www.raptorservices.com/) integration add-on introduces a set of recommendation blocks. +These blocks are available in [Page Builder](create_edit_pages.md#page-builder-interface) and can be configured to control their behavior and output. + +![Recommendation blocks](img/recommendation_blocks.png) + +Each recommendation block corresponds to a specific Raptor module. +You can configure it in the [Raptor Control Panel](https://controlpanel.raptorsmartadvisor.com/) where parameters and settings can be modified. + +![Raptor module](img/raptor_module.png) + +In Page Builder, only the required parameters for each block can be configured. +Additional, optional settings are available through the **Go to advanced settings in Raptor** link. +It redirects to the respective module configuration in the Raptor Control Panel, where these settings can be adjusted and saved. + +![Advanced settings](img/advanced_settings.png) + +Raptor recommendations can be added to a landing page by using blocks that belong to the following categories: + +## Recommendations: Content + +The following blocks can be used to present content recommendations: + +|Block|Description| +|-----|-----------| +|[Content that has been seen along with the item category](#content-that-has-been-seen-along-with-the-item-category-block)|Displays content frequently viewed together with items from the same category.| +|[Most popular content](#most-popular-content-block)|Highlights the most frequently viewed content.| +|[Other customers have also seen this content](#other-customers-have-also-seen-this-content-block)|Displays content viewed by other users with similar behavior.| +|[Personalized content recommendations](#personalized-content-recommendations-block)|Provides personalized content recommendations based on user behavior and preferences.| + +### Content that has been seen along with the item category block + +Shows content that is often viewed together with items in the same category. +Helps users discover related content. + +This block uses the [GetContentBasedOnProductCategoryWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetContentBasedOnProductCategoryWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Product category** - Select product category. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +### Most popular content block + +Highlights the most trending or popular content that is most frequently viewed by users across the website. +It helps identify popular and relevant content items. + +This block uses the [GetPopularContentWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPopularContentWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +### Other customers have also seen this content block + +Highlights content viewed by other users with similar behavior. +Usually applied on the content page, returns content that is often viewed together with the given content. +It increases the engagement of the customers by helping identify related and relevant content. + +This block uses the [GetSimilarContentWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetSimilarContentWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Select content for recommendations** - Select content to be used for recommendations. This content is used as the basis for recommendations, allowing Raptor to suggest similar or related items. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +### Personalized content recommendations block + +Generates complementary, personalized content tailored to each user based on their behavior and preferences. +Increases relevance and engagement through personalized suggestions. + +This block uses the [GetUserContentRecommendationsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserContentRecommendationsWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +## Recommendations: Product + +The following blocks can be used to display product suggestions based on visitors’ browsing history: + +|Block|Description| +|-----|-----------| +|[Most popular products](#most-popular-products-block)|Presents trending and highly popular products.| +|[Most popular products in category](#most-popular-products-in-category-block)|Highlights products that are most popular in the category.| +|[Other customers have also seen](#other-customers-have-also-seen-block)|Shows products also viewed by other customers.| + +### Most popular products block + +Presents products that are currently trending and widely popular among users. +Its behavior is defined by the calculation type, interaction type, and aggregation period. +Helps quickly identify top-performing and popular items. + +This block uses the [GetPopularItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPopularItemsWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +Toggle the **Show only available items** option on to display only products that are currently in stock. + +### Most popular products in category block + +Displays the most popular products within a selected category. +Its behavior is defined by the interaction type and aggregation period. +Helps identify the most popular items within a specific category. + +This block uses the [GetPopularItemsInCategoryWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPopularItemsInCategoryWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Product category** - Select product category. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +Toggle the **Show only available items** option on to display only products that are currently in stock. + +### Other customers have also seen block + +Shows products viewed by users with similar behavior. +Usually applied on the product page, returns items that are often viewed together with the given product. +Enhances user experience by suggesting related products. + +This block uses the [GetSimilarItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetSimilarItemsWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Product code** - Enter a product code to be used as a base product or select the base product from the Product catalog. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +Toggle the **Show only available items** option on to display only products that are currently in stock. + +## Recommendations: Commerce + +The following blocks can be used to show recommendations based on visitors purchase history (buy and basket events): + +|Block|Description| +|-----|-----------| +|[Other customers have also purchased](#other-customers-have-also-purchased-block)|Displays items purchased by other customers who bought the same product.| +|[The Personal Shopping Assistant](#the-personal-shopping-assistant-block)|Assists users by suggesting relevant products in real time based on their activity.| +|[User's item history](#users-item-history-block)|Displays the user’s item history or current basket, sorted by recent or top items.| + +### Other customers have also purchased block + +Suggests products commonly bought together. +Helps users find related products to encourage additional purchases. + +This block uses the [GetPIMRelatedItemsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetPIMRelatedItemsWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Product code** - Enter a product code to be used as a base product or select the base product from the Product catalog. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +Toggle the **Show only available items** option on to display only products that are currently in stock. + +### The Personal Shopping Assistant block + +Provides real-time product recommendations based on user behavior. +The web personal shopping assistant recommends items at each step of the customer journey, with a short-term focus. +It helps users discover relevant items while browsing by providing personalized recommendations based on their current behavior. + +This block uses the [GetUserItemRecommendationsWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserItemRecommendationsWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Product (optional)** - Add or select base product. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +Toggle the **Show only available items** option on to display only products that are currently in stock. + +### User's item history block + +Shows the user’s past or current basket items, sorted by recent activity or top items. +Makes it easier to find and review previously viewed or added products. +This module can be configured to return recently viewed items, most interacted items, or items currently in the basket. + +This block uses the [GetUserItemHistoryWeb](https://controlpanel.raptorsmartadvisor.com/pc/customer/tnt/product/web/module/GetUserItemHistoryWeb) Raptor recommendation strategy. + +On the **Properties** tab, set values in the following fields: + +- **Name** – Enter a name for the page block. +- **Name displayed on page (optional)** - Enter a name for the block to be displayed on the page. +- **Recommendations limit** - Set the number of recommendations to be displayed. Default = 4. + +Toggle the **Show only available items** option on to display only products that are currently in stock. + + +!!! tip + + For a list of all blocks available in Page Builder, see [Block reference](block_reference.md). diff --git a/docs/user_management/manage_users.md b/docs/user_management/manage_users.md index bd9a93e3..4219ba25 100644 --- a/docs/user_management/manage_users.md +++ b/docs/user_management/manage_users.md @@ -11,6 +11,10 @@ You can view all user groups and Users in the **Admin** panel by selecting **Use Here, you can manage users, their relations, roles, and policies. As you can see, the interface is the same as when working with regular content items. +!!! caution + + If you are creating a new user group, remember to [exclude it in product tour configuration]([[= developer_doc =]]/administration/back_office/configure_product_tour#user-group-restrictions) if necessary. + ![Users section](img/users_section.png) !!! caution diff --git a/mkdocs.yml b/mkdocs.yml index 7613cd9e..e52404ea 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -54,24 +54,25 @@ nav: - AI Actions: - AI Actions: ai_actions/ai_actions.md - Work with AI Actions: ai_actions/work_with_ai_actions.md - - PIM: - - Product Information Management: pim/pim.md - - PIM settings: - - Product types: pim/product_types.md - - Create product types: pim/create_product_types.md - - Work with product attributes: pim/work_with_product_attributes.md - - Work with currencies: pim/manage_currencies.md + - Product catalog: + - Product catalog: product_catalog/product_catalog.md + - Quable PIM integration: product_catalog/quable_pim_integration.md + - Product catalog settings: + - Product types: product_catalog/product_types.md + - Create product types: product_catalog/create_product_types.md + - Work with product attributes: product_catalog/work_with_product_attributes.md + - Work with currencies: product_catalog/manage_currencies.md - Products: - - Products: pim/products.md - - Create and edit products: pim/create_edit_product.md - - Create virtual products: pim/create_virtual_product.md - - Work with product assets: pim/work_with_product_assets.md - - Work with product variants: pim/work_with_product_variants.md - - Work with product prices: pim/manage_prices.md - - Work with product availability and stock: pim/manage_availability_and_stock.md - - Work with catalogs: pim/work_with_catalogs.md - - Work with product categories: pim/work_with_product_categories.md - - Work with product page URLs: pim/work_with_product_page_urls.md + - Products: product_catalog/products.md + - Create and edit products: product_catalog/create_edit_product.md + - Create virtual products: product_catalog/create_virtual_product.md + - Work with product assets: product_catalog/work_with_product_assets.md + - Work with product variants: product_catalog/work_with_product_variants.md + - Work with product prices: product_catalog/manage_prices.md + - Work with product availability and stock: product_catalog/manage_availability_and_stock.md + - Work with catalogs: product_catalog/work_with_catalogs.md + - Work with product categories: product_catalog/work_with_product_categories.md + - Work with product page URLs: product_catalog/work_with_product_page_urls.md - Content publishing: - Publish content: content_management/publish_instantly.md - Schedule publication: content_management/schedule_publishing.md @@ -118,6 +119,9 @@ nav: - Integrate scenario results: personalization/integrate_scenario_results.md - Import source data: personalization/content_import.md - Review performance: personalization/review_perso_performance.md + - Recommendations: + - Raptor integration: + - Recommendation blocks: recommendations/raptor_integration/raptor_recommendation_blocks.md - Ibexa Engage: - Ibexa Engage: ibexa_engage/ibexa_engage.md - DAM: @@ -192,11 +196,12 @@ extra: product_name_oss: 'Ibexa OSS' product_name_dam: 'Ibexa DAM' product_name_engage: 'Ibexa Engage' + pim_product_name: 'Quable' developer_doc: 'https://doc.ibexa.co/en/5.0' - latest_tag_4_6: '4.6.28' - latest_tag_5_0: '5.0.6' + latest_tag_4_6: '4.6.29' + latest_tag_5_0: '5.0.7' extra_css: - fonts/MavenPro.css diff --git a/plugins.yml b/plugins.yml index f30110cf..77a27471 100644 --- a/plugins.yml +++ b/plugins.yml @@ -16,21 +16,21 @@ plugins: 'getting_started.md': 'getting_started/get_started.md' 'taxonomy.md': 'content_management/taxonomy/taxonomy.md' 'translating_content.md': 'content_management/translate_content.md' - 'shop_administration/manage_prices_and_stock.md': 'pim/manage_prices.md' - 'pim/manage_prices_and_stock.md': 'pim/manage_prices.md' - 'shop_administration/manage_products.md': 'pim/manage_products.md' + 'shop_administration/manage_prices_and_stock.md': 'product_catalog/manage_prices.md' + 'pim/manage_prices_and_stock.md': 'product_catalog/manage_prices.md' + 'shop_administration/manage_products.md': 'product_catalog/manage_products.md' 'shop_administration/navigation_structure.md': 'getting_started/discover_ui.md' - 'shop_administration/product_categories.md': 'pim/product_categories.md' - 'shop_administration/product_variants_and_assets.md': 'pim/product_variants_and_assets.md' + 'shop_administration/product_categories.md': 'product_catalog/product_categories.md' + 'shop_administration/product_variants_and_assets.md': 'product_catalog/product_variants_and_assets.md' 'site_organization/working_with_page.md': 'content_management/create_edit_pages.md' 'site_organization/organizing_the_site.md': 'permission_management/permissions_and_users.md' 'publishing/publishing.md': 'persona_paths/publish_content.md' 'publishing/advanced_publishing_options.md': 'content_management/schedule_publishing.md' 'site_organization/work_with_page.md': 'content_management/create_edit_pages.md' - 'shop_administration/product_variants_and_assets.md': 'pim/work_with_product_variants.md' - 'shop_administration/manage_products.md': 'pim/products.md' - 'shop_administration/product_categories.md': 'pim/work_with_product_categories.md' - 'shop_administration/catalogs.md': 'pim/work_with_catalogs.md' + 'shop_administration/product_variants_and_assets.md': 'product_catalog/work_with_product_variants.md' + 'shop_administration/manage_products.md': 'product_catalog/products.md' + 'shop_administration/product_categories.md': 'product_catalog/work_with_product_categories.md' + 'shop_administration/catalogs.md': 'product_catalog/work_with_catalogs.md' 'shop_administration/cockpit.md': 'customer_management/customer_portal.md' 'shop_administration/customer_portal.md': 'customer_management/customer_portal.md' 'shop_administration/company_self_registration.md': 'customer_management/company_self_registration.md' @@ -49,4 +49,19 @@ plugins: 'commerce/payment/configure_payment_method.md': 'commerce/payment/work_with_payment_methods.md' 'commerce/shipping/configure_shipping_method.md': 'commerce/shipping_management/work_with_shipping_methods.md' 'commerce/payment/create_payment_methods.md': 'commerce/payment/work_with_payment_methods.md' - 'commerce/shipping_management/configure_shipping_methods.md': 'commerce/shipping_management/work_with_shipping_methods.md' \ No newline at end of file + 'commerce/shipping_management/configure_shipping_methods.md': 'commerce/shipping_management/work_with_shipping_methods.md' + 'pim/pim.md': 'product_catalog/product_catalog.md' + 'pim/create_edit_product.md': 'product_catalog/create_edit_product.md' + 'pim/create_product_types.md': 'product_catalog/create_product_types.md' + 'pim/create_virtual_product.md': 'product_catalog/create_virtual_product.md' + 'pim/manage_availability_and_stock.md': 'product_catalog/manage_availability_and_stock.md' + 'pim/manage_currencies.md': 'product_catalog/manage_currencies.md' + 'pim/manage_prices.md': 'product_catalog/manage_prices.md' + 'pim/product_types.md': 'product_catalog/product_types.md' + 'pim/products.md': 'product_catalog/products.md' + 'pim/work_with_catalogs.md': 'product_catalog/work_with_catalogs.md' + 'pim/work_with_product_assets.md': 'product_catalog/work_with_product_assets.md' + 'pim/work_with_product_attributes.md': 'product_catalog/work_with_product_attributes.md' + 'pim/work_with_product_categories.md': 'product_catalog/work_with_product_categories.md' + 'pim/work_with_product_page_urls.md': 'product_catalog/work_with_product_page_urls.md' + 'pim/work_with_product_variants.md': 'product_catalog/work_with_product_variants.md'