Login
    Contents x
    Import client
    • 18 Dec 2023
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Import client

    • Updated on 18 Dec 2023
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    1. Import client

    1.1 Presentation of the tool

    The import client is a program external to Constellio that allows you to import files and other records into Constellio.

    The tool uses the Importing data in .xlsx format to perform the import. It also allows you to automatically generate an importable template from a network share.

    1.2 Download

    VersionNew featuresSupported version of ConstellioDownload
    2.10
    • Authentication is now performed through Constellio in the browser.
    • Support for authentication with OAuth2.
    • Added a recovery mechanism to resume unfinished imports.
    • Removed the expiration limit for authentication tokens (OAuth2 only).
    		11.1.8+https://constellio.cloud.constellio.com/constellio/dl?id=00000906232

    2.8
    • Accounting with the import options "cellRange" and "keepExtraWhitespace".
    • Improved stability.
    		10.0.3+https://constellio.cloud.constellio.com/constellio/dl?id=00000527379
    some browsers enable drag-n-drop only when dataTransfer has data2.7
    • Accounting with version 10.
    • Improved error messages.
    		10.0.3+https://constellio.cloud.constellio.com/constellio/dl?id=00000527061
    2.6.1
    • Added the "import.withConnexionTimeout" configuration. to allow the connection to never expire during uploading.
    		9.2https://constellio.cloud.constellio.com/constellio/dl?id=00000608671
    2.6
    • Increased logon time
    • Improved handling of timeout errors during import.
    • Adding metadata, creation dates, and editing documents when generating an import file.
    		9.2+
    9.1.0.7
    8.2.1.96    		Constellio-importExportScript_v2.6.zip
    2.5
    • Fixed an issue with reading paths that contain accents.
    • Fixed a RAM issue when uploading large files.
    		9.2+
    9.1.0.7
    8.2.1.969    		Constellio-importExportScript_v2.5.zip
    2.4.1
    • Metadata prevalidation.
    • Network share export.
    		9.2+
    9.1.0.7
    8.2.1.969    		Constellio-importExportScript_v2.4.1.zip
    2.3.1
    • Import files.
    • Importing records.
    • Network share export.
    • Ssl authentication.
    		9.1
    8.2.1.968    		Constellio-importExportScript_v2.3.1.zip

    2. User Guide

    To start the program, click on "start-program.bat" and log in with your Constellio ID.

    2.1 Configuration

    Before starting the program, the server address and port must be set in the "configurations/config.properties" file with the "server.host" and "server.port" properties.

    This information will be requested when opening the program if it is not defined in the configuration file.

    To connect over HTTPS, set the auth.connectUsingSSL property to "true" in the configuration file.

    2.2 Import

    The "Import" part allows you to import folders and documents into Constellio from an import template in Excel format (.xlsx) that can be generated from the export tool or created manually (see Constellio documentation).

    The import client template has an additional "content" column that corresponds to the path of the file to be imported as content for each document. Important: Do not use the "Hyperlink" function in Excel, but rather copy the full path to the file in text format.

    • e.g. C:\Users\Constellio\Desktop\constellio\myAImporter file.docx 

    The following information must be defined in the configuration file: 

    • import.filePath: The full path of the import template (template.xlsx)
    • import.collection: The code of the Constellio collection where the records are to be imported.

    2.3 Export

    The "Export" part is used to generate an import template from a local network share. It is possible to use a regular expression to detect folders in the network share that match a topic to populate the corresponding column with the correct codes. It is also possible to use a default topic and administrative unit to manually edit them in the Excel file before importing.

    The stencil headers are generated from the TEMPLATE file in the /bin/ folder. THIS FILE SHOULD NOT BE MODIFIED.

    The retention rules correspond to the first rule for the category. If no rules are found for a category, the import template field will be left blank and the data will need to be corrected manually.

    The following information can be defined in the configuration file: 

    • export.root_path: The root path of the network share to export.
    • export.use_category_regex: If we must use automatic detection of topics (true or false).
    • export.category_regex: The regular expression to use for automatic topic detection.
    • export.administrative_unit: The default administrative unit.
    • export.default_category: The default topic.

    The export information will be requested the first time you open the tool and can then be modified from the "Configurations" menu or directly in the "config.properties" file.

    3. Example of using the import client

    Go to this url to access an example of how to use the import client. 

    Was this article helpful?
    What's Next
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout