How to customize the Dataset¶

Akeneo PIM ships with two datasets. They are located in vendor/akeneo/pim-community-dev/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures:

icecat_demo_dev to be able to take a look and play with the PIM with already preset families, categories, products, etc..
minimal to start a brand new blank PIM project

From v5.0, Akeneo PIM ships with minimal enabled.

Warning

From version PIM 3.2, minimal catalog does NOT include any default admin user for security reasons. This means you cannot connect anymore with the previous default admin account and the admin password. You have to create it yourself with the command pim:user:create and give it a proper password.

Choosing Which Dataset to Install¶

In order to choose which dataset to install, you have to use the option --catalog of the command pim:installer:db. By default, the minimal catalog is loaded.

For instance, to load the icecat catalog:

php bin/console pim:installer:db --catalog vendor/akeneo/pim-community-dev/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/icecat_demo_dev

Warning

Be careful, the command pim:installer:db will drop your database and then recreate it.

Using Your Own Dataset¶

A custom dataset can be used during Akeneo PIM installation, so you can set up your own catalog structure or demo data. Here are the steps needed create your custom dataset.

Add your Own Data¶

Create a directory to put your data in. For instance, /path/to/my/mydataset in one of your bundle.

Copy all *.yml and *.csv files from vendor/akeneo/pim-community-dev/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/minimal to the /path/to/my/mydataset directory. Then customize them depending on your needs.

Mandatory Data¶

Be sure you have included mandatory data in your custom installation dataset. These are:

user group all named All regardless of the translation in your user_groups.yml;
attribute group other in your attribute_groups.yml.

You should also make sure that: - your product attributes have only one attribute of type pim_catalog_identifier (SKU by default); - you have at least one channel in your channels.yml; - you have at least one category tree (default: master) in your categories.csv.

Tip

Check Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/minimal to see what the mandatory format is and which fixtures are absolutely needed, then you can draw heavily on Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/icecat_demo_dev to add optional objects.

Load the Data¶

You can now (re)install the database and loading your own dataset by running:

Warning

The command pim:installer:db will drop your database and then recreate it using the provided dataset

php bin/console pim:installer:db --catalog path/to/my/mydataset

Found a typo or a hole in the documentation and feel like contributing?
Join us on Github!