Content Context - boxalino/rtux-integration-magento2 GitHub Wiki

In the Boxalino ecosystem, content refers to any other data type (voucher, blogs, campaigns, banners, etc) which is integrated with the help of the narrative API.

Review the documentation for content integration

The content of the response depends 100% on your design and layout blocks desired.

Before you start, the layout blocks & narrative layout must be defined in Boxalino Intelligence admin.

The Layout Blocks JSON & Narratives JSON from this page can be used as base.

If there is no narrative assigned to the choice/widget requested, the response will be empty.

Requirements

The declared Layout Blocks uses rtux-magento2 elements available in tag 2.0.0 and newer.

Review the composer.json for more details on dependencies.

Integration description

In the Layout Blocks JSON & Narrative Layout JSON sample provided , a "read" widget (a list of blogs) will be added to the page (user account).

The provided JSON samples for the Narrative layout and the Layout blocks must be imported in Boxalino Intelligence Admin

Steps

1. Identify the Layout Requirements

This is based 100% on your assigned feature integration task specifications. Identify the required layout, recognize the needed Layout Blocks segments, templates and data.

If you are uncertain on how to start, read the Layout Integration Guide on Confluence

For this sample, the Layout blocks and Layout is a mix of 2 elements: working with a generic collection item (bx-hit) and working with the block API element to access properties.

2. Prepare the templates for the designed layout blocks.

For the blog list sample, there are 2 different lists displayed in 2 different ways (via collection or via API block response). The following templates are used:

the title (h3)
a loop/list to render child blocks
an item view which will show how to access properties from the bx-hit API element
a block-item view in which the properties are accessed directly from the Layout Block (block) API response, based on the declared JSON schema.

The templates must be updated when switching to a real-case integration, in order to reflect the data part of your API response (returnFields property of the API Request)

3. Implement the Boxalino RTUX API ContextInterface

This is a generic step for any feature integration

As it is the most basic integration (ex: when extending from the provided base ContextAbstract ) - only 3 functions are left to be implemented in order to set:

the products visibility (if needed)
the products category (as filter - depends on the context)
the return fields (which can be set via layout XML as well)

The filters list should include the filters for your OWN content logic by rewriting the addFilters(RequestInterface $request) function.

The returnFields must be set based on the required content for your display.

4. Create the Magento2 block

The Magento2 block can be generic and can be re-usable. Make sure to set the groupBy of the relevant field for your data context. The API request is done on protected function _prepareLayout().

5. Use the block in a layout XML or for widget definitions, etc

When using the block, make sure to set the widget, hitCount, groupBy and the return fields (if desired). These properties are required on the ContextInterface object (step #2).

For this use-case it has been used the generic template from RTUX Magento2 which will render the content of the JSON API response in a loop.

Layout Blocks JSON

[{"id":1981,"uniqueKey":"rtux_content_item","parametersJsonScheme":"","format":null,"widgets":[],"parameters":[{"name":"content-resource","values":["c-r=t"]},{"name":"bx-hit","values":["accessor"]},{"name":"name","values":["rtux_content_item"]},{"name":"template","values":["BoxalinoClientProject_BoxalinoIntegration::api/element/content/item.phtml"]},{"name":"type","values":["Boxalino\\RealTimeUserExperience\\Block\\Api\\Item"]}],"subRenderings":[],"route":"visual-elements","reqParams":null,"$fromServer":true,"parentResource":null,"restangularCollection":false,"isSelected":true},{"id":1982,"uniqueKey":"rtux_content_list","parametersJsonScheme":"{\n \"title\": \"Content List(blog, product, etc)\",\n \"type\": \"object\",\n \"properties\": {\n \"content\": {\n \"type\": \"string\",\n \"description\": \"Content type\"\n },\n \"accessor\": {\n \"type\": \"string\",\n \"description\": \"accessor (for connection to other widgets)\"\n }\n }\n}","format":null,"widgets":[],"parameters":[{"name":"bx-hits","values":["accessor"]},{"name":"name","values":["rtux_content_list"]},{"name":"template","values":["BoxalinoClientProject_BoxalinoIntegration::api/element/content/list.phtml"]},{"name":"type","values":["Boxalino\\RealTimeUserExperience\\Block\\Api\\ListApi"]}],"subRenderings":[],"route":"visual-elements","reqParams":null,"$fromServer":true,"parentResource":null,"restangularCollection":false,"isSelected":true},{"id":1986,"uniqueKey":"rtux_content_block","parametersJsonScheme":"{\n \"title\": \"Content (blog, product, etc)\",\n \"type\": \"object\",\n \"properties\": {\n \"link\": {\n \"type\": \"object\",\n \"title\": \"Content URL\",\n \"properties\": {\n \"de\": {\n \"type\": \"string\",\n \"description\": \"Set Content View URL in German.\"\n },\n \"fr\": {\n \"type\": \"string\",\n \"description\": \"Set Content View URL in French.\"\n },\n \"it\": {\n \"type\": \"string\",\n \"description\": \"Set Content View URL in Italian.\"\n },\n \"en\": {\n \"type\": \"string\",\n \"description\": \"Set Content View URL in English.\"\n }\n }\n },\n \"image\": {\n \"type\": \"object\",\n \"title\": \"Image\",\n \"properties\": {\n \"de\": {\n \"type\": \"string\",\n \"description\": \"Set Image Source in German.\"\n },\n \"fr\": {\n \"type\": \"string\",\n \"description\": \"Set Image Source in French.\"\n },\n \"it\": {\n \"type\": \"string\",\n \"description\": \"Set Image Source in Italian.\"\n },\n \"en\": {\n \"type\": \"string\",\n \"description\": \"Set Image Source in English.\"\n }\n }\n },\n \"title\": {\n \"type\": \"object\",\n \"title\": \"Name\",\n \"properties\": {\n \"de\": {\n \"type\": \"string\",\n \"description\": \"Set Content title in German.\"\n },\n \"fr\": {\n \"type\": \"string\",\n \"description\": \"Set Content title in French.\"\n },\n \"it\": {\n \"type\": \"string\",\n \"description\": \"Set Content title in Italian.\"\n },\n \"en\": {\n \"type\": \"string\",\n \"description\": \"Set Content title in English.\"\n }\n }\n },\n \"description\": {\n \"type\": \"object\",\n \"title\": \"Content Description\",\n \"properties\": {\n \"de\": {\n \"type\": \"string\",\n \"description\": \"Set Content details in German.\"\n },\n \"fr\": {\n \"type\": \"string\",\n \"description\": \"Set Content details in French.\"\n },\n \"it\": {\n \"type\": \"string\",\n \"description\": \"Set Content details in Italian.\"\n },\n \"en\": {\n \"type\": \"string\",\n \"description\": \"Set Content details in English.\"\n }\n }\n }\n }\n}","format":null,"widgets":[],"parameters":[{"name":"content-resource","values":["c-r=t"]},{"name":"bx-hit","values":["accessor"]},{"name":"name","values":["rtux_content_item"]},{"name":"template","values":["BoxalinoClientProject_BoxalinoIntegration::api/element/content/block.phtml"]}],"subRenderings":[],"route":"visual-elements","reqParams":null,"$fromServer":true,"parentResource":null,"restangularCollection":false,"isSelected":true}]

Narrative Layout JSON