Update

Updates of Visual CMS as well as Media Library and WYSIWYG Editor are done automatically with every OXID eShop update via Composer.

Update to Visual CMS 9

Warning

Do a full database and filesystem backup before running the migration process. This allows for immediate reversal of the migration steps if you encounter unexpected issues.

The following extensions are pre-installed in OXID eShop 7.4:

Visual CMS 9
Media Library 4
WYSIWYG Editor 6

To use their full feature set, you must follow a few extra steps after updating your OXID eShop:

Convert media URLs to IDs for WYSIWYG contents: Media IDs in WYSIWYG.
Migrate Visual CMS contents to the new code base: Changed Code Base.
Convert media URLs to IDs for Visual CMS widgets: Media IDs in Visual CMS.

Changed Code Base

With Visual CMS 9, introduced in OXID eShop 7.4, the code base of Visual CMS content was changed from parse to tree style structure. This improves storage structure of content and provides a better and more stable code base for future updates.

CMS contents containing the veparse string are not working anymore in shop’s frontend and might occur to cause errors. Therefore it is mandatory to migrate these contents from parse to tree style structure. This is done easily by running the following command using OE Console:

./vendor/bin/oe-console ddoevisualcms:migrate:veparse-to-vetree

The command converts all contents using veparse to new vetree structure. Afterwards, they can be modified as usual using the Visual CMS editor.

CMS contents consisting of plain HTML only must not be migrated to any new structure. Although, the option Disable widgets and use only text is active after the update. This ensures the contents are still working as intended. If you want to modify the contents later, using some widgets, you can deactivate option Disable widgets and use only text and edit them as usual. After saving, the contents are stored in new tree style structure.

Warning

Switching to the widget editor will open an empty workspace. Your previous text-only content will be overwritten as soon as you save. Be sure to copy any text you wish to keep before switching the modes.

Introduction of Media IDs

With Media Library 4, introduced in OXID eShop 7.4, we changed simple filepaths to media IDs in WYSIWYG Editor and Visual CMS. This ensures to find the media file even after changing its name or path. While the path definition still works after the update, we suggest to convert available contents to represent the new ID definition to benefit from its advantages.

Media IDs in WYSIWYG Editor

The WYSIWYG editor is used for several content pieces in the OXID eShop. You can update existing contents from media URLs to IDs by running the following commands using OE Console:

Hint

Remember to convert all fields for all languages, e.g. OXCONTENT, OXCONTENT_1, OXCONTENT_2 etc. like described in the first example.

General contents like CMS pages:

./vendor/bin/oe-console ddoewysiwyg:migrate:urls-to-ids oxcontents OXCONTENT
./vendor/bin/oe-console ddoewysiwyg:migrate:urls-to-ids oxcontents OXCONTENT_1
./vendor/bin/oe-console ddoewysiwyg:migrate:urls-to-ids oxcontents OXCONTENT_2
(...)

Product descriptions:

./vendor/bin/oe-console ddoewysiwyg:migrate:urls-to-ids oxartextends OXLONGDESC

Category descriptions:

./vendor/bin/oe-console ddoewysiwyg:migrate:urls-to-ids oxcategories OXDESC

Payment descriptions:

./vendor/bin/oe-console ddoewysiwyg:migrate:urls-to-ids oxpayments OXDESC

You can migrate other WYSIWYG contents, like custom database fields, with the command by passing the correct values for:

The database table containing the data to convert.
The specific field name inside the selected database table.
The table’s unique ID key (primary key). The default value is OXID.

./vendor/bin/oe-console ddoewysiwyg:migrate:urls-to-ids <table-name> <field-name> <table-id-key>

Media IDs in Visual CMS

The Visual CMS includes widgets dealing with media, like the image widget or the gallery. You can easily convert the media paths in these widgets by running the following command using OE Console:

./vendor/bin/oe-console ddoevisualcms:migrate:urls-to-ids