Changes for page Batch Import API

Last modified by Anca Luca on 2023/01/30 00:15

<
From version < 23.14 >
edited by Anca Luca
on 2019/05/23 19:27
To version < 24.1 >
edited by slauriere
on 2019/06/21 14:58
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.lucaa
1 +xwiki:XWiki.slauriere
ExtensionCode.ExtensionClass[0]
Description
... ... @@ -15,20 +15,20 @@
15 15  
16 16  == Features ==
17 17  
18 -* data to be imported can be read from a page attachment, but also from any input stream,
19 -* CSV separators and text delimiters can be configured
20 -* the locale can be specified for the numbers and dates in the source file, any date format can be specified as well as the multiple values separator (for lists of values),
21 -* Office files from a folder on the server file system can be imported in the content of the created documents, based on a mapping configured in the excel / csv file. Any file can be attached to the imported documents based on such a configuration
22 -* multiple data deduplication options can be configured for the import: behavior of the import when two rows in the imported file seem to be mapped on the same wiki document, behavior of the import when an imported document would overwrite a document already existing in the wiki
23 -* automatic generation of document names can be done based on a user configured prefix,
24 -* an import preview can be done to verify the mapping and data conversion, as well a simulation of the import of the whole data set
25 -* the batch import service provides functions to read the import configuration from the request or from an xwiki object, thus allowing to easily handle parameters configuration and persisting the configurations,
26 -* detailed and internationalizable logging of the import result,
27 -* extensible file readers system, with default implementation for excel and csv data source files,
28 -* extensible logging system, allowing to write a different logger, if needed.
18 +* Data to be imported can be read from a page attachment, but also from any input stream.
19 +* CSV separators and text delimiters can be configured.
20 +* The locale can be specified for the numbers and dates in the source file, any date format can be specified as well as the multiple values separator (for lists of values).
21 +* Office files from a folder on the server file system can be imported in the content of the created documents, based on a mapping configured in the Excel or CSV file. Any file can be attached to the imported documents based on such a configuration.
22 +* Multiple data deduplication options can be configured for the import: behavior of the import when two rows in the imported file seem to be mapped on the same wiki document, or when an imported document would overwrite a document already existing in the wiki.
23 +* Automatic generation of document names can be done based on a user configured prefix.
24 +* An import preview can be done to verify the mapping and data conversion, as well a simulation of the import of the whole data set.
25 +* The batch import service provides functions to read the import configuration from the request or from an XWiki object, thus allowing to easily handle parameters configuration and persisting the configurations.
26 +* Since version 2.3, an option makes it possible to specify whether empty values in the input file should be handled as such and overwrite possibly non-empty values in object properties or document data (title, parent, content), or should be ignored. In previous versions, empty values were always honoured for document data, and ignored for object properties.
27 +* Detailed and internationalizable logging of the import result.
28 +* Extensible file readers system, with default implementation for Excel and CSV data source files.
29 +* Extensible logging system, allowing to write a different logger, if needed.
30 +* Although out of the scope of the batch import, a function to delete the existing instances of a class is provided, to facilitate the cleanup of the imported instances.
29 29  
30 -* although out of the scope of the batch import, a function to delete the existing instances of a class is provided, to facilitate the cleanup of the imported instances.
31 -
32 32  == For developers ==
33 33  
34 34  If you want to write a new connector to a new type of source file, it is enough to implement the [[ImportFileIterator>>path:../../download/Extension/Batch+Import+API/xwiki-batchimport-api-1.0-javadoc.jar/org/xwiki/batchimport/ImportFileIterator.html]] interface and set the hint of this implementation as the type of import in the [[BatchImportConfiguration>>path:../../download/Extension/Batch+Import+API/xwiki-batchimport-api-1.0-javadoc.jar/org/xwiki/batchimport/BatchImportConfiguration.html]] used by the import.
Show installed count
... ... @@ -1,0 +1,1 @@
1 +Yes

Get Connected