OXID eShop EE 4.0.0.0 Manual Feed

Update eShop to UTF-8 encoding

Philipp Grashoff — Mon, 06 Apr 2009 10:13:54 +0200

Requirements

These instructions are for updating a Version equal or newer to 4.1.1 to UTF-8. Older eShop versions cannot be updated to UTF-8.

Update Files

1) Check if system Requirements for UTF-8 are met

Log in to eShop Admin
Select Service -> System Requirements
Check if mbstring and UTF-8 support are green:

The UTF-8 update will only work if
the requirements mentioned above are met (green square). Otherwise,
installing this update might break your eShop!

2) Make eShop temporarily offline

The eShop has to be offline for this update. The best way to do so is to replace the index.php file in the main directory of your eShop.

Backup your existing index.php file located in the main directory of your eShop.
Create a new index.php file with the following content:
<?php echo "The eShop is temporarily offline for maintenance. Please try again later";?>
Overwrite the index.php with the new one.

Try opening your eShop in your browser. The maintenance message should appear.

3) Backup Database

Make a complete backup of your database.

4) Change Database to UTF-8

Next, the database is updated to use UTF-8 encoding. All database commands are in the .sql file in the update package.

Before running the database commands, you have to edit the file: replace _NAME_OF_DB_ with the name of the database.

There are several ways to execute the file:

Many web hosts offer phpmyadmin for managing databases. In phpmyadmin, you can use the Import function.
If you have command line access to the database, you can run the update via command line.

The database commands cover the standard database of OXID eShop. If you made any changes to the database, you have to convert
these changes to UTF-8 manually.

5) Check language files

While working in UTF-8 mode non UTF-8 data stored in language files
must be prepared. For doing this, the charset of each language file has
to be defined. Check all language files in the following folders
(LANG_ABBR stands for language abbreviation, e.g. en, de, fr):

Admin language files: /out/admin/LANG_ABBR/

Frontend language files: /out/basic/LANG_ABBR/

Check each file if the charset is defined in its code, e.g.: 'charset' => 'ISO-8859-15',
If the charset is not defined, the language files are ignored. To
get them properly working, find out the character encoding with a text
editor and add the charset information to the language file after the
line $aLang = array(:
$aLang = array(
'charset' => 'CHARSET_NAME',

The following charsets are supported by PHP: ISO-8859-1,
ISO-8859-15, UTF-8, cp866, cp1251, cp1252, KOI8-R, BIG5, GB2312,
BIG5-HKSCS, Shift_JIS, EUC-JP

6) Check custom files

If you made any extensions to OXID eShop, these files should be
encoded as ISO-8859-15. Otherwise, special chars can lead to problems.
Only language files are allowed to have other encoding than ISO-8859-15.

Check all your custom files except language files if they are saved in ISO-8859-15.

7) Run update.php

Copy update.php from the UTF-8 update package to the main directory of your eShop.
Open the update script with your browser (http://www.youreshop.com/update.php).
In the first update step, the character set currently used is detected automatically. Click on Proceed to run the update.
After the update, the results are shown. Here you can see all
updated data. Please review the data if any chars are not as they
should be (especially currency setting, see public bugtracker). If necessary, change the data in admin after update is finished.

8) Update config.inc.php

Check if the entry $this->iUtfMode exists in the config.inc.php (located in the main directory of your eShop).
If yes: Adjust the config.inc.php file: set $this->iUtfMode to 1.
If no: Add the following line to the config.inc.php file: $this->iUtfMode = '1'; // 1 - enables UTF-8, 0 - disables UTF-8

9) Delete temporary files

Delete all files in /tmp.

10 ) Restore index.php

Copy the backup of index.php made in step 2) back to the main directory of your eShop.

Update is finished

The Update to UTF-8 character encoding is finished.

Display certain products or categories with a different template

Philipp Grashoff — Tue, 02 Jun 2009 17:55:26 +0200

Products

You can set for each product that the detail view of the product is rendered with a different template:

Go to Administer Products -> Products
Select the accordant product
Go to Extended tab
In Alt. Template, enter the name of the template to be used for rendering this product. Example: page/details/mydetails.tpl
Click Save

Thereby the referenced template is used for rendering the detail view.

You can use the template details.tpl as a draft for a custom template. This template is used by default for rendering the detail view.

Update OXID eShop to version 4.5.1

juergen.busch — Wed, 17 Aug 2011 16:39:33 +0200

This article describes the installation of the patch for OXID eShop version 4.5.1, which differs from the standard update in some details. If you wish to update to another version, please refer to the article Update from one release to another.

Preliminary Note

The image handling was improved in OXID eShop 4.5.1. There is a new way of displaying and generating the various images. Please refer to the tutorial "Image handling changes since 4.5.1" for details. The folder structure has been changed and is now clearer and self-explanatory. The 4.5.1 patch arranges the images in this new folder structure if you choose this option.

If a conversion to the improved image handling is not possible at the time of the update, you can use the OXPICHANDLER module. It ensures compatibility with the previous folder structure and the continued use of the old functions.

Note: The module is available on request from our Technical Support. It is only provided for OXID eShop 4.5.1. Maintenance beyond this is not planned. Therefore, please change to the folder structure as soon as possible.

It was necessary to change many templates in OXID eShop 4.5.1 so that, among other things, the front-end would be displayed correctly in Internet Explorer as well. Please refer to the template documentation for the theme applied in the eShop and for the templates in the administration area for the adjustments required.

Execute update in a test environment

We recommend that you execute the patch with a copy of your eShop before updating the actual online eShop. You could install this copy on your computer and run the patch in this test environment. If no problems occur there, repeat the patch for your actual online eShop.

1) Create backups

Backup all eShop files and the eShop database.

2) Copy files

Copy all files from copy_this to the main directory of your eShop. The main directory is the directory containing the config.inc.php file.

3) Run update

The update package contains a directory called updateApp. It contains a small application which updates the database. Please note that the update may take some time for larger databases.

Note: Ensure that you have the MySQL right to update database views. If necessary, contact your hosting provider.

Copy folder updateApp to the main directory of your eShop.

You can run the update application either by command line or using the browser:

By command line

Go to the updateApp directory and execute php run_cli.php.

By browser

Open http://www.youreshop.com/updateApp. Replace www.youreshop.com with the URL of your eShop.
Follow the on-screen instructions.

Answer the question whether your images should be relocated. Choose the option "Yes".
Wait while the processing and updating of the database takes place. The process is recorded in the right window of the update application.
The content of the updateApp directory will be deleted after a successful update. Please delete the directory itself as well.

4) Delete temporary files

Delete all files and folders from the tmp folder of the shop except for .htacces.

5) Copy further files and adjust templates

The templates of the "Azure" and "Basic" themes as well as templates of the administration area were changed in 4.5.1. A list of all changes can be found at templ_docu_azure/index.html, templ_docu_basic/index.html and templ_docu_admin/index.html in the installation pack.

If you have made no changes to the files listed there, copy the relevant content of the changed_full folder into the main directory of your eShop. If the templates and files were changed, the changes must also be applied to the files in the eShop. In this case it is necessary to decide for each file from the changed_full folder whether it can be copied directly or whether the existing file needs to be adjusted. Inherited templates from a custom theme may have to be adjusted as well.

Further changes were made to the language files and the invoice in modules/invoicepdf.

If you do not know whether the files in your eShop have been adjusted, follow these steps:

Download the testing program from OXID eXchange at http://www.oxid-esales.com/en/exchange/extensions/oxchkversion.
Copy the file oxchkversion.php into the main directory of your eShop.
Open http://www.youreshop.com/oxchkversion.php. Replace www.youreshop.com with the URL of your eShop.
The testing program tells you if and where the shop is not in its original state.
Do not delete the file until the test has been completed.

The patch has been completed

After you have executed all steps, the patch has been completed and your eShop has been updated to version 4.5.1.

Hint: There was an issue with language files during few installations. If so, please change the oxlang.php with the one provided here:
http://www.oxid-esales.com/forum/showthread.php?t=10762#post6484

Update from one release to another

Philipp Grashoff — Wed, 28 Jan 2009 16:03:51 +0100

These instructions are valid from eShop version 4.1.4. If you want to update older versions than 4.1.4, use the update instructions until version 4.1.4.

Testing update on your local computer

We recommend to test the update on a local installation of your eShop before updating your online eShop. Mirror your eShop to your computer and update this installation. If no problems occur, update your real eShop.

1) Create backups

Backup all eShop files and the eShop database.

2) Copy files

Copy all files from copy_this to the main directory of your eShop. The main directory is the directory containing the config.inc.php file.

3) Update database

The update package contains a directory called updateApp. It contains a small application which updates the database.

Copy the updateApp directory to the main directory of your eShop.

You can run the application either by command line or using the browser:

By command line

Go to the updateApp directory and execute php run_cli.php.

By Browser

Open http://www.youreshop.com/updateApp. Replace www.youreshop.com with the url of your eShop.
Follow the on-screen instructions.

Delete the updateApp directory when the database update is finished!

Large database updates may take some time. On large databases, the update can last several hours.

4) Empty tmp directory

Delete all files in the /tmp directory on your server.

5) Adjust templates

With each update, some templates are changed. You have to adopt these changes to your templates:

If you made no changes to the standard templates, you can simply copy the changed templates. The changed templates can be found in the changed_full directory. Copy the contents of this directory to the main directory of your eShop.
If you changed the standard templates, the changes have to be manually adopted. All changes are listed in templ_docu/index.html.

The update is finished

The eShop is updated to the newer version.

Product pictures: Basics

Roman Felger — Mon, 10 Nov 2008 15:39:29 +0100

You have the option of uploading multiple pictures for each product. The pictures must be copied from your computer to the server on which OXID eShop runs. This operation is referred to as uploading.

There are four different picture types:

Icons are the smallest pictures. You can upload one icon per product.
Thumbnails are also small pictures. You can upload one thumbnail per product.
Pictures are standard-sized pictures. You can upload seven pictures per product.
Zoomed Pictures are extra-large pictures. You can upload four zoomed pictures per product.

Where the various picture types are displayed

Icons

In the shopping cart.
If products are displayed in the right sidebar, e.g., in Top of the Shop and Bargain.

Thumbnails

In product lists. Examples of product lists are category views (all products in a category are listed) and search results.
In promotions that are displayed in the center of the home page, e.g., Long-running Hits and Just arrived!.

Pictures

In the detailed view of a product (an individual product is displayed).

Zoomed Pictures

The detailed view of a product will contain a link if zoomed pictures are available. This link can be used to open the zoomed pictures.

What next?

Instructions for uploading an icon, a thumbnail, and a picture are given in Uploading product pictures.

If product pictures are too large, they are reduced automatically to a defined size. This prevents interference with the eShop design caused by pictures that are too large. You can specify the maximum size of product pictures. This is primarily of interest if you want to adapt the design of the OXID eShop. To find out where you can modify the maximum sizes, refer to Adapting the size of product pictures.

Find more information also about technical details in OXID eShop developer's platform OXIDforge.

When which e-mails are sent

Roman Felger — Tue, 18 Nov 2008 17:03:03 +0100

The e-mails are managed in the CMS pages: The CMS pages can be found under Customer Info -> CMS pages.

If you want to edit e-mails, read Adapting the content of e-mails in advance. This gives you important information on editing e-mails.

Your Password in eShop (Ident: oxforgotpwd):
This e-mail is sent if users have sent their password. Via the Forgotten Password link you can have an e-mail sent to users, which gives their password.
Newsletter Confirmation/Newsletter Confirmation Plain
This e-mail is sent to users when they register for a newsletter. In the e-mail is a link which users must visit. Only then are they registered for the newsletter (double opt-in).
Your Order/Your Order Plain
These e-mails are received by the user as soon as they have ordered. The order is summarised once again in the e-mail. The summary of the order is not set up on the CMS page. eShop generates the summary automatically. The text on the CMS page is displayed via the summary.
Your Order Admin/Your Order Admin Plain
This e-mail is sent to the administrator as soon as the user orders something. The order is summarised in the e-mail. The summary of the order is not set up on the CMS page. eShop generates the summary automatically. The text on the CMS page is displayed via the summary.
Your Order (Other Country)/Your Order (Other Country) Plain
This e-mail is sent to users who order from countries for which no shipping costs have been set up. The e-mail is sent automatically when users order. These users must be informed of the shipping costs subsequently.
Your Order Admin (Other Country)/Your Order Admin Plain (Other Country)
This e-mail is sent to users who order from countries for which no shipping costs have been set up.
Thanks for Your Registration/Thanks for Your Registration Plain
This e-mail is sent to users when they register with your eShop.
Your Order has been Shipped/Your Order has been Shipped Plain
This e-mail is sent to users when you mark an order as shipped (if you click on Ship Now for an order).
Your Order Terms/Your Order Terms Plain
These CMS pages are not separate e-mails. The content is appended to the end of the order e-mail: Your Order/Your Order Plain.
E-mail Footer (Ident: oxemailfooter)/E-mail Footer Plain(Ident: oxemailfooterplain)
These CMS pages are not separate e-mails. The content of these CMS pages is appended to the end of each e-mail. In this e-mail you can insert your contact data and a link to your eShop, for example.

Settings for variants

Philipp Grashoff — Wed, 07 Jan 2009 14:28:40 +0100

Under Master Settings -> Core Settings -> System -> Variants, you will find four settings that allow you to adapt the behaviour of variants:

Display variants in assignment lists in eShop admin
In eShop, there are often lists in which you can assign products, e.g. when you assign products to discounts, attributes to products, etc.
- If the setting is active, the variants of the parent product will also be displayed in these lists.
- If the setting is not active, only the parent product will be displayed.
"Parent" products can be purchased
Here, you can specify whether or not the parent product can be purchased:
- If the setting is active, the parent product can also be purchased.
- If the setting is not active, only the variants can be purchased.
Variants inherit scale prices from "parent" product
This setting influences the behaviour of the eShop if scale prices are set up for the parent product: If the setting is active, scale prices will also be used for the variants.
Show variant ratings for "parent" product
Your users have the opportunity to rate the product. This setting affects the behaviour if variants are rated: If the setting is active, the ratings of the variants will also be displayed for the parent product.

Creating multidimensional Variants

Philipp Grashoff — Tue, 08 Dec 2009 12:18:32 +0100

Since version 4.2.0 you can create multidimensional variants. Multidimensional variants are needed if a product has several different versions, e.g. if clothes are available in different sizes and different colors. Using multidimensional variants, you can create a variant for each combination.

Creating multidimensional Variants

Multidimensional Variants are created for the accordant product - like normal variants - in the tab Variants. The single "dimensions" are separated by a pipe sign |. In the following example, multidimensional variants were created for a polo shirt: It is available in different sizes and different colors:

In the detail view of the product, a selection list is shown for each dimension:

Creating multidimensional variants using selection lists

If a product has many variants, it is time-consuming to create each variant separately. Alike normal variants, multidimensional Variants can be created using selection lists:

In the following example the multidimensional variants from the example above are created using selection lists:

Create a selection list for the different sizes (S, M, L). How selection lists are created is described in this tutorial.
Create a selection list for the different colors (red, brown, gray).
Select the accordant product and go to Variants tab.
From the list to the left, select the selection list for different sizes and click the arrow ==>.
Select the list for different colors and click the arrow ==>.

Thereby the multidimensional variants are created. If many products shall have the same multidimensional variants, you can save much time that way.

Setting up variants of a product

Philipp Grashoff — Wed, 07 Jan 2009 09:55:37 +0100

Variants allow you to set up different product options for which you can specify nearly all settings. Variants are saved as separate products. Accordingly, you can adapt variants the like standard products. You can enter a stock inventory for each variant, upload various images, modify the description text, etc.

The product for which you set up variants is called the parent product.

Setting up variants

You can specify variants of a product on the Variants tab for a product:

In Name of selection, you can specify a name for the selection between the various variants, e.g. Color or Size.

Below you will find entry fields that you can use to set up new variants:

In Selection, you enter the name of the variant, e.g. Red, if the variants are differentiated by colour.
In Prod.No., you can assign the variant its own product number. If you do not enter a product number, the product number of the parent product will be used.
In Price, you enter the price of the variant.
You can use Sorting to specify the order in which the variants will be displayed. The variant with the lowest number is displayed at the top, and the variant with the highest number at the bottom.
In Stock, you enter the stock inventory of the variant. You can use the selection list behind it to select the delivery status. The various delivery statuses are described in Settings for stock management.

What next?

A step-by-step procedure for setting up variants for a product is presented by means of an example in Example for variants: Different sizes.

Since version 4.2.0, multidimensional variants can be created. This is needed if e.g. a cloth is available in different colors as well as different sizes. Further information can be found in the article about multidimensional variants.

A few settings are available for the variants. These settings are described in Settings for variants.

If you are setting up the same variants for many products over and over, you do not have to set up the variants for each individual product. You can set up a selection list as a template for the variants. You will find additional information about this in Implementing frequently occurring variants with selection lists.

Create different Designs for Subshops

Philipp Grashoff — Wed, 16 Sep 2009 10:50:41 +0200

You can create a different design for each subshop: Normally, the files in /out/basic/ are used for displaying each shop. If you want to adapt the design for a subshop, you just have to create a directory in basic/ using the subshop ID as name and copy the files to be changed.

1) Create directory using the subshop ID as name

In the eShop admin, go to Master Settings -> Core Settings.
In the List at top, you can find the ID of each shop behind the shop name.
Create a new directory in /out/basic/. Use the subshop ID as name, e.g. /out/basic/2.

2) Copy files to be changed

Copy the files you want to adapt from basic/ to the new directory. For example, if you want to adapt the templates, copy the content from /out/basic/tpl to /out/basic/2/tpl.

From now on the subshop with ID 2 uses the files in /out/basic/2/ for displaying. All files not available there are taken from /out/basic/ - you only have to copy the files you want to change.

OXID eShop EE 4.0.0.0 Manual Feed

Update eShop to UTF-8 encoding

Requirements

Update Files

Community Edition

Professional Edition

Enterprise Edition

1) Check if system Requirements for UTF-8 are met

2) Make eShop temporarily offline

3) Backup Database

4) Change Database to UTF-8

5) Check language files

6) Check custom files

7) Run update.php

8) Update config.inc.php

9) Delete temporary files

10 ) Restore index.php

Update is finished

Display certain products or categories with a different template

Products

Categories

Update OXID eShop to version 4.5.1

Preliminary Note

Execute update in a test environment

1) Create backups

2) Copy files

3) Run update

4) Delete temporary files

5) Copy further files and adjust templates

The patch has been completed

Update from one release to another

Testing update on your local computer

1) Create backups

2) Copy files

3) Update database

4) Empty tmp directory

5) Adjust templates

The update is finished

Product pictures: Basics

Where the various picture types are displayed

Icons

Thumbnails

Pictures

Zoomed Pictures

What next?

When which e-mails are sent

Settings for variants

Creating multidimensional Variants

Creating multidimensional Variants

Creating multidimensional variants using selection lists

Setting up variants of a product

Setting up variants

What next?

Create different Designs for Subshops

1) Create directory using the subshop ID as name

2) Copy files to be changed