Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-7966: Ibexa Engage described in User Documentation #296

Merged
merged 18 commits into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from 6 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
31 changes: 20 additions & 11 deletions docs/content_management/block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
|-----|-----------|
|[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 Ibexa Engage.|

Check failure on line 14 in docs/content_management/block_reference.md

View workflow job for this annotation

GitHub Actions / vale

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

[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/content_management/block_reference.md", "range": {"start": {"line": 14, "column": 64}}}, "severity": "ERROR"}
|[Catalog](#catalog-block)|Displays products from a specific catalog to a selected customer group.|
|[Code](#code-block)|Enables you to place text, links, images, etc. on your Page using custom HTML.|
|[Collection](#collection-block)|Displays a set of content items you select manually from the Content structure. |
Expand Down Expand Up @@ -87,6 +88,25 @@

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

Displays campaign created and configured in Ibexa Engage.
On the **Properties** tab, set values in the following fields:

- **Name** – Enter a name for the campaign.
- **Campaign** – Select campaign to display on the Landing Page.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

## 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.
- **Limit** – Set the number of products to be displayed.

## Catalog block

Shows products from a chosen catalog tailored for a particular group of customers, ensuring a personalized browsing experience.
Expand Down Expand Up @@ -254,17 +274,6 @@

Due to a technical limitation, content browser does not 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.
- **Limit** – Set the number of products to be displayed.

## 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
53 changes: 53 additions & 0 deletions docs/ibexa_engage/ibexa_engage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---

Check warning on line 1 in docs/ibexa_engage/ibexa_engage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_engage/ibexa_engage.md#L1

[Ibexa.ReadingLevel] The grade level is 9.19. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 9.19. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/ibexa_engage/ibexa_engage.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Ibexa Engage helps to engage audiences and collect valuable data by using interactive content.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
---

# Ibexa Engage
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

[[= product_name_engage =]] is a data collection tool. It gives you the ability to use the [Qualifio](https://qualifio.com/) tools to engage your audiences.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
You can use interactive content to build relationships and collect important data, for example, a list of recent orders, or personal information about customers.

julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
## Campaign

A campaign is a collection of ideas that the user can customize and divide into steps.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

It consists of a welcome screen, a form step, an interaction element, and an exit screen.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

You can use Qualifio's existing templates and interactive elements, such as quizzes, pools, and forms, to create visually appealing, customized campaigns.
Qualifio configures the backgrounds, themes, and designs.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

Use campaign to interact with viewers, boost ad impressions, or gather cookies from targeted audiences.

Each campaign comes with a unique ID - string of numbers, that the platform automatically defines at the creation. Campaign ID is a reference to the campaign in the applications, services and data connections.

You can set up prizes for customer when an email or another required pool is filled.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
A prize can be, like special discount, bonus, or free access to some content.
You can set up a specific time frame for each campaign, use conditions, and design.

## Publication channel

Every campaign includes a minimum of one publication channel that you can choose from the three options the platform provides for publishing a campaign:
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

- **Widget/iframe** - uses a JavaScript code or an HTML iframe from Qualifio. Additionally, you can use oEmbed, Facebook Instant articles, and AMP technologies to publish iframes. You need to manually paste the code into your website or CMS.

- **Minisite** - uses a unique URL from Qualifio that can hosts the campaign. This URL points to your subdomain.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

- **Mobile** - uses a link from Qualifio to integrate a campaign that is optimized for mobile usage.

!!! note
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
Each publication channel type is automatically responsive and can be use on any mobile device.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

## Work with campaigns
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

You can create, configure, and create campaigns using [Qualifio Engage](https://support.qualifio.com/hc/en-us/categories/202280638-Qualifio-Engage).
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
To display your campaign on your website, use of the available tools - Campaign block or Campaign custom tag.

julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
### Campaign block

To promote your campaign, you can add [Campaign block](../content_management/block_reference.md#campaign-block) in Page Builder.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
In the **Campaign** tab you can choose campaign from the drop-down list. This list includes all campaigns available on user's Qualifio account which are active or scheduled to launch in the future.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

### Campaign custom tag

You can embed campaign block in the text field with Qualifio custom tag.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
To do it, insert campaign content item in the Rich Text Field.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ nav:
- Work with shipping methods: commerce/shipping_management/work_with_shipping_methods.md
- Payment management: commerce/payment/payment_management.md
- Work with payments: commerce/payment/work_with_payments.md
- Work with payment methods: commerce/payment/work_with_payment_methods.md
- Work with payment methods: commerce/payment/work_with_payment_methods.md
- Ibexa Engage:
- Ibexa Engage: ibexa_engage/ibexa_engage.md
- PIM:
- Product Information Management: pim/pim.md
- PIM settings:
Expand Down Expand Up @@ -170,6 +172,7 @@ extra:
product_name_cloud: 'Ibexa Cloud'
product_name_oss: 'Ibexa OSS'
product_name_dam: 'Ibexa DAM'
product_name_engage: 'Ibexa Engage'

developer_doc: 'https://doc.ibexa.co/en/latest'

Expand Down
Loading