IBX-7966: Ibexa Engage described in Developer documentation (#2339)

* Ibexa Engage described * Page added in mkdocs * Updates * Vale fixes * Screenshots added * Updates * updates * sentence added * Fixes * Ibexa connect part updated * Screenshots added * Fixes, place changed * Fixes, new pages added * Configuration added * Fix * Fixes * Typo fix * Links added * File directory and name added * Order changed * Images moved to ibexa engage folder * Fixes in the structure * Fixes after review * PHP CS Fixes * Fixes after review --------- Co-authored-by: julitafalcondusza <julitafalcondusza@users.noreply.github.com> Co-authored-by: Julita Falcon Dusza <julitafalcondusza@Users-MacBook-Pro.local>
ibexa · Jul 2, 2024 · 5c2665f · 5c2665f
1 parent 0b8dff8
commit 5c2665f
Show file tree

Hide file tree

Showing 10 changed files with 189 additions and 0 deletions.
diff --git a/code_samples/ibexa_engage/config/packages/ibexa_connector_qualifio.yaml b/code_samples/ibexa_engage/config/packages/ibexa_connector_qualifio.yaml
@@ -0,0 +1,38 @@
+ibexa_connector_qualifio:
+    client_id: 1234
+    channel: 'd882c3f1-1b05-48c8-bc1d-c11a45e2c23a'
+    feed_url: 'https://api.qualif.io/v1/campaignfeed/channels/d882c3f1-1b05-48c8-bc1d-c11a45e2c23a/json?clientId=1234'
+    variable_map:
+        form:
+            shipping_address:
+                first_name: 'firstname'
+                last_name: 'lastname'
+                email: 'email'
+                street: 'address'
+                postal_code: 'zip_code'
+                locality: 'locality'
+                country: 'country'
+                phone_number: 'phone'
+            billing_address:
+                first_name: 'firstname'
+                last_name: 'lastname'
+                email: 'email'
+                street: 'address'
+                postal_code: 'zip_code'
+                locality: 'locality'
+                country: 'country'
+                phone_number: 'phone'
+            content:
+                birthday: 'birthday'
+                first_name: 'firstname'
+                last_name: 'lastname'
+                company: 'company'
+                position: 'position'
+                phone: 'phone'
+                gender: 'gender'
+            account:
+                name: 'name'
+                email: 'email'
+                id: 'userid'
+                remote_id: 'identifier'
+                login: 'login'
diff --git a/docs/ibexa_engage/create_campaign.md b/docs/ibexa_engage/create_campaign.md
@@ -0,0 +1,36 @@
+---
+description: Create campaign with Ibexa Engage
+edition: experience
+---
+
+# Create campaign
+
+[Campaign]([[= user_doc =]]/ibexa_engage/ibexa_engage/#campaign) is a set of concepts, divided into steps, that the user can configure.
+It can contain a welcome screen, an interaction element, a form step, an exit screen, and so on.
+To create new campaign, you need to use Qualifio Manager.
+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.
+
+Technically, each campaign has a unique campaign ID, that is automatically defined by the Qualifio platform when it is created.
+
+For more information about creating and managing campaigns, see [Qualifio documentation](https://support.qualifio.com/hc/en-us/categories/202280638-Campaigns).
+
+## Publication channels
+
+Each campaign includes a minimum of one publication channel that you can choose from the three options the platform provides for publishing a campaign.
+For more information about publication channels, see [Publication channel]([[= user_doc =]]/ibexa_engage/ibexa_engage/#publication-channel) in the User Documentation.
+
+## Use Campaign block in Page Builder
+
+You can add [Campaign block]([[= user_doc =]]/content_management/block_reference/#campaign-block) in Page Builder to display campaign on the Landing Page.
+
+To select campaign, go to **Properties** tab -> **Campaign** and 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.
+
+![Campaign block](campaign_block.png "Campaign block")
+
+## Embed campaign in the Rich text field
+
+You can embed campaign in the Rich text field with Campaign custom tag.
+To do it, insert campaign content item in the Rich Text Field and paste Campaign URL.
+
+![Campaign custom tag](campaign_custom_tag.png "Campaign custom tag")
diff --git a/docs/ibexa_engage/img/campaign_block.png b/docs/ibexa_engage/img/campaign_block.png
diff --git a/docs/ibexa_engage/img/campaign_custom_tag.png b/docs/ibexa_engage/img/campaign_custom_tag.png
diff --git a/docs/ibexa_engage/img/configure_ibexa_engage.png b/docs/ibexa_engage/img/configure_ibexa_engage.png
diff --git a/docs/ibexa_engage/img/create_scenario.png b/docs/ibexa_engage/img/create_scenario.png
diff --git a/docs/ibexa_engage/img/create_webhook.png b/docs/ibexa_engage/img/create_webhook.png
diff --git a/docs/ibexa_engage/install_ibexa_engage.md b/docs/ibexa_engage/install_ibexa_engage.md
@@ -0,0 +1,53 @@
+---
+description: Install and configure Ibexa Engage.
+edition: experience
+---
+
+# [[= product_name_engage =]]
+
+[[= product_name_engage =]] is a data collection tool. It enables you to engage your audiences by using the [Qualifio](https://qualifio.com/) tools.
+You can use interactive content to gather valuable data, for example, customer data or recent orders list, and create connections.
+
+For more information, see [Qualifio Developers documentation](https://developers.qualifio.com/docs/engage/).
+
+## Enable [[= product_name_engage =]] account
+
+To use [[= product_name_engage =]], you must make arrangements with [[= product_name =]] to define the initial configuration.
+[[= product_name_base =]] team creates and provides user account. An invitation link is sent during the setup process.
+
+For more information, see [Ibexa Engage in User documentation]([[= user_doc =]]/ibexa_engage/ibexa_engage/#request-access).
+
+## Install [[= product_name_engage =]]
+
+[[= product_name_engage =]] comes from v4.6.6 of [[= product_name_exp=]].
+If you have different version, run the following command to install the bundle:
+
+``` bash
+composer require ibexa/engage
+```
+
+You can check for its presence by using the following command:
+
+``` bash
+composer show | grep "ibexa/engage"
+```
+
+This command adds to your project configuration files required for using [[= product_name_engage =]].
+
+## Prepare configuration files
+
+In `config/packages` directory add the following `ibexa_connector_qualifio.yaml` [YAML configuration](configuration.md#configuration-files):
+
+``` yaml
+[[= include_file('code_samples/ibexa_engage/config/packages/ibexa_connector_qualifio.yaml') =]]
+```
+
+- `client_id` - an identifier of the user.
+- `channel` - an UUID identifier format: a string of 30+ characters, divided by four hyphens, specific per publication channel.
+- `feed_url` - an URL link of the campaign feed. To create a campaign feed, follow the [Qualifio documentation](https://support.qualifio.com/hc/en-us/articles/360022954454-About-Campaign-Feeds).
+
+!!! note
+
+    [[= product_name_base =]] configures the `channel` and `client_id` values so that the selections can be filled up automatically on [[= product_name =]] side.
+
+    The `feed_url` and `variable_map` values don't need to be set at the installation process. They are preconfigured and can be overwritten.
diff --git a/docs/ibexa_engage/integrate_ibexa_connect.md b/docs/ibexa_engage/integrate_ibexa_connect.md
@@ -0,0 +1,57 @@
+---
+description: Integrate Ibexa Engage with Ibexa Connect
+edition: experience
+---
+
+# Use Ibexa Connect
+
+You can create workflows using [Ibexa Connect](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_connect/).
+[[= product_name_engage =]] collects user data and passes it directly to [[= product_name_connect =]].
+With this data, you can create scenarios, for example, to add a user to newsletter, or to specific user segment group.
+
+For more information, see [Ibexa Connect documentation](https://doc.ibexa.co/projects/connect/en/latest/).
+
+## Integrate [[= product_name_engage =]] with [[= product_name_connect =]]
+
+Webhooks provide a powerful way to transfer data between applications in real-time.
+You can use webhooks to connect [[= product_name_engage =]] with [[= product_name_connect =]] - integration platform (iPaaS).
+
+This integration allows to collect data using [[= product_name_engage =]] and then push it to another systems, such as CRMs, CDP, Marketing Automation platforms, or more.
+
+### Get the webhook URL
+
+Use [[= product_name_engage =]] App and scenario to get the webhook URL from [[= product_name_connect =]].
+
+To set up a webhook in [[= product_name_connect =]], follow the steps:
+
+1\. Log in to your [[= product_name_connect =]] account.
+
+2\. Go to **Scenarios** and click the plus button to create a new scenario.
+
+3\. Select **Receive participation data**.
+
+![Create a scenario](create_scenario.png "Create a scenario")
+
+4\. Click **Create a webhook** and provide a name for the new webhook.
+
+5\. Click **Copy address to clipboard** to save the URL.
+
+![Create a webhook](create_webhook.png "Create a webhook")
+
+### Configure [[= product_name_engage =]]
+
+The next step is to configure [[= product_name_engage =]].
+
+When a form submission event takes place, data can be sent through the obtained webhook URL.
+
+To do it, perform the following actions::
+
+1\. Log in to your [[= product_name_engage =]] account.
+
+2\. Go to **Engage** -> **Integrations** -> **Integrations** and select **Webhook**.
+
+3\. Paste the URL from the clipboard into **Webhook Host** field and click **Save**.
+
+![Configure Ibexa Engage](configure_ibexa_engage.png "Configure Ibexa Engage")
+
+4\. Then, go to **Engage** -> **Integrations** -> **Push rules** to define the default or specific rules for new campaign or website. Select the created webhook.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -383,6 +383,10 @@ nav:
         - Create Customer Portal: customer_management/cp_page_builder.md
         - Customer Portal Applications: customer_management/cp_applications.md
         - Create registration form: customer_management/create_user_registration_form.md
+    - Ibexa Engage:
+        - Install Ibexa Engage: ibexa_engage/install_ibexa_engage.md
+        - Create campaign with Ibexa Engage: ibexa_engage/create_campaign.md
+        - Integrate Ibexa Engage with Ibexa Connect: ibexa_engage/integrate_ibexa_connect.md
     - Multisite:
         - Multisite: multisite/multisite.md
         - Multisite configuration: multisite/multisite_configuration.md
@@ -892,6 +896,7 @@ extra:
   product_name_connect: 'Ibexa Connect'
   product_name_cloud: 'Ibexa Cloud'
   product_name_oss: 'Ibexa OSS'
+  product_name_engage: 'Ibexa Engage'
   # Global variables - latest tag versions
   latest_tag_2_5: '2.5.32'
   latest_tag_3_3: '3.3.37'