Important
You are browsing documentation for version 5.0 of OroCommerce. Support of this version ended in January 2025. Read the documentation for version 6.1 (the latest LTS version) to get up-to-date information.
See our Release Process documentation for more information on the currently supported and upcoming releases.
Fields Configuration
Header
This option is used to configure a custom column header. A field label is used by default.
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
/**
* @var string
*
* @ConfigField(
* defaultValues={
* "importexport"={
* "header"="Custom field"
* }
* }
* )
*/
protected $field;
Order
This option is used to configure a custom column order.
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
/**
* @var string
*
* @ConfigField(
* defaultValues={
* "importexport"={
* "order"=100
* }
* }
* )
*/
protected $field;
Identity
The fields with this option are used to identify (search) the entity. It is possible to use multiple identity fields for one entity.
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
/**
* @var string
*
* @ConfigField(
* defaultValues={
* "importexport"={
* "identity"=true
* }
* }
* )
*/
protected $field;
Excluded
The fields with this option cannot be exported.
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
/**
* @var string
*
* @ConfigField(
* defaultValues={
* "importexport"={
* "excluded"=true
* }
* }
* )
*/
protected $field;
Full
All the fields of the related entity are exported. The fields with the [Excluded](#excluded) option are skipped. If full is set to false (the default value), only the fields with an identity will be exported.
use Oro\Bundle\EntityConfigBundle\Metadata\Annotation\ConfigField;
/**
* @var string
*
* @ConfigField(
* defaultValues={
* "importexport"={
* "full"=true
* }
* }
* )
*/
protected $field;