| description | Overview of major recent additions to Ibexa DXP documentation. |
|---|---|
| month_change | true |
This page contains recent highlights and notable changes in [[= product_name =]] documentation.
- Distinguish physical and virtual products in product catalog guide
- Added creating product type example in product API
- Detailed how to add a custom attribute type to an existing storage definition
- Documented how to extend collaboration with a shared cart example
- Introduced embeddings search API for taxonomy
- Illustrated image optimizer customization
- Illustrated how to export additional user data
- Detailed Ibexa Messenger support for large batches of data
- Introduced the CDP Monolog channel
- Added
Ibexa\Contracts\CdpPHP API reference
To update from v5.0.x to v5.0.latest, you have to ensure that Yarn dependencies are up-to-date before running Composer.
- Added documentation describing how to use the new
ibexa/cloudpackage and the environment variables it provides
- Updated DFS and Solr configuration examples to use environment variables directly with [Environment Variable Processors]([[= symfony_doc =]]/configuration/env_var_processors.html) syntax instead of intermediate parameters. This promotes skipping the rebuild of the Symfony container when environment variable values change.
- Added a description of password constraints in Install Ibexa DXP and Install with DDEV
- Updated icon function and icon set usage instructions in Custom icons
- Added Ibexa Messenger instructions for [[= product_name =]] 4.6
- Modified discounts configuration
- Added installation instructions
- Site Factory
- Fixed an issue with design configuration
- Added support for Elasticsearch 8.19+:
- Updated the requirements
- Updated the Elasticsearch overview
- Modified the configuration instructions
- Modified the installation instructions
- Modified the system update instructions
- Added reverse proxy installation instructions to DDEV cluster description
- Modified the system update instructions to account for numerous changes in the product
- Detailed the Varnish reverse proxy configuration instructions by mentioning specific VCL files that must be used
- Extending Discounts
- Added documentation about how to create custom conditions and rules and change discount priority
- Added documentation about how to extend Discounts wizard
- Example how to deal with discounts products using the API added in the Discounts API page
- Updated requirements for [[= product_name =]] 4.6 and 5.0: PostgreSQL 18 is now officially supported
- Naming update in the documentation: renamed Platform.sh to Upsun
- Described Taxonomy suggestions
- Improved Collaborative editing:
- Added real-time editing configuration
- Added Collaborative editing policies for content items and products
- Added Collaborative editing limitations
- Expended search API to content types:
- Added documentation for Integrated help (v5 and v4.6):
- Added Anthropic connector installation (v5 only)
-
Enhanced the PHP API reference with the following new classes for [[= product_name =]] 4.6 and 5.0:
Ibexa\Contracts\Elasticsearch\Query\EmbeddingVisitorIbexa\Contracts\AdminUi\ContentType\ContentTypeFieldsByExpressionServiceInterfaceIbexa\Contracts\Collaboration\Invitation\Query\Criterion\ParticipantScopeIbexa\Contracts\Collaboration\Invitation\Query\Criterion\ParticipantTypeIbexa\Contracts\Collaboration\Participant\ParticipantDiscriminatorIbexa\Contracts\ConnectorAi\Action\DataType\TaxonomyIbexa\Contracts\ConnectorAi\Action\DataType\TaxonomyEntryIbexa\Contracts\ConnectorAi\Action\DataType\TaxonomySuggestionIbexa\Contracts\ConnectorAi\Action\DataType\TaxonomySuggestionInterfaceIbexa\Contracts\ConnectorAi\Action\DataType\TextToTaxonomyInputIbexa\Contracts\ConnectorAi\Action\Response\TaxonomyResponseIbexa\Contracts\ConnectorAi\Action\SuggestTaxonomyActionIbexa\Contracts\ConnectorAi\Action\TextToTaxonomyIbexa\Contracts\Core\Repository\Values\Content\EmbeddingQueryIbexa\Contracts\Core\Repository\Values\Content\EmbeddingQueryBuilderIbexa\Contracts\Core\Repository\Values\ContentType\Query\Criterion\ContentTypeGroupNameIbexa\Contracts\Core\Repository\Values\Content\Query\EmbeddingIbexa\Contracts\Core\Repository\Values\Content\QueryValidatorInterfaceIbexa\Contracts\Core\Search\EmbeddingIbexa\Contracts\Core\Search\FieldType\EmbeddingFieldIbexa\Contracts\Core\Search\FieldType\EmbeddingFieldFactoryIbexa\Contracts\FieldTypeRichTextRTEIbexa\Contracts\Share\MapperIbexa\Contracts\Solr\Query\EmbeddingVisitorIbexa\Contracts\Taxonomy\EmbeddingIbexa\Contracts\Taxonomy\Search\Query\Value\TaxonomyEmbeddingIbexa\Contracts\User\PasswordReset\NotifierInterface
In addition, few only for 5.0 version:
We want to thank
- romank for fixing a parse error in Customize registration forms example
- todomagichere for correcting
ibexa_path()description in URL Twig functions
- Described:
- installation and configuration in more detail
- search criteria and sort clauses for Collaborative editing
- events
- Expanded the custom block for Page Builder and custom field for Form Builder examples to showcase providing translations
- Added documentation for CustomField criterion
- Added a note about disabling community contributions for French, German and Spanish translations, in preparation for the upcoming release
- The Advanced Developer training for [[= product_name =]] v5 is now available
- Improved the landing page for AI Actions for easier navigation
- Improved the experience when switching between different versions of the documentation site
- Added documentation for handling background tasks using the new integration with Symfony Messenger
- Described the configuration required to asynchronously reindex discounted product prices and the new discount events and search criteria
- Updated the notifications page after recent improvements to notifications, including the new notification criteria
- Updated the custom block example, highlighting usage of
udw_config_nameoption to customize the Universal Discovery Module
- Illustrated how to send a location to trash using data migrations
- Added documentation for the
IsContainercriterion
- Added the Collaborative editing product guide, describing the high-level overview of this feature
- Described collaborative editing endpoints to the REST API reference for [[= product_name =]] v4.6
- Marked Redis 7.2 as supported in the requirements for Ibexa DXP 4.6
-
Enhanced the PHP API reference with the following new classes for [[= product_name =]] 4.6 and 5.0:
Ibexa\Contracts\AdminUi\Event\ResolveVersionPreviewUrlEventIbexa\Contracts\AdminUi\Exception\UnresolvedPreviewUrlExceptionIbexa\Contracts\AdminUi\PreviewUrlResolver\VersionPreviewUrlResolverInterfaceIbexa\Contracts\Core\Validation\Constraint\UniqueIdentifierIbexa\Contracts\Core\Validation\Constraint\UniqueIdentifierValidatorIbexa\Contracts\Discounts\Event\EnableDiscountEventIbexa\Contracts\Discounts\Event\BeforeDisableDiscountEventIbexa\Contracts\Discounts\Event\BeforeEnableDiscountEventIbexa\Contracts\Discounts\Event\DisableDiscountEventIbexa\Contracts\Discounts\Value\Query\Criterion\IndexedAtCriterionIbexa\Contracts\Discounts\Value\Query\Criterion\UpdatedAtCriterionIbexa\Contracts\Messenger\Transport\MessageProviderInterfaceIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilderRegistryIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilderRegistryInterfaceIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilder\AttributeCriterionBuilderInterfaceIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilder\CheckboxBuilderIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilder\ColorBuilderIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilder\FloatBuilderIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilder\IntegerBuilderIbexa\Contracts\ProductCatalog\Values\Product\Query\AttributeCriterionBuilder\SelectionBuilder
In addition, a new exception is available in the 5.0 version:
- Added instructions on how to generate PEM keypair for JWT authentication
- Updated a list of bundles available in the product
- A new version of Ibexa DXP Developer Training has been released, this time focusing on the v5.0.x.
- Enhanced the PHP API reference with the following new classes:
Ibexa\Contracts\ProductCatalogSymbolAttribute\Search\Criterion\SymbolAttributeIbexa\Contracts\ProductCatalogSymbolAttribute\Value\ChecksumInterfaceIbexa\Contracts\Cart\Exception\VatCalculationExceptionInterfaceIbexa\Contracts\Core\Repository\Values\Notification\CriterionHandlerInterfaceIbexa\Contracts\Core\Repository\Values\Notification\Query\CriterionInterfaceIbexa\Contracts\Core\Repository\Values\Notification\Query\Criterion\DateCreatedIbexa\Contracts\Core\Repository\Values\Notification\Query\NotificationQueryIbexa\Contracts\ProductCatalog\Values\Product\Query\Criterion\AbstractPriceRangeIbexa\Contracts\ProductCatalog\Values\Product\Query\Criterion\CustomPriceRange
Ibexa DXP v5.0.0 is now available, accompanied by v5.0 documentation. Ibexa DXP 5.0 LTS benefits of the Long-Term Support.
See how to update from 4.6 to 5.0.
LTS Updates from v4.6 are included out of the box in v5.0 as features. Installation instructions for v4.6 are not needed in v5.0, or replaced by configuration instructions.
Documentation examples and PHP API Reference have been updated for v5.0.
You can use ibexa/rector package that allows to maintain your custom PHP code quality.
Consult the Ibexa DXP v5.0 renames, deprecations and removals to learn more about the changes.
Major additions to the PHP API Reference are Ibexa\Contracts\Collaboration and Ibexa\Contracts\Share namespaces, the bulding blocks for the collaboration framework.
Layout for v5.0 REST API Reference is now changed.
As Ibexa DXP 5.0 is OpenAPI compliant, the specification output is used to generate the online reference.
You can also check the documentation directly on your development installations at /api/ibexa/v2/doc.
- Introduced new Discounts feature that allows online stores to temporarily or permanently reduce prices on specific products or categories.
Discounts documentation includes:
- Product guide
- Installation documentation
- Configuration documentation
- API usage
- New Search Sort Clauses and Search Criteria
- New events
- Rest API for Discounts and Discount Codes
- New Twig functions and Twig Components groups
- New policies and limitations
- Enhanced the PHP API reference with the following new classes:
- Documented new Twig Components feature that allows you to effortlessly build customizable and reusable Twig templates in [[= product_name =]]
- Added documentation about how to add new views or overwrite existing ones in the Sub-items list
- Enhanced the PHP API with the following new classes:
Ibexa\Contracts\AdminUi\Menu\AbstractActionBuilderIbexa\Contracts\TwigComponents\ComponentInterfaceIbexa\Contracts\TwigComponents\ComponentRegistryInterfaceIbexa\Contracts\TwigComponents\Event\RenderGroupEventIbexa\Contracts\TwigComponents\Event\RenderSingleEventIbexa\Contracts\TwigComponents\Exception\InvalidArgumentExceptionIbexa\Contracts\TwigComponents\Renderer\RendererInterface
- Updated requirements for [[= product_name =]] 4.6: MySQL 8.4, Node 20 and Node 22 are now officially supported
- Documented how to use the
ibexa:connect:init-custom-property-structurescommand to integrate AI actions with Ibexa Connect
We want to thank todomagichere and hgiesenow for their help in improving the Order management API and Reverse proxy documentation pages
- Introduced a custom DAM connector example
- Added grace period definition and configuration
- Documented how to couple AI Actions and Ibexa Connect to build complex data transformation workflows without having to rely on custom code
- 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
- 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 Update releases
- Updated requirements for [[= product_name =]]: RHEL 9.5 and CentOS Stream 9 are now supported for v4.6
- Specified minimum [[= product_name =]] version supported while working with AI Actions
- AI Actions product guide: Availability
- AI Actions section: Install AI Actions
- 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
- Updated a description of the
ibexa_renderTwig function to mention its support for objects implementing theContentAwareInterfaceas argument
- Expanded security recommendations to follow when working with images submitted by users
- Added documentation for the latest LTS Update: Date and time attributes
- Added information about how you can install and extend the Automated Translation feature
- Updated Form Builder, Page Builder, and Online Editor product guides by adding interactive demos that present these features
- Described how you can use the Page Builder's clipboard to copy blocks between pages
- 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
- Improved the VCL snippet to cache the first ESI request when using Basic Auth with Fastly
- Expanded the lists of search criteria and sort clauses to show their support for searching in Trash
- 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
- Described how you can use the Ibexa Cloud addons when working with [[= product_name_cloud =]] projects
- Described how to set up Composer authentication when creating an [[= product_name_cloud =]] project
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
- The Content Editor Training has been released. Learn more in the annoucement blogpost
- 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 officially supported operating systems
- Added the following interfaces and classes to the public PHP API:
- Added extending AI Actions documentation
- Expanded the Security checklist with advice on TLS, HSTS, DNSSEC, CAA, and domain update protection
- Added the following interfaces to the public PHP API:
- 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
- Added AI Actions 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
- 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
- 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
- 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 [[= product_name_cloud =]] configuration:
- Added a suggestion to remove obsolete database tables that were used by a legacy Commerce package
-
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:
- Updated the Product API article by fixing method signatures and adding links to the PHP API reference
- Added the following new classes to the public PHP API:
- Updated the REST API authentication instructions
- Updated product version requirements and database connection configuration instructions in Install Ibexa DXP with DDEV
- 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
- Added edition information to PHP API reference to aid navigation
- Removed multiple obsolete RAML types from the REST API reference
- Updated the OAuth server installation instructions
- [[= product_name_exp =]] product guide
- [[= product_name_com =]] product guide
- Added page collecting all feature product guides
- Added how to hide a taxonomy menu item
- Added a note about multi-repository and dynamic migration folders
- Added instructions in Install [[= product_name =]] about using PHP 8.3 to create a project
- Updated the requirements for running v3.3.x on PHP 8.3
- 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
- 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
- Placed all articles about [[= product_name_cloud =]] in a common location
- A "new" pill now appears in the table of content alongside pages which have been recently created, or have recent important updates or additions
- Recent activity
- OAuth server
- Updated OAuth client
- Site context Twig function
ibexa_site_context_aware - Storefront Twig function
ibexa_get_anonymous_user_id
- Updated Custom policies article
- Updated BinaryFile field type description
- Description of integration with Payum and payment processing gateways
- Updated Elasticsearch search engine description
- New Search Criteria:
- New dashboard sections in User Documentation:
- Dashboard section in Developer Documentation:
- Updated Create custom view matcher article
- Actito transactional email integration
- Described user profile
- New sections in taxonomy documentation:
- Updated information in User Documentation:
- [[= product_name_headless =]] product guide
- Enhanced get started article in User Documentation
- Product search Aggregations:
- Segmentation events
- Checkbox page block attribute type
- Updated Create Form Builder Form attribute procedure
- 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
- Redesigned requirements page
- Updated [[= product_name_cloud =]] CLI
- Updated React app block procedure
- Added fulltext features in search
- Cart
- Checkout
- Order management
- Updated configuration for triggers
- Send messages with recommendations
- Email triggers in User Documentation
- Added GET endpoint for all available Sales Representatives Users
-
Product guides integrated into Developer Documentation
- Redesigned home page for User Documentation
- Importing data
- Cart
- Checkout
- Payments
- Shipping
- Redesigned home page for Developer Documentation
- New cautions in Install on [[= product_name_cloud =]] about using
cloud.ibexa.coinstead ofplatform.sh
- New Page block [[= product_name_connect =]] scenario block
- Updated Create custom Page blocks
- Updated Creating a Customer Portal
- Multiple attributes in submodel computation
- Multiple attributes in submodel computation in User Documentation
- Updated Enable purchasing products
- Virtual products
- Virtual products in User Documentation
- Work with product attributes in User Documentation
- Added example of input payload in JSON format for ContentTypeCreate in REST API reference
- Expected user header support
- Virtual products in checkout
- New Order and Shipment Search Criteria:
- REST API examples in multiple existing Search Criteria descriptions
- New REST API-only Search Criteria:
- Configure and customize Fastly
- Updated Security checklist:
- Email triggers
- Email triggers in User Documentation
- Shipping methods management in User Documentation
- Payment methods management in User Documentation
- Stock Search Criteria and Aggregation:
- v4.5 release notes and guide on how to update to v4.5
- Extending payments
- Reference for commerce-related events:
- Payment management, including configuring payment workflow, payment, and payment method PHP API
- Order management, including configuring order workflow and Orders REST API reference
- Shipping management, including configuring shipment workflow, shipment, and shipping method PHP API
- 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
- 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
- Storefront documentation, including how to configure and extend Storefront.
- Checkout documentation, including how to configure checkout, description of main PHP API methods, and checkout-related Twig functions
- Description of new Page Builder blocks: Catalog and Product collection