close

Filter

Importer Manual / Version 2301

Table Of Contents

3.1 General Configuration

Each importer needs a configuration file named after the importer and with the extension properties in the directory properties/corem or WEB-INF/properties/corem, if installed as web application. The Blueprint example module importer-config contains the file cm-xmlimport.properties, which serves as a template for such configuration files.

To install an XML importer make a copy of the file cm-xmlimport.properties in the same directory and rename the copy to <name>.properties where name is the name of the importer. The importer name must match the name of the jpif start file if the importer is used as command-line or the servlet context name if deployed as web application. See Section 3.3, “Deployment and Operation of a Standalone Importer” and Section 3.4, “Deployment and Operation of a Web Application Importer” for a description of the different deployment modes. The following table describes the general configuration in the properties file.

Note

Note

Any Java classes referenced in the properties configuration file (for example the multiResultGeneratorFactory or transformers) must be specified with fully qualified names.

import.user
Value String
Default importer
Description The name of the CoreMedia user with which the importer logs on. Make sure that the user has the rights required to carry out operations triggered by the import process, for example, creating a new document, editing, approving, publishing. For this purpose, the standard CoreMedia installation offers a predefined user called importer (password also importer).
import.password
Value String
Default importer
Description The password of the user to log in with.
import.autoLogoutSeconds
Value int
Default -1
Description This property defines the time of inactivity in seconds after which the importer should log out. When the importer is active again, it will log in at the server automatically. A value of "-1" means that the importer will not log out.
import.multiResultGeneratorFactory.property.sleepingSeconds
Value int
Default -1
Description An importer remains logged in per default, whether data are imported or not. When configuring SubDirGenerators, the property defines the number of seconds for the importer to be inactive after the completion of the import. If the number of seconds is very large, it is reasonable to log out the importer automatically. In this case, the released importer license can be used by another importer. Note that the special value "-1" will cause the importer to terminate after importing the contents of the inbox directories.

Table 3.1. Properties of the cm-xmlimport.properties file


The following configuration deals with the preparation and transformation of source documents. Both are generic, thanks to the importer API. Since this part of the configuration depends on the source format, this part of the configuration should be conducted by the respective developer himself.

import.loginTimeoutSeconds
Value long
Default -1
Description This property defines the timeout for login attempts after which the importer aborts. If import.loginTimeoutSeconds=-1, the importer tries to login forever without abortion.
import.enforceCompleteVersion
Value Boolean
Default true
Description

This property handles the processing of XML importer files. See Section 4.1, “The CoreMedia XML Format” for details on the CoreMedia XML format.

  • import.enforceCompleteVersion=true

  • For each <version> element in the importer file a new version will be created in the CoreMedia repository. For all properties of a version the values must be given. It is not allowed to omit a property.

  • import.enforceCompleteVersion=false

  • Now it is possible to omit even all property elements of a version. If there are only action elements and the document already exists on the server, then no new version is created and the corresponding actions are applied to the document (delete) or to the latest document version on the server (approve, delete). If there is at least one <property> element in the <version> element then for every property that is specified in the document type but missing in the XML importer file, the property value of the predecessor document version is taken. If there is no predecessor version, then a default value is inserted, that depends on the property type.

import.validate-textproperty
Value Boolean
Default false
Description If "true" the importer validates all XML text properties against the associated DTD. If a validation fails, no document is created on the server. For big XML properties the validation may take some time.
import.removeBrokenLinks
Value Boolean
Default false
Description If "true" the importer removes broken content links in link list and markup properties. In markup properties only the link tag (a or img) is removed, not the containing link text. Be careful when enabling this option, as it may lead to invalid XML in markup properties.
import.entityResolverClass
Value class name
Default see description
Description Configures the name of a class of type org.xml.sax.EntityResolver used to resolve entities in markup properties during XML validation. The default value is com.coremedia.xml.ClasspathURLEntityResolver.

Table 3.2. Properties of the cm-xmlimport.properties file


Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.