This documentation is for a version that has reached its End Of Life. Such versions are no longer supported and don't receive security updates. Consider updating to a newer version.
New in documentation¶
This page contains recent highlights and notable changes in Ibexa DXP documentation.
April 2025¶
Content management¶
- Introduced a custom DAM connector example
- Added grace period definition and configuration
AI Actions¶
- Documented how to couple AI Actions and Ibexa Connect to build complex data transformation workflows without having to rely on custom code
REST API¶
Infrastructure and maintenance¶
- Announced v4.6.19 release notes and v4.6.19 upgrade instructions with an important security notice about RichText XML, and introducing Ibexa Rector to help to maintain custom code
March 2025¶
Release notes¶
- Redesigned Release notes page now includes filters to easily sort by product edition or LTS update type, while the updated documentation homepage provides quick access to essential details, showcasing changes introduced in the latest patch and LTS Updates releases
Requirements update¶
- Updated requirements for Ibexa DXP: RHEL 9.5 and CentOS Stream 9 are now supported for v4.6
AI Actions¶
- Specified minimum Ibexa DXP version supported while working with AI Actions
- AI Actions product guide: Availability
- AI Actions section: Install AI Actions
Online Editor¶
- Added an example in the Online Editor documentation showing how to add characters and shortcuts for specific characters to the SpecialCharacters plugin in CKEditor configuration
Templating¶
- Updated a description of the
ibexa_renderTwig function to mention its support for objects implementing theContentAwareInterfaceas argument
February 2025¶
Security¶
- Expanded security recommendations to follow when working with images submitted by users
Date and time attributes¶
- Added documentation for the latest LTS Update: Date and time attributes
Automated Translation¶
- Added information about how you can install and extend the Automated Translation feature
Interactive demos¶
- Updated Form Builder, Page Builder, and Online Editor product guides by addng interactive demos that present these features
Page Builder clipboard¶
- Described how you can use the Page Builder's clipboard to copy blocks between pages
REST API¶
- Described endpoints for Segment and Segment Group management
- Described endpoints for AI Action Configurations and AI Action Types
- Improved the example for creating Orders, to show how to pass shipping cost data
HTTP Cache¶
- Improved the VCL snippet to cache the first ESI request when using Basic Auth with Fastly
Search¶
- Expanded the lists of search criteria and sort clauses to show their support for searching in Trash
Templating¶
- Added the icon reference that lists all the icons you can use when extending the back office
- Updated descriptions of the following Twig functions to mention their support for objects implementing the
ContentAwareInterfaceas arguments: - Described new Twig filter for product attributes grouping:
ibexa_product_catalog_group_attributes
DDEV¶
- Described how you can use the Ibexa Cloud addons when working with Ibexa Cloud projects
Ibexa Cloud¶
- Described how to set up Composer authentication when creating an Ibexa Cloud project
PHP API¶
Enhanced the PHP API with the following new classes and interfaces:
Ibexa\Contracts\Cart:Ibexa\Contracts\Segmentation:Ibexa\Contracts\ProductCatalog:Ibexa\Contracts\Connect:ConnectClientInterfaceException\BadResponseExceptionException\UnserializablePayloadException\UnserializableResponsePaginationInterfaceResource\DataStructure\DataStructureBuilderResource\DataStructure\DataStructureCreateStructResource\DataStructure\DataStructureFilterResource\DataStructure\DataStructurePropertyResource\DataStructure\DataStructurePropertyTypeResource\DataStructureInterfaceResource\Hook\HookCreateStructResource\Hook\HookFilterResource\Hook\HookSetDetailsStructResource\HookInterfaceResource\Scenario\ScenarioCreateStructResource\Scenario\ScenarioFilterResource\ScenarioInterfaceResource\Team\TeamVariableCreateStructResource\Team\TeamVariableFilterResource\Team\TeamVariableUpdateStructResource\TeamInterfaceResource\Template\TemplateCreateStructResource\Template\TemplateFilterResource\TemplateInterfaceResponse\DataStructure\CreateResponseResponse\DataStructure\ListResponseResponse\DataStructure\RetrieveResponseResponse\Hook\CreateResponseResponse\Hook\ListResponseResponse\Hook\RetrieveResponseResponse\Hook\SetDetailsResponseResponse\Scenario\CreateResponseResponse\Scenario\ListResponseResponse\Scenario\RetrieveResponseResponse\Team\TeamVariableCreateResponseResponse\Team\TeamVariableListResponseResponse\Team\TeamVariableRetrieveResponseResponse\Team\TeamVariableUpdateResponseResponse\Template\BlueprintResponseResponse\Template\CreateResponseResponse\Template\ListResponseResponse\Template\RetrieveResponseResponseInterfaceTransportInterfaceValue\Blueprint\FlowValue\Blueprint\Metadata\ScenarioValue\Blueprint\MetadataValue\Blueprint\Module\CustomWebhookValue\Blueprint\Module\JsonCreateValue\Blueprint\Module\ModuleDesignerValue\Blueprint\Module\WebhookRespondValue\BlueprintValue\ControllerValue\Scheduling
January 2025¶
Trainings¶
- The Content Editor Training has been released. Learn more in the annoucement blogpost
Infrastructure and maintenance¶
- The upgrade instructions from v3.3 to v4.6 have been expanded with a section describing the GraphQL changes in v4
- Ubuntu 24.04 has been added to the list of officialy supported operating systems
PHP API¶
- Added the following interfaces and classes to the public PHP API:
December 2024¶
Infrastructure and maintenance¶
AI Actions¶
- Added extending AI Actions documentation
Security¶
- Expanded the Security checklist with advice on TLS, HSTS, DNSSEC, CAA, and domain update protection
PHP API¶
- Added the following interfaces to the public PHP API:
November 2024¶
Infrastructure and maintenance¶
- Added v4.6.13 to v4.6.14 update instructions which include security fixes
- Added v3.3.40 to v3.3.41 update instructions which include security fixes
Content management¶
- Added AI Actions documentation
Search¶
Documentation¶
- When you search using the top bar, if there are more than the 10 listed results, you can see a link to a page with further results at the bottom of the drop-down suggestion list
PHP API¶
- Added the following namespaces, interfaces, and classes to the public PHP API:
Ibexa\Contracts\Core\Validationnamespace and its descendantsIbexa\Contracts\Notifications\SystemNotificationnamespace and its descendantsIbexa\Contracts\Notifications\Value\Recipent\UserRecipientInterfaceIbexa\Contracts\ProductCatalog\Values\Product\Query\Criterion\UpdatedAtIbexa\Contracts\ProductCatalog\Values\Product\Query\Criterion\UpdatedAtRangeIbexa\Contracts\ProductCatalog\ProductReferencesResolverStrategy
October 2024¶
Content management¶
- Added a caution at the end of the Create custom Page block article
- Added
add_block_to_available_blocksto a list of available data migration actions
Infrastructure and maintenance¶
- Updated the reverse proxy configuration instructions by mentioning Basic Auth setup for Varnish
- Reorganized the Updating Ibexa DXP section to put information in logical order and remove duplicates
- Added v4.6.11 to v4.6.12 update instructions
- Added v4.6.12 to v4.6.13 update instructions mentioning a command to clean up duplicated entries in the
ezcontentobject_attributetable - Changed the Update to v3.3 instructions to help avoid an error at
composer updatestage - Changed the instructions by adding a requirement to handle the Ibexa Cloud configuration:
- Added a suggestion to remove obsolete database tables that were used by a legacy Commerce package
Personalization¶
- Added dynamic attribute submodels information by:
- mentioning them in customizing the recommendation request instructions
- describing them in user documentation
-
Added time-slot based models information by:
- changing the list of parameters available when customizing the recommendation request
- describing them in user documentation
-
Updated configuration details (including endpoint addresses and code examples) in multiple how-to articles:
PIM¶
- Updated the Product API article by fixing method signatures and adding links to the PHP API reference
PHP API¶
- Added the following new classes to the public PHP API:
REST API¶
- Updated the REST API authentication instructions
September 2024¶
Getting started¶
- Updated product version requirements and database connection configuration instructions in Install Ibexa DXP with DDEV
Infrastructure and maintenance¶
- Modified v4.5.x to v4.6 update instructions by adding Update Solr configuration section
- Added v4.6.8 to v4.6.11 update instructions
PHP API¶
- Added edition information to PHP API reference to aid navigation
REST API¶
- Removed multiple obsolete RAML types from the REST API reference
User management¶
- Updated the OAuth server installation instructions
August 2024¶
Product guides¶
- Ibexa Experience product guide
- Ibexa Commerce product guide
- Added page collecting all feature product guides
Content management¶
- Added how to hide a taxonomy menu item
Data migration¶
- Added a note about multi-repository and dynamic migration folders
July 2024¶
Getting started¶
- Added instructions in Install Ibexa DXP about using PHP 8.3 to create a project
- Updated the requirements for running v3.3.x on PHP 8.3
Infrastructure and maintenance¶
- Added v4.6.4 to v4.6.8 update instructions
- Modified v3.3.x to v3.3.latest update instructions
- Updated the recommendations in Performance by mentioning Symfony
Data migration¶
- Added a note about multi-repository scenario in Managing migration
- Updated the instructions for Importing data by mentioning the
envfunction and a possibility of swapping content items assigned to a location
Ibexa Cloud¶
- Placed all articles about Ibexa Cloud in a common location
Ibexa Engage¶
Product guides¶
June 2024¶
Ibexa Engage¶
Search¶
Dashboard¶
Infrastructure and maintenance¶
Documentation¶
- A "new" pill now appears in the table of content alongside pages which have been recently created, or have recent important updates or additions
May 2024¶
PHP API¶
Users¶
April 2024¶
Product guides¶
Infrastructure and maintenance¶
Users¶
- Recent activity
- OAuth server
- Updated OAuth client
Back office¶
Templating¶
- Site context Twig function
ibexa_site_context_aware - Storefront Twig function
ibexa_get_anonymous_user_id
March 2024¶
Permissions¶
- Updated Custom policies article
Content management¶
- Updated BinaryFile field type description
Commerce¶
- Description of integration with Payum and payment processing gateways
Search¶
- Updated Elasticsearch search engine description
- New Search Criteria:
February 2024¶
Dashboard¶
- New dashboard sections in User Documentation:
- Dashboard section in Developer Documentation:
DAM¶
PIM¶
REST API¶
Others¶
- Updated Create custom view matcher article
- Actito transactional email integration
- Described user profile
January 2024¶
Administration¶
Content management¶
- New sections in taxonomy documentation:
- Updated information in User Documentation:
DAM¶
Getting started¶
- Ibexa Headless product guide
- Enhanced get started article in User Documentation
Image management¶
Personalization¶
PIM¶
- Product search Aggregations:
December 2023¶
Content management¶
- Segmentation events
- Checkbox page block attribute type
- Updated Create Form Builder Form attribute procedure
PIM¶
Templating¶
- Taxonomy view matchers
- Get content category Twig filter
- Updated arguments list for
ibexa_render()method - New Field information Twig functions
- Updated get user Twig functions
User management¶
November 2023¶
Commerce¶
CDP¶
Product guides¶
Infrastructure and maintenance¶
Others¶
- Redesigned requirements page
- Updated Ibexa Cloud CLI
- Updated React app block procedure
- Added fulltext features in search
October 2023¶
Commerce¶
Personalization¶
PIM¶
Product guides¶
Migration¶
September 2023¶
Commerce¶
- Cart
- Checkout
- Order management
Personalization¶
- Updated configuration for triggers
- Send messages with recommendations
- Email triggers in User Documentation
PIM¶
REST API¶
- Added GET endpoint for all available Sales Representatives Users
Storefront¶
Templating¶
Others¶
-
Product guides integrated into Developer Documentation
August 2023¶
New home page¶
- Redesigned home page for User Documentation
Administration¶
Commerce¶
- Importing data
- Cart
- Checkout
- Payments
- Shipping
Online Editor¶
PIM¶
Security¶
July 2023¶
v4.5.1¶
New home page¶
- Redesigned home page for Developer Documentation
Getting started¶
- New cautions in Install on Ibexa Cloud about using
cloud.ibexa.coinstead ofplatform.sh
Content management¶
- New Page block Ibexa Connect scenario block
- Updated Create custom Page blocks
Customer Portal¶
- Updated Creating a Customer Portal
Personalization¶
- Multiple attributes in submodel computation
- Multiple attributes in submodel computation in User Documentation
PIM¶
- Updated Enable purchasing products
- Virtual products
- Virtual products in User Documentation
- Work with product attributes in User Documentation
REST API¶
- Added example of input payload in JSON format for ContentTypeCreate in REST API reference
- Expected user header support
Commerce¶
- Virtual products in checkout
- New Order and Shipment Search Criteria:
Search¶
- REST API examples in multiple existing Search Criteria descriptions
- New REST API-only Search Criteria:
Infrastructure and maintenance¶
- Configure and customize Fastly
- Updated Security checklist:
June 2023¶
Personalization¶
- Email triggers
- Email triggers in User Documentation
Search¶
Commerce¶
- Shipping methods management in User Documentation
- Payment methods management in User Documentation
- Stock Search Criteria and Aggregation:
May 2023¶
v4.5¶
- v4.5 release notes and guide on how to update to v4.5
Customer Portal¶
Commerce¶
- Extending payments
- Reference for commerce-related events:
April 2023¶
Payment¶
- Payment management, including configuring payment workflow, payment, and payment method PHP API
Orders¶
- Order management, including configuring order workflow and Orders REST API reference
Shipping¶
- Shipping management, including configuring shipment workflow, shipment, and shipping method PHP API
Search¶
- Search Criteria and Sort Clauses covering the new commerce features:
- Order Search Criteria and Sort Clauses
- Payment Search Criteria and Sort Clauses
- Payment method Search Criteria and Sort Clauses
- Shipment Search Criteria and Sort Clauses
New Page blocks¶
Others¶
March 2023¶
- Order management API
- Customizing checkout
- Extended table reusable component documentation
- How to add GraphQL support to custom field types
- How to customize field type metadata
February 2023¶
Storefront¶
- Storefront documentation, including how to configure and extend Storefront.
Cart¶
Checkout¶
- Checkout documentation, including how to configure checkout, description of main PHP API methods, and checkout-related Twig functions
Other¶
January 2023¶
Page Builder¶
- Description of new Page Builder blocks: Catalog and Product collection