Import GUI

The import GUI is a add-on for the Pacemaker Professional and Enterprise edition. It enables shop owners or other people that works in the Magento backend to upload import files, e. g. in CSV format, create the .OK file and start the import process. This can be done bei either the default Magento CRON, manually on the CLI with the bin/magento pacemaker:import <ID> comand or by one of the Pipelines provided by the Enterprise edition.

Configure the GUI

In case, the GUI will be used with Pacemaker Enterprise, the configuration can be found under the following path: Stores > Configuration > TechDivision > Pacemaker Upload and should contain the following values

import gui settings
Figure 1. Configuration in Magento Backend

GUI Settings

The configuration value for Commandline should be set to the Pacmaker CLI that has to be used to create the .OK file that is necessary to start the import. By default this value should be set to vendor/bin/pacemaker.

As a pipeline should be used to import the files, the configuration value for Working Directory has to be the same as for the Pacemaker working directory, but WITHOUT the leading var.

The configuration for Enable CRON MUST not be set to Yes because this will probably use the default Magento CRON to start the import and passing by the apropriate pipeline.

Upload Files

In general, the GUI will provide the functionality to upload CSV files as well as adjust the settings for the import process itself, e. g. the mode that has to be used like add-update. Depending on the configuration of the GUI and the used Pacemaker edition, the uploaded files will be imported directly or via one of the pipelines.

Keep in mind, that in combination with Pacemaker Enterprise and the configuration described above, the upload GUI can only be used to upload files. It is NOT possible to configure the import itself, as this will be done by the pipeline configuration that finally runs the import. Therefore, the configuration will have NO impact.

import gui upload
Figure 2. Upload GUI for import files

Upload GUI

Via the drop-down Entities the entity type that matches the uploaded files has to be selected. If the entity type doesn’t match the filename, an error will be triggered. In case the Product entity has been selected, the additional drop-down Import Mode will be rendered.

Import Modes

The Default import mode imports all the data that is available in the file, notwithstanding the data has changed since the last import or not.

In contrast to this, The import mode Change-Set Detection will compare the data (using so called and configurable change sets) from the database with the one found in the import files and only updates the DB if the data has been changed. The can improve performance massively in add-update mode, as invoking DB CRUD operations is very expensive.

The mode Change-Set Detection will be the default mode when importing data via default Pacemaker pipeline. It should be considered well to also activate the feature-configuration/import/caching-and-cache-warming.html#cache-warming[cache warming] functionality, because this can additioanlly have a significant impact on performance, because all the data to be compared to, will be loaded during the bootstrap process in a very efficient manner.

Additional Parameters

The drop-down Operation provides the possibility to select the import mode. Read more about this topic in the official Pacemaker community documentation.

The checkboxes for Archive Artefacts, Debug Mode, Single Transaction can be used to activate the apropriate functionality. To get more information about the functionality behind this flags, you can also have a look in the official Pacemaker community documentation.

The checkbox Cache Enabled enables the caching functionality. In general, caching during the import is not very helpful, because the main impact on the performance will have the CRUD operations that can not be cached. In case the import will be processed over a network, e. g. in the cloud, it can be helpful to lower the time that is necessary to load the data from the DB. Additionally, the cache warming functionality will only work if the cache will be enabled.

The drop-down Log Level defines the log level that has to be used. By default this is set to warning, but can be changed to the given requirements. The log file named system.log will be found the directory with the import artefacts or in the archived artefact, if the apropriate checkbox has been set.