Importer Manual / Version 2404
Table Of Contents
In the CoreMedia Blueprint workspace in global/examples you
will find a coremedia-application module importer-template with
three submodules importer, importer-config, and
importer-image.
Building and Deploying the Importer
Before you can start the importer, you have to configure and build your own importer application as follows:
Take the
importer-templateexample module and integrate it into your workspace. You probably want to do this by making a copy (e.g., inapps/content-server/modules/cmd-tools) in order to avoid merge conflicts with future releases of the CoreMedia Blueprint. Rename the copied modules, e.g., with a prefix of your choice (likemy-importer...). If you want, you can mergemy-importerandmy-importer-configinto a singlecoremedia-applicationmodule (like thetheme-importer-applicationdoes).Replace the
cmprefix ofcm-xmlimport.jpifandcm-xmlimport.propertieswith your own one, for example,my-xmlimport.jpif.Make sure that the
propertiesconfiguration file and theJPIFstartup file have the same basename. Example: The configuration fileproperties/corem/my-xmlimport.propertiesbelongs to the filebin/my-xmlimport.jpif.Configure the importer in the
my-importer-config/.../my-xmlimport.propertiesfile as described in Section 3.1, “General Configuration”.Build your importer with
mvn install -pl :my-importer -am.
Starting the Importer
When you have built the importer, you can start it with the following command,
where <ImporterName> corresponds to the name of the importer JPIF file,
my-xmlimport, for example:
bin/cm <ImporterName>
The importer will check the inbox once and then terminates. To constantly check the inbox the importer can be deployed as Docker container instead. See Section 3.4, “Deployment and Operation of an Importer in Docker”.
