-
Notifications
You must be signed in to change notification settings - Fork 81
IBX-10688: SiteAccess-aware Raptor connector configuration documented in Dev-doc #3101
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
base: 5.0
Are you sure you want to change the base?
Changes from all commits
92ae029
b138e44
e769a20
d16400a
72be3b9
23f96e6
03934df
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,53 @@ | ||||||||||||||
| --- | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we document the non-siteaccess-aware settings? |
||||||||||||||
| description: Step-by-step configuration procedure of SiteAccess-aware Raptor connector. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ## Configuration | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please add a H1 header ( |
||||||||||||||
|
|
||||||||||||||
| To configure Raptor connector, use the ibexa.system.<scope>.connector_raptor configuration key: | ||||||||||||||
|
|
||||||||||||||
| ```yaml | ||||||||||||||
| # config/packages/ibexa_connector_raptor.yaml: | ||||||||||||||
|
|
||||||||||||||
| ibexa: | ||||||||||||||
| system: | ||||||||||||||
| <scope>: | ||||||||||||||
| connector_raptor: | ||||||||||||||
| enabled: true | ||||||||||||||
| customer_id: ~ # Required | ||||||||||||||
| tracking_type: client # One of: "client" or "server" | ||||||||||||||
|
|
||||||||||||||
| # Raptor Recommendations API key | ||||||||||||||
| recommendations_api_key: ~ # Required | ||||||||||||||
|
|
||||||||||||||
| # Raptor Recommendations API URL, optional, set by default | ||||||||||||||
| recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%' | ||||||||||||||
| ``` | ||||||||||||||
| - `enabled` - enables or disables the Connector for a given scope, default value: `true`. If set to `false`, no tracking or recommendation requests are executed. | ||||||||||||||
|
Check notice on line 27 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
| - `customer_id` - an identifier used to authenticate requests to the Recommendation Engine. This value is can be found as `Account number` in [Raptor Control Panel](https://controlpanel.raptorsmartadvisor.com/). | ||||||||||||||
|
Check notice on line 28 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| - `tracking_type` - defines how user events are sent to the tracking API. Possible values: | ||||||||||||||
|
Check notice on line 29 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Of course an additional question is why |
||||||||||||||
| - `client` - tracking is executed in the browser using JavaScript snippets generated by Twig functions and included in templates. This approach may be blocked by ad blockers. | ||||||||||||||
|
Check notice on line 30 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A link to #3105 and #3110 functions would be nice. |
||||||||||||||
| - `server` - tracking is handled on the backend, with events sent directly to the tracking API. It's not affected by ad blockers. | ||||||||||||||
|
Check notice on line 31 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. About ad blockers, it seems that this is not a side remark but the goal. Maybe:
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it possible to use both types of tracking at the same time, or would that be an overkill? Is there a reason to use client tracking at all, if it can get blocked by ad-blockers, what advantages does it provide? Would be nice to have somewhere (not necessarily here) this info |
||||||||||||||
| - `recommendations_api_key` - an API key used to authenticate requests to the Recommendations API. This key allows the Connector to retrieve personalized recommendations from the Recommendation Engine. This value can be found as `API key` in Raptor Control Panel. | ||||||||||||||
|
Check notice on line 32 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
| - `recommendations_api_url` (optional) - overrides the default Raptor SaaS address, should be left unset unless a custom endpoint is required. | ||||||||||||||
|
Check notice on line 33 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Customer ID | ||||||||||||||
|
Check notice on line 35 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
|
||||||||||||||
| To find the value for the `customer_id` identifier, log in to Raptor Control Panel, and look for "Account number": | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would be best if this was part of the Raptor help center to which we could just link - this way it would stay up to date with potential UI changes, here we risk that we fail to track Raptor UI changes and update it in time. Let's discuss moving this part to the Help Center if possible - these sections are short, so it's not critical, but would be nice to keep the boundaries between the products. |
||||||||||||||
|
|
||||||||||||||
| A. In the top-left corner, above the account name, you can find the account number for the currently active account. | ||||||||||||||
| B. Click the arrow icon in the top-left corner to expand the window. There you can see a list of all your accounts, with their numbers shown in the “Account number” column on the right (if you have multiple accounts, you can easily locate and copy the number of any of your accounts, not just the active one). | ||||||||||||||
|
Check notice on line 40 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
|
||||||||||||||
|  | ||||||||||||||
|
|
||||||||||||||
| ## Recommendations API key | ||||||||||||||
|
Check notice on line 44 in docs/cdp/raptor_integration/connector_configuration.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here - to avoid the risk of this getting outdated, it should be part of the Help Center (official Raptor doc) |
||||||||||||||
|
|
||||||||||||||
| To find the value for the `recommendations_api_key`, log in to Raptor Control Panel, and look for "API key". | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As this is a new section, maybe have this precious link again:
Suggested change
|
||||||||||||||
| To do it, in the left panel, open the **Recommendations** section, and select **Website**. | ||||||||||||||
| Next, click on the Web module you’re interested in. | ||||||||||||||
| In the top-right corner, click the three-dot icon and select **API information**. | ||||||||||||||
| A new window appears, where you can find the "API key" value. | ||||||||||||||
| Click on the **Show API information** and copy the number. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
|  | ||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,30 @@ | ||||||||||||||
| --- | ||||||||||||||
| description: Step-by-step activation procedure of setting up SiteAccess-aware Raptor connector. | ||||||||||||||
| page_type: landing_page | ||||||||||||||
|
Comment on lines
+2
to
+3
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| # SiteAccess-aware Raptor connector | ||||||||||||||
|
Check notice on line 6 in docs/cdp/raptor_integration/raptor_connector.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
The fact that it's siteaccess-aware is not header-worthy, it's expected - and can be mentioned later. |
||||||||||||||
|
|
||||||||||||||
| The SiteAccess-aware [Raptor](https://www.raptorservices.com/) connector provides a seamless integration between [[= product_name =]] and Raptor Recommendation Engine. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It should be clearer that this an LTS Update. Maybe there:
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| Its primary goal is to enable editors and managers to deliver personalized experiences across digital channels, which helps to increase conversion rates, drive sales, and improve user engagement. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Raptor Connector can be confusing to people knowing that there is already a Raptor connection in Ibexa CDP. How does it work with
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| By combining content management capabilities with advanced recommendation features, the Connector allows teams to build and manage personalized experiences directly within a single platform. | ||||||||||||||
|
|
||||||||||||||
| This connector ensures a smooth and unified integration layer, enabling: | ||||||||||||||
|
|
||||||||||||||
| - event tracking through the tracking API | ||||||||||||||
| - personalized content delivery through the Recommendations API | ||||||||||||||
| - flexible, SiteAccess-aware configuration | ||||||||||||||
|
Check notice on line 18 in docs/cdp/raptor_integration/raptor_connector.md
|
||||||||||||||
|
|
||||||||||||||
| This approach reduces integration complexity while providing a scalable foundation for personalization use cases across multiple sites and markets. | ||||||||||||||
|
|
||||||||||||||
| Follow a step-by-step procedure that allows you to activate SiteAccess-aware Raptor connector. | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And/Or there?
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| Activation includes configuration, adding tracking scripts and events, and using [Page Builder](page_builder_guide.md) blocks. | ||||||||||||||
|
Check notice on line 23 in docs/cdp/raptor_integration/raptor_connector.md
|
||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
This sentence feels out of place right now - and a link to the install/configuration doc should be added later. |
||||||||||||||
|
|
||||||||||||||
| [[= cards([ | ||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd also add relevant Help Center links here, if you find good ones |
||||||||||||||
| "cdp/raptor_integration/connector_configuration", | ||||||||||||||
| "cdp/raptor_integration/tracking_script", | ||||||||||||||
| "cdp/raptor_integration/pb_blocks", | ||||||||||||||
| "cdp/raptor_integration/tracking_event_function" | ||||||||||||||
| ], columns=2) =]] | ||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,7 +47,8 @@ | |
| <li class="{{ class }}"> | ||
| <a href="{{ nav_item.url | url }}" class="md-nav__link level-{{ level }}"> | ||
| {{ nav_item.title }} | ||
| {% if nav_item.meta.month_change %}<span class="pill pill--new">New</span>{% endif %} | ||
| {% set nav_item_meta = nav_item | attr("meta") %} | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What's the reasoning behind this change? |
||
| {% if nav_item_meta is defined and nav_item_meta and nav_item_meta.get("month_change") %}<span class="pill pill--new">New</span>{% endif %} | ||
| </a> | ||
| </li> | ||
| {% endif %} | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This screenshot shows the Customer ID - is that the same at the Account number, could someone take both of these information from this single screen? That would simplify the setup a bit