Glossary

Introduction

In this glossary we collect terms typical for the OXID world. We collect them in alphabetical order and always try to describe them as easy and abstract as possible.

Edition

An edition is child of the OXID eShop family. Editions are differentiated mainly by their feature sets. Currently there are the editions Community, Professional, Enterprise and B2B.

Installation

The term installation is used for modules as well as for OXID eShop itself. Installation covers only files operation. To get more information how module installation works, please read document: Module installation and setup states.

Module configuration

The term module configuration is used to describe module configuration only in configuration files scope. When module is being configured, database is not affected. To get more information how module configuration works, please read document: Module installation and setup states.

Setup

The term setup is used for modules as well as for OXID eShop itself. After setup of the eShop, the eShop is launched and can be used. After setup/activation of a module, the module will be used by the eShop. The Installation has to be done first before setup can be done. To get more information how module setup works, please read document: Module installation and setup states.

Meta Package

A meta package defines the kind and the exact version of components of a OXID Compilation See the composer.json file of the OXID eShop Community Edition meta package for an example.

OXID Compilation

The OXID eShop compilation consists of a certain edition of OXID eShop, which is bundled with the following modules/themes:

Professional Edition and Enterprise Edition compilations additionally contains module:

Visual CMS module for easy management of CMS content via drag and drop functionality.

The components of a OXID Compilation are defined in a Meta Package to ensure the best stability and interoperability, in a compilation, the versions of all components are pinned to a specific patch release.

Vendor ID

For module developers it is necessary to use unique names for namespaces or classes in their OXID eShop extensions. One way to achieve this is using an unique ID for your company, which you can register by making a pull request to here. This is ID called a Vendor ID. More information regarding the Vendor ID can be found on https://oxidforge.org/en/extension-acronyms

OXID eShop component

Component installed via composer which has type oxideshop-component. More about component please read here.