Export Task Configuration Files
An export configuration file contains definitions of the following properties:
name
-
The name of this export configuration. This property is optional, but is useful for documentation and debugging purposes: it is included in log messages.
objectTypes
-
The object types to be exported. You can specify any combination of the following keywords, separated by commas:
article
-
Export all content items.
section
-
Export all sections.
pool
-
Export all section pages, inboxes and lists.
Alternatively, you can specify
*
, which means export everything: this is the default. sections
-
The sections (including all descendant sections) from which content may be exported, specified by section name. The section names must be separated by commas. The special value
*
means "all sections". You can usesectionsById
instead of this property. If neither this property norsectionsById
is specified, then all sections are exported. sectionsById
-
The sections from which content may be exported, specified by ID. The section IDs must be separated by commas. You can use
sections
instead of this property. If neither this property norsections
is specified, then all sections are exported. enabled
-
Enables this export task when set to
true
. The default isfalse
. disableEvents
-
Not currently used.
includeReferredObjects
-
When set to
true
, any content items that are referenced in an exported content item are also exported. When set tofalse
, this is not done. templateDirectory
-
The absolute path of a folder on the server. If specified, the folder must contain XSL transformations to be applied to any exported sections or content items. The transformation to be applied to sections must be called
section.xsl
, and the transformation to be applied to content items must be calledarticle.xsl
.If this property is not specified, then no transformation is applied, and exported sections/content items are output as Escenic syndication files. If it is specified and the specified folder contains correctly named XSL transformations, then exported data is piped to these transformations, and the saved export files will contain the results of the transformations.
cache
-
If set to
true
, then the XSL transformation in thetemplateDirectory
(if specified) is cached. If set tofalse
(the default), then it is not. import
-
If
disableEvents
is set tofalse
, then every time a section or content item is imported, it will also automatically be exported. You can prevent this happening by setting this property tofalse
(the default). If you actually want imported sections/content items to be exported again, set it totrue
. exportTarget
-
The folder (on the server) in which exported files are to be saved, specified as an absolute file URL (
file:///tmp/escenic/export/pub1
, for example). You can include system properties in the URL (file:///${java.io.tmpdir}/export/pub1
, for example). The default if this property is not specified isfile:///${java.io.tmpdir}
.