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 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
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 @@
|-----|-----------|
|[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,14 @@

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 a campaign created and configured in [Ibexa Engage](../ibexa_engage/ibexa_engage.md).

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

View workflow job for this annotation

GitHub Actions / vale

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

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/content_management/block_reference.md", "range": {"start": {"line": 93, "column": 95}}}, "severity": "WARNING"}
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

Shows products from a chosen catalog tailored for a particular group of customers, ensuring a personalized browsing experience.
Expand Down
89 changes: 89 additions & 0 deletions docs/ibexa_engage/ibexa_engage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---

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 8.45. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 8.45. 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 engage audiences and collect valuable data by using interactive content.
---

# 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.
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_base =]] to define the initial configuration, and then get and set up a user account.

1\. Go to the Back Office.

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

Check failure on line 17 in docs/ibexa_engage/ibexa_engage.md

View workflow job for this annotation

GitHub Actions / vale

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

[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/ibexa_engage/ibexa_engage.md", "range": {"start": {"line": 17, "column": 32}}}, "severity": "ERROR"}

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**, and then click **Send request**.

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

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

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

Click the **Manage campaigns in Qualifio** button to open a Qualifio page, where you can create and manage campaigns.

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

## Campaign

A campaign is a set of different concepts, grouped into steps, and open to configuration.
You can use a campaign to interact with viewers, boost ad impressions, or gather cookies from targeted audiences.

Campaign can contain a welcome screen, a form step, an interaction element, an exit screen, and so on.

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

View workflow job for this annotation

GitHub Actions / vale

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

[Ibexa.Wordy] Remove 'and so on'. Try to use 'like' and provide examples instead.
Raw output
{"message": "[Ibexa.Wordy] Remove 'and so on'. Try to use 'like' and provide examples instead.", "location": {"path": "docs/ibexa_engage/ibexa_engage.md", "range": {"start": {"line": 43, "column": 93}}}, "severity": "WARNING"}
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.
You can also configure the backgrounds, themes, or designs, and set up a specific time frame for each campaign.

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:

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

View workflow job for this annotation

GitHub Actions / vale

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

[Ibexa.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.
Raw output
{"message": "[Ibexa.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.", "location": {"path": "docs/ibexa_engage/ibexa_engage.md", "range": {"start": {"line": 50, "column": 1}}}, "severity": "WARNING"}

- **Anonymous** - engages with the audience, increases the advertising impressions, or collects cookies of personalized audiences.
- **Identified** - gathers information about the user who fills out an identification form.

## Publication channel

Every campaign includes at least one publication channel, which you can choose from the three options the platform offers:

- **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 hosts the campaign. This URL points to your subdomain.

- **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 manage campaigns by using [Qualifio Engage](https://developers.qualifio.com/docs/engage/).
To access the Qualifio Manager page and create or manage campaigns, click the **Manage campaigns in Qualifio** button under the **Ibexa Engage** menu.

Check failure on line 71 in docs/ibexa_engage/ibexa_engage.md

View workflow job for this annotation

GitHub Actions / vale

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

[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/ibexa_engage/ibexa_engage.md", "range": {"start": {"line": 71, "column": 131}}}, "severity": "ERROR"}
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 a [Campaign block](../content_management/block_reference.md#campaign-block) to a page in Page Builder.
In the block's settings, you can select a campaign that you want to display from a drop-down list.
This list includes all campaigns available on user's Qualifio account which are active or scheduled to launch in the future.

![Campaign block](img/campaign_block.png "Campaign block")

### Campaign custom tag

You can embed a campaign within the [Rich Text field](../content_management/create_edit_content_items.md#edit-rich-text-fields) by using a Campaign custom tag.
To do it, select a custom tag from the toolbar, and a choose campaign.

![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
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.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ nav:
- Integrate scenario results: personalization/integrate_scenario_results.md
- Import source data: personalization/content_import.md
- Review performance: personalization/review_perso_performance.md
- Ibexa Engage:
- Ibexa Engage: ibexa_engage/ibexa_engage.md
- DAM:
- Ibexa DAM: dam/ibexa_dam.md
- Customer management:
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