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 16 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
9 changes: 9 additions & 0 deletions docs/content_management/block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The following blocks are provided with a clean installation of [[= product_name
|-----|-----------|
|[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.|
|[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,14 @@ 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

Displays campaign created and configured in Ibexa Engage.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
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. The 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

## Catalog block

Shows products from a chosen catalog tailored for a particular group of customers, ensuring a personalized browsing experience.
Expand Down
85 changes: 85 additions & 0 deletions docs/ibexa_engage/ibexa_engage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
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
## Request access

To use [[= product_name_engage =]], you must make arrangements with [[= product_name =]] to define the initial configuration, and then get and set up user account.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

1\. Go to the Back Office.

2\. On the left panel, go to **Ibexa Engage**.

3\. On the welcome page, provide the required information:

- First and last name
- Email address
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

4\. Accept **Terms and Conditions** checkbox, and then click **Send request**.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

![Welcome page - form](img/welcome_page_form.png "Welcome page - form")

[[= product_name_base =]] team creates and provides user account. An invitation link is sent during the setup process.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
Once the registration and configuration process is completed, the welcome page displays information about campaign tools available with [[= product_name_engage =]] and link to [Qualifio documentation](https://support.qualifio.com/hc/en-us/categories/202280638-Campaigns) where you can get information about creating and managing campaigns.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

![Welcome page - active account](img/welcome_page_activated.png "Welcome page - active account")

Click **Manage campaigns in Qualifio** button to open Qualifio page, where you can create and manage campaigns.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

![Qualifio Manager](img/qualifio_manager.png "Qualifio Manager - campaign list")

## Campaign

A campaign is a set of different concepts, grouped per steps, and open to configuration.
You can use campaign to interact with viewers, boost ad impressions, or gather cookies from targeted audiences.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

Campaign can contain a welcome screen, a form step, an interaction element, an exit screen, and so on.
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.
Users can configure the backgrounds, themes, or designs, and set up a specific time frame for each campaign.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

Each campaign comes with a unique ID - string of numbers, that the platform automatically defines during the creation of campaign. Campaign ID is a reference to the campaign in the applications, services and data connections.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

There are two types of campaigns:

- **Anonymous** - engages with the audience, increases the advertising impressions, or collects cookies of personalized audiences.
- **Identified** - gathers information on the user by filling out an identification form.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

## 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
By default, every type of publication channel is responsive and compatible with all mobile devices.

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

You can create, configure, and create campaigns using [Qualifio Engage](https://developers.qualifio.com/docs/engage/).
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
To access the Qualifio Back Office page and create or manage campaigns, click the **Manage campaigns in Qualifio** button under the **Ibexa Engage** menu.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
To display your campaign on the website, use one of the available tools - Campaign block or Campaign custom tag.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
For more information about creating and managing campaigns, see [Qualifio Engage documentation](https://support.qualifio.com/hc/en-us/categories/202280638-Qualifio-Engage).
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

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** block 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 block](img/campaign_block.png "Campaign block")

### Campaign custom tag

You can embed campaign in the Rich Text field with Campaign custom tag.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
To do it, select custom tag from the toolbar, and a choose campaign.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

![Campaign custom tag](img/campaign_custom_tag.png "Campaign custom tag")
Binary file added docs/ibexa_engage/img/campaign_block.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ibexa_engage/img/campaign_custom_tag.png
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ibexa_engage/img/qualifio_manager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ibexa_engage/img/welcome_page_activated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ibexa_engage/img/welcome_page_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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