Skip to content
Draft

TMP #424

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 82 additions & 10 deletions docs/content_management/block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,32 @@
|Block|Description|
|-----|-----------|
|[Banner](#banner-block)|Displays an image content item with a URL attached to it.|
|[Bestsellers](#bestsellers-block)|Displays a list of products that were recently a bestseller.|
|[Campaign](#campaign-block)|Displays a campaign selected from [[= product_name_engage =]].|
|[Catalog](#catalog-block)|Displays products from a specific catalog to a selected customer group.|
|[Code](#code-block)|Enables you to place content on your page, for example, text, links, or images, using custom HTML.|
|[Collection](#collection-block)|Displays a set of content items you select manually from the content structure. |
|[Content List](#content-list-block)|Displays content items of a chosen content type (or types) that are contained in a selected folder. |
|[Content Scheduler](schedule_publishing.md#content-scheduler-block)|Displays content items at a pre-defined time. |
|[Dynamic targeting](#dynamic-targeting-block)|Embeds recommended items based on the [Segment](content_organization/classify_content.md#segments) the user belongs to. |
|[Embed](#embed-block)|Embeds a content item of any content type on the page. |
|[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. |
|[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. |

Check notice on line 28 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L28

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 28, "column": 85}}}, "severity": "INFO"}

Check notice on line 28 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L28

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 28, "column": 138}}}, "severity": "INFO"}
|[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. |
|[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.|
|[Targeting](#targeting-block)|Embeds an content item based on the [segment](content_organization/classify_content.md#segments) the user belongs to. |
|[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. |

Page Builder has two main views that you can use while creating a page:

- **Page blocks** toolbox - consists of all available elements that you can use by dragging them and dropping on a drop zone.

![Page blocks toolbox](img/page_blocks_toolbox.png)

- **Structure view** toolbox - shows a structure of your page, including their division into zones and the blocks that they contain.

![Structure view toolbox](img/structure_view.png)
[[= include_file('docs/content_management/create_edit_pages.md', 86, 96) =]]

## Block basics

Expand Down Expand Up @@ -78,6 +76,18 @@
- **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

Displays products that were recently top sellers, to help users discover popular items quickly.
On the **Properties** tab, set values in the following fields:

- **Name** – Enter a name for the page block.
- **Personalization scenario** – Select "Bestsellers" to display popular products.
- **Product types to be displayed** – Select the type of products to be displayed on the list.

Check notice on line 86 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L86

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 86, "column": 22}}}, "severity": "INFO"}

Check notice on line 86 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L86

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 86, "column": 70}}}, "severity": "INFO"}
- **Limit** – Set the number of products to be displayed.

Check notice on line 87 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L87

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 87, "column": 45}}}, "severity": "INFO"}

On the **Design** tab, in the **View** field, select the layout to be used to present a list of products and submit your changes.

Check warning on line 89 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L89

[Ibexa.DontCapitalize] Don't capitalize 'Design' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Design' if inside the sentence.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 89, "column": 10}}}, "severity": "WARNING"}

Check notice on line 89 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L89

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 89, "column": 68}}}, "severity": "INFO"}

## Campaign block

Displays a campaign created and configured in [[[= product_name_engage =]]](../ibexa_engage/ibexa_engage.md).
Expand Down Expand Up @@ -130,6 +140,22 @@
- **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 provides recommended items based on users related to the configured segments.

On the **Properties** tab, set values in the following fields:

- **Name** — Enter a name for the page block.
- **Select default scenario** — Select the default scenario for recommended items that should be rendered if the current user

Check notice on line 150 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L150

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 150, "column": 95}}}, "severity": "INFO"}
is not assigned to any segment.
- **Setup segment and scenario matching priority rules** — Select a segment group, a segment identifier and Scenario that you want to display recommendations from.
- **Display limit** — Set the number of products to be displayed.

Check notice on line 153 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L153

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 153, "column": 53}}}, "severity": "INFO"}

The rules are checked in order, so when a user belongs to more than one segment, the first rule applies.

Check notice on line 155 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L155

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 155, "column": 11}}}, "severity": "INFO"}

![Dynamic targeting](img/page_builder_dynamic_targeting.png)

## Embed block

Place any content item directly on the page. This function works across all content types seamlessly.
Expand Down Expand Up @@ -178,6 +204,28 @@

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

Showcases a list of recently purchased products from PIM.
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.
- **Product Types to be displayed** – Select the type of products to be displayed on the list.

Check notice on line 215 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L215

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 215, "column": 22}}}, "severity": "INFO"}

Check notice on line 215 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L215

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 215, "column": 70}}}, "severity": "INFO"}
- **Limit** – Set the number of products to be displayed.

Check notice on line 216 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L216

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 216, "column": 45}}}, "severity": "INFO"}

## Last viewed block

Showcases a list of recently viewed products from PIM.
Helps track and show recent product interests for quick access and informed decisions.
On the **Properties** tab, set values in the following fields:

- **Name** – Enter a name for the page block.
- **Personalization scenario** – Select "Last viewed" to display products that were recently viewed by any user, or "Last viewed by user" to display products that were recently viewed by the current user.
- **Product Types to be displayed** – Select the type of products to be displayed on the list.

Check notice on line 226 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L226

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 226, "column": 22}}}, "severity": "INFO"}

Check notice on line 226 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L226

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 226, "column": 70}}}, "severity": "INFO"}
- **Limit** – Set the number of products to be displayed.

Check notice on line 227 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L227

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 227, "column": 45}}}, "severity": "INFO"}

## Orders block

Showcases a list of orders linked to a specific company or individual customer.
Expand All @@ -190,6 +238,19 @@
- **Number of orders** — Set the number of orders to be displayed.
- **Sort order** — Set the sort order for the displayed orders.

## 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.
On the **Properties** tab, set values in the following fields:

- **Name** – Enter a name for the page block.
- **Select a scenario** – Select "Landing page" or "Top clicked".
- **Select a content type to be displayed** – Select "Product".

Check notice on line 249 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L249

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 249, "column": 30}}}, "severity": "INFO"}
- **Display limit** – Set the number of products to be displayed.

Check notice on line 250 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L250

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 250, "column": 53}}}, "severity": "INFO"}

On the **Design** tab, in the **View** field, change the layout to "Products" and submit your changes.

Check warning on line 252 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L252

[Ibexa.DontCapitalize] Don't capitalize 'Design' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Design' if inside the sentence.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 252, "column": 10}}}, "severity": "WARNING"}

## Product collection block

Presents curated collections of items for easier exploration and discovery.
Expand All @@ -202,6 +263,17 @@

Due to a technical limitation, content browser doesn't display product variants.

## Recently added block

Highlights recently added products from PIM.
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.
- **Product Types to be displayed** – Select the type of products to be displayed on the list.

Check notice on line 274 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L274

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 274, "column": 22}}}, "severity": "INFO"}

Check notice on line 274 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L274

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 274, "column": 70}}}, "severity": "INFO"}
- **Limit** – Set the number of products to be displayed.

Check notice on line 275 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/block_reference.md#L275

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 275, "column": 45}}}, "severity": "INFO"}

## RSS block

Imports and showcases news content from RSS feeds (channels), helping users stay informed with the latest updates and diverse news sources.
Expand Down Expand Up @@ -289,4 +361,4 @@
- **Name** – Enter a name for the page block.
- **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.
On the **Properties** tab you can preview the selected video before adding it to the page.
2 changes: 2 additions & 0 deletions docs/content_management/create_edit_pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@ For a list of blocks available out of the box, see [Block reference](block_refer

Before you add a block that involves products, product types, or product categories, make sure your that your [user role](../permission_management/permissions_and_users.md) has the `Product/View` and `Product type/View` permission.

Before you add a block that uses results derived from a [Personalization](../personalization/personalization.md) scenario, for example, [Dynamic targeting](block_reference.md#dynamic-targeting-block) or [Recently added block](block_reference.md#recently-added-block), make sure that the scenario is [properly configured](../personalization/configure_scenarios.md).

You can work with the block, for example, duplicate it, change its position, or delete it.
Hover over the block and the toolbar appears.
Click the three dots icon to see more options.
Expand Down
17 changes: 17 additions & 0 deletions docs/getting_started/dashboard/dashboard_block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
|[Recent activity](#recent-activity-block)|Displays a list of recent activity of all or selected users.|
|[Recent orders](#recent-orders-block)|Displays a table presenting recent orders and their status.|
|[Review queue](#review-queue-block)|Displays a list of content items which user or user group can review.|
|[Top 10 clicked items](#top-10-clicked-items-block)|Displays a table presenting top 10 clicked items.|

!!! note

Expand Down Expand Up @@ -152,3 +153,19 @@
- **Name** - Enter a name for the block.

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.

## Top 10 clicked items block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]

Requires [Ibexa Personalization](personalization.md) enabled.

Check failure on line 159 in docs/getting_started/dashboard/dashboard_block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/dashboard/dashboard_block_reference.md#L159

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/getting_started/dashboard/dashboard_block_reference.md", "range": {"start": {"line": 159, "column": 11}}}, "severity": "ERROR"}

Displays a table presenting top 10 clicked items.

Table contains following columns: Item clicked (including item name), Item type, Recommended (presenting number of recommendations of selected item),
Clicked (presenting total number of clicks on selected item).

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.

Check notice on line 169 in docs/getting_started/dashboard/dashboard_block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/dashboard/dashboard_block_reference.md#L169

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/getting_started/dashboard/dashboard_block_reference.md", "range": {"start": {"line": 169, "column": 60}}}, "severity": "INFO"}

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.

Check warning on line 171 in docs/getting_started/dashboard/dashboard_block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/dashboard/dashboard_block_reference.md#L171

[Ibexa.DontCapitalize] Don't capitalize 'Design' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Design' if inside the sentence.", "location": {"path": "docs/getting_started/dashboard/dashboard_block_reference.md", "range": {"start": {"line": 171, "column": 10}}}, "severity": "WARNING"}

Check notice on line 171 in docs/getting_started/dashboard/dashboard_block_reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/dashboard/dashboard_block_reference.md#L171

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/getting_started/dashboard/dashboard_block_reference.md", "range": {"start": {"line": 171, "column": 68}}}, "severity": "INFO"}
2 changes: 2 additions & 0 deletions docs/persona_paths/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Whether you're a new or seasoned user of [[= product_name =]], feel free to brow
"persona_paths/author_content",
"persona_paths/organize_content",
"content_management/taxonomy/taxonomy",
"personalization/personalization",
"personalization/configure_personalization",
"search_engine_optimization/seo",
"pim/products",
"persona_paths/manage_products",
Expand Down
63 changes: 63 additions & 0 deletions docs/personalization/configure_models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
description: Configure models by setting up a timeframe, segments and other settings that define which content items are recommended.

Check notice on line 2 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L2

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 2, "column": 118}}}, "severity": "INFO"}
---

# Configure models

If your [user role](../permission_management/permissions_and_users.md) has the `Personalization/Edit` permission that includes your website, you can modify model settings according to your requirements.

Go to **Personalization** > **Models** to see a page that lists all available [models](recommendation_models.md) and provides detailed information, such as the [scenarios](scenarios.md) that use each model, or when the model was last triggered.

![Models page in the back office](img/dashboard_models.png "Models page")

Here, you can click the **Edit** icon to access the model configuration screen and modify the settings, for example:

Check notice on line 14 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L14

[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.
Raw output
{"message": "[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 14, "column": 1}}}, "severity": "INFO"}
- A timeframe over which the algorithm gathers [events](event_types.md) that are used in the calculation

Check notice on line 15 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L15

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 15, "column": 78}}}, "severity": "INFO"}
- [Submodels](recommendation_models.md#submodels) that can narrow down the list of model results
- [Segments](segment_management.md#configure-segments) that allow getting personalized content suitable for particular user groups
- A list of items included or excluded from the model

Check notice on line 18 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L18

[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.
Raw output
{"message": "[Ibexa.Lists] Verify list formatting: Full sentences should start with uppercase and end with a period. Sentence fragments should start with lowercase and have no period.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 18, "column": 1}}}, "severity": "INFO"}

For more information and a list of model types, see [Recommendation models](recommendation_models.md).

### Advanced model configuration

Most of the models provide additional configuration parameters, which enable customization.

The parameters supported by different model types are described in the table below.

Check notice on line 26 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L26

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 26, "column": 51}}}, "severity": "INFO"}
Some models support [submodels](recommendation_models.md#submodels).
Additional differentiation criterion is the supported context.
If a model requires context, it can only be linked to scenarios that provide the necessary context.

Check notice on line 29 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L29

[Ibexa.WhiteSpace] Use regular whitespace
Raw output
{"message": "[Ibexa.WhiteSpace] Use regular whitespace", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 29, "column": 11}}}, "severity": "INFO"}

Check notice on line 29 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L29

[Ibexa.WhiteSpace] Use regular whitespace
Raw output
{"message": "[Ibexa.WhiteSpace] Use regular whitespace", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 29, "column": 20}}}, "severity": "INFO"}

Check notice on line 29 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L29

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 29, "column": 42}}}, "severity": "INFO"}

|Model type|Available parameters|Submodel support|Context|
|---|---|---|---|
|Popularity|Relevant event history defines the time period for which the statistics must be analyzed. Depending on the type of product, it can be between several months and several hours. Fast event aging can be used to weight newer events higher than older events.|yes</br>submodels based on category are enabled by default|not needed|

Check notice on line 33 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L33

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 33, "column": 90}}}, "severity": "INFO"}

Check notice on line 33 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L33

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 33, "column": 210}}}, "severity": "INFO"}

Check notice on line 33 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L33

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 33, "column": 303}}}, "severity": "INFO"}
|Also clicked/purchased / Ultimately bought|Both also clicked and ultimately purchased models allow defining the relevant event history.|yes, manual|required (either context items or user data)|
|Recently added|This model requires the maximum age for the items that should be recommended by this model.|yes|not supported|

Check notice on line 35 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L35

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 35, "column": 79}}}, "severity": "INFO"}
|History-based|The type of the history (CLICK-history or BUY-history) must be specified.|no|required (user data)|

Check notice on line 36 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L36

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 36, "column": 76}}}, "severity": "INFO"}
|Editor-based|The list of recommendations must be created manually by the editor.|no|not supported|

Check notice on line 37 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L37

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 37, "column": 48}}}, "severity": "INFO"}
|Blacklist|The list of items that should be excluded from the recommendations must be created manually by the editor.|no|not supported|

Check notice on line 38 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L38

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 38, "column": 42}}}, "severity": "INFO"}

Check notice on line 38 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L38

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 38, "column": 84}}}, "severity": "INFO"}

Do not confuse event history age with item age.
History age is the age of the user's footprint (for example, "User clicked on the product A two weeks ago").
Item age is the time over which the item is available in the web store ("How new is the item").
The history is recorded automatically based on [event](event_types.md) tracking.

Check notice on line 43 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L43

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 43, "column": 13}}}, "severity": "INFO"}
The item catalog must be filled separately as a result of [data import](content_import.md).

Check notice on line 44 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L44

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 44, "column": 23}}}, "severity": "INFO"}

Check notice on line 44 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L44

[Ibexa.WhiteSpace] Use regular whitespace
Raw output
{"message": "[Ibexa.WhiteSpace] Use regular whitespace", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 44, "column": 32}}}, "severity": "INFO"}

### Trigger model build

Models on the Personalization server side are configured to build at intervals, for example, every 24-hours.

Check notice on line 48 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L48

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 48, "column": 43}}}, "severity": "INFO"}
For models which require computation (all [popularity](recommendation_models.md#popularity-models) and [collaborative models](recommendation_models.md#collaborative-models)), you can manually trigger the build, for example, after you modify model settings.

To do this, go to **Personalization** > **Models**.
Click the edit icon next to the model name, make necessary changes, and click the **Trigger model build** button.
On the list of models, the model's status changes to `Build in progress`.
When the build comes out successful, the status changes to `Active`.

![Model build status](img/models_edit.png "Model build status")

Possible model statuses:

- **Active** - model is successfully built
- **Not active** - new model which hasn’t been triggered or used yet, or model that is added to the scenario, calculated and then removed from the scenario

Check warning on line 61 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L61

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 61, "column": 41}}}, "severity": "WARNING"}

Check notice on line 61 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L61

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 61, "column": 43}}}, "severity": "INFO"}

Check notice on line 61 in docs/personalization/configure_models.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_models.md#L61

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_models.md", "range": {"start": {"line": 61, "column": 85}}}, "severity": "INFO"}
- **Build in progress** - model during the building process
- **Failed** - there is no data to build the model or some error occurred, building failed
25 changes: 25 additions & 0 deletions docs/personalization/configure_personalization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
description: Configure your Personalization service by setting up models and scenarios which define which content items are recommended.

Check notice on line 2 in docs/personalization/configure_personalization.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/personalization/configure_personalization.md#L2

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/personalization/configure_personalization.md", "range": {"start": {"line": 2, "column": 121}}}, "severity": "INFO"}
---

# Configure personalization

In the back office, you can you can review the configuration that controls the Personalization service.
If your [user role](../permission_management/permissions_and_users.md) has the `Personalization/Edit` permission that includes your website, you can modify the settings according to your requirements.
To do this, navigate to one of the pages mentioned below and edit the item that you want to modify.

!!! note "Host multiple websites"

If you have permissions to access several websites hosted on an [[= product_name =]] instance, you can use the selector field to switch between views for each of these websites.

[[= cards([
"personalization/configure_models",
"personalization/segment_management",
"personalization/recommendation_models",
"personalization/event_types",
"personalization/configure_scenarios",
"personalization/scenarios",
"personalization/content_types",
"personalization/filters",
"personalization/triggers"
]) =]]
Loading
Loading