Installation¶
Installing this extension does nothing in and of itself. You still need to extend the TCA definition of some tables with the appropriate syntax and create specific connectors for the application you want to connect to.
TYPO3 CMS 9 or 10 is required, as well as the “scheduler” system extension.
Upgrading and what’s new¶
Upgrade to 5.0.0¶
There are many changes in version 5.0.0, but backwards-compatibility has been provided for all them (except the minor breaking change mentioned below). Please make sure to update your configuration as soon as possible, backwards-compatibility will be dropped in version 5.1.0. Messages for deprecated configuration appear in the backend module when viewing the details of a configuration.
Changes¶
The general configuration must now be placed in $GLOBALS['TCA'][table-name]['external']['general']
instead of $GLOBALS['TCA'][table-name]['ctrl']['external']
.
The “additionalFields” property from the general configuration (and not from the “MM” property)
has been moved to its own configuration space. Rather than
$GLOBALS['TCA'][table-name]['ctrl']['external'][some-index]['additionalFields]
it is now $GLOBALS['TCA'][table-name]['external']['additionalFields'][some-index]
.
Furthermore, it is no longer a simple comma-separated list of fields, but an array structure
with all the same options as standard column configurations.
For more details, see the relevant chapter.
The “MM” property is deprecated. It should not be used anymore. Instead the new multipleRows or children properties should be used according to your import scenario.
The “userFunc” property of the transformations configuration has been renamed to userFunction and its sub-property “params” has been renamed “parameters”.
If both “insert” and “update” operations are disabled in the general configuration (using the disabledOperations property), External Import will now delete records that were not marked for update (even if the actual update does not take place). Previously, no records would have been deleted, because the entire matching of existing records was skipped.
Accessing the external configuration inside a custom step with
$this->configuration
or $this->getConfiguration()
is deprecated.
$this->getImporter()->getExternalConfiguration()
instead.
The “scheduler” system extension is required instead of just being suggested.
New stuff¶
It is possible to import nested structures using the children property. For example, you can now import data into some table and its images all in one go by creating a nested structure for the “sys_file_reference” table.
The multipleRows and multipleSorting properties allow for a much clearer handling of denormalized external sources.
Check out the revamped Mapping data chapter which should hopefully help you get a better picture of what is possible with External Import and how different properties (especially the new ones) can be combined.
Custom steps can now receive an array of arbitrary parameters.
Breaking changes¶
The \Cobweb\ExternalImport\Step\StoreDataStep
class puts the list of stored
records into the “records” member variable of the \Cobweb\ExternalImport\Domain\Model\Data
object. This used to be a simple list of records for the imported table. Since child
tables are now supported, the structure has changed so that there’s now a list of
records for each table that was imported. The table name is the key in the first
dimension of the array. If you were relying on this data in a custom step, you will
need to update your code as no backward-compatibility was provided for this change.
Other requirements¶
As is mentioned in the introduction, this extension makes heavy use of an extended syntax for the TCA. If you are not familiar with the TCA, you are strongly advised to read up on it in the TCA Reference manual.