{"id":21840,"date":"2022-04-11T13:51:26","date_gmt":"2022-04-11T11:51:26","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-data-importer\/administrators-guide\/configuring-import-profiles\/generic-xml-csv-or-json-import\/"},"modified":"2026-05-13T09:37:56","modified_gmt":"2026-05-13T07:37:56","slug":"generic-xml-csv-or-json-import","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-data-importer\/administrators-guide\/configuring-import-profiles\/generic-xml-csv-or-json-import\/","title":{"rendered":"Generic XML, CSV or JSON import"},"content":{"rendered":"<div id=\"main-content\" class=\"wiki-content group\">\n<p>Generic import allows you to import documents and their metadata from an XML, CSV, or JSON file containing this metadata.<\/p>\n<p>The example described on this page is the import of scanned passports in PDF format with an XML file containing the metadata.<\/p>\n<p>For each document scanned, an XML file containing the metadata (name, date of birth and gender) will have been generated beforehand.<\/p>\n<p>The following is the XML file used in this example:<\/p>\n<div class=\"code panel pdl\" style=\"border-width: 1px;\">\n<div class=\"codeContent panelContent pdl\">\n<pre class=\"theme: Midnight; brush: c#; gutter: false\" style=\"font-size: 12px;\">&lt;?xml version=\"1.0\" encoding=\"utf-8\"?&gt;\n&lt;root&gt;\n    &lt;page&gt;\n        &lt;item name=\"FullName\" value=\"Nom Pr\u00e9nom\"\/&gt;\n        &lt;item name=\"BirthDate\" value=\"01\/05\/1980\"\/&gt;\n        &lt;item name=\"Sex\" value=\"Male\"\/&gt;\n        &lt;FilePath&gt;\n            C:Document.pdf\n        &lt;\/FilePath&gt;\n    &lt;\/page&gt;\n&lt;\/root&gt;<\/pre>\n<\/div>\n<\/div>\n<div class=\"aui-message hint shadowed information-macro\">\n<p class=\"title\">\n<\/div>\n<\/div>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><strong>Information<\/strong><\/p><cite>It is also possible to have a single XML, CSV, or JSON file containing the metadata of multiple PDF documents.<\/cite><\/blockquote>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><strong>Examples XML files<\/strong><\/p><cite>Here are some other examples of XML files supported by Open Bee\u2122 Data Importer:<br\/>&#8211; <a href=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/DataImporterxml.zip\">xml1.xml<\/a><br\/>&#8211; <a href=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/DataImporterxml.zip\">xml2.xml<\/a><br\/>&#8211; <a href=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/DataImporterxml.zip\">xml3.xml<\/a><\/cite><\/blockquote>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><strong>Examples CSV files<\/strong><\/p><cite>&#8211; <a href=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/DataImportercsv1.csv\">csv1.csv<\/a><br\/>&#8211; <a href=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/DataImportercsv1.csv\">csv2.csv<\/a><\/cite><\/blockquote>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><strong>Example JSON file<\/strong><\/p><cite>&#8211; <a href=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/DataImporterjson.zip\">json.json<\/a><\/cite><\/blockquote>\n<h4>&nbsp;<\/h4>\n<h4 id=\"Importg\u00e9n\u00e9riqueXML,CSVouJSON-L'assistantdeconfigurationd'unprofild'importg\u00e9n\u00e9riquesed\u00e9composeen5\u00e9tapes:\">The wizard for setting up a generic import profile is broken down into 5 steps:<\/h4>\n<ul>\n<li><strong>Type<\/strong><\/li>\n<\/ul>\n<p>This screen allows you to select the type (Generic Import) as well as the name of the configuration.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"confluence-embedded-image confluence-content-image-border\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908193.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908193.png\" width=\"730\" height=\"245\"><\/p>\n<ul>\n<li><strong>Download<\/strong><\/li>\n<\/ul>\n<p>Next, an example of an XML, CSV, or JSON file containing the metadata must be filled in.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"confluence-embedded-image confluence-content-image-border\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908186.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908186.png\" width=\"720\" height=\"173\"><\/p>\n<ul>\n<li><strong>Metadata selection<\/strong><\/li>\n<\/ul>\n<p>Open Bee\u2122 Data Importer will analyze the file containing the metadata uploaded in the previous step and offer the user to select all the metadata they want to send to Open Bee\u2122 Portal.<\/p>\n<p>Each metadata consists of an identifier and a value:<\/p>\n<ul style=\"list-style-type: square;\">\n<li>The identifier is information from the XML file that will be the same for all files sent to Open Bee\u2122 Data Importer<\/li>\n<li>On the other hand, the value can of course be different from one file to another.<\/li>\n<\/ul>\n<p>The list of identifiers and values corresponds to the tags detected&nbsp;in the metadata file (For XML files: tag name, tag content, attribute name, and attribute content).<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"confluence-embedded-image confluence-content-image-border\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908191.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908191.png\" width=\"730\" height=\"476\"><\/p>\n<div class=\"aui-message hint shadowed information-macro\">\n<\/div>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p>Example: Setting up 3 metadata: Name, Date of Birth, and Gender<\/p><cite><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908192.png\" width=\"730\" height=\"401\"\/><\/cite><\/blockquote>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><\/p><cite>Adding or removing metadata is done using the &#8220;-&#8221; and &#8220;+&#8221; buttons<\/cite><\/blockquote>\n<\/p>\n<ul>\n<li><strong>Metadata Pairing<\/strong><\/li>\n<\/ul>\n<p>After selecting the metadata, it must be associated with an Open Bee\u2122 Portal ranking rule.<\/p>\n<p>It is possible to select an existing ranking rule in Open Bee\u2122 Portal or create a new one by clicking on the &#8220;+&#8221; button.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"confluence-embedded-image confluence-content-image-border\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908187.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908187.png\" width=\"750\" height=\"371\"><\/p>\n<ul>\n<li><strong>Folder<\/strong><\/li>\n<\/ul>\n<p>Configuring the generic import ends with the selection of the folders:<\/p>\n<ol>\n<li>Selecting the folder where the metadata files will be deposited (XML, CSV or JSON)<\/li>\n<li>Selection of the folder where the PDF documents to be sent to Open Bee\u2122 Portal will be stored.\n<ol>\n<li>Either the PDF document is in the same directory and has the same name as the metadata file (only the extension will be different)<\/li>\n<li>Or the document path is defined in a metadata file tag (useful if a metadata file contains the metadata of multiple documents)<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"confluence-embedded-image confluence-content-image-border\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908188.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908188.png\" width=\"750\" height=\"440\"><\/p>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><strong>Network Directory<\/strong><\/p><cite>The folder where XML, CSV, or JSON files are deposited can be a network directory<br\/>In this case, you will need to configure the login information for this directory<br\/><img decoding=\"async\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/04\/273908190.png\" width=\"400\"\/><\/cite><\/blockquote>\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\"><p><strong>Special case of a file with several documents to import<\/strong><\/p><cite>Documents that have already been checked out will be imported.<br\/>To import documents that have not yet been extracted, you must modify the original file located in the temporary folder (C:Program Files (x86)OpenBeeOpen Bee Data ImporterTemp) and delete the lines corresponding to the previously extracted documents.<br\/>This file can then be moved to the filing folder to extract and import the missing documents.<br\/>Note: If the import is not stopped or suspended, the above manipulation is not to be performed.<\/cite><\/blockquote>\n","protected":false},"excerpt":{"rendered":"<p>Generic import allows you to import documents and their metadata from an XML, CSV, or JSON file containing this metadata. The example described on this page is the import of scanned passports in PDF format with an XML file containing the metadata. For each document scanned, an XML file containing the metadata (name, date of [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":21828,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"templates\/ob-help-products.php","meta":{"footnotes":""},"class_list":["post-21840","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21840","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=21840"}],"version-history":[{"count":3,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21840\/revisions"}],"predecessor-version":[{"id":21849,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21840\/revisions\/21849"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/21828"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=21840"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}