Import Client
  • 04 Feb 2025
  • 4 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Import Client

  • Dark
    Light
  • PDF

Article summary

Import client

The Import Client is a program external to Constellio that allows you to import copies of files and their folders into Constellio in bulk.  

Note that the files will then be removed from the original location in order to limit duplicates. The client does not act as a synchronization tool, but as an import tool. 

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

1. Download

In order to use the import client, please download the executable program via the following link. 

VersionNew featuresSupported version of ConstellioDownload
3.0

- Simplification of the configuration file

- Added an interface to select folders to export

- Multiple selection of folders for export

- Improvements to the topic detection mechanics

- Improvements to app menu navigation and added colors

- Added configuration to ignore certain file types when exporting

- Added an option to select folders to ignore when exporting

12+https://internal.constellio.me/constellio/dl?id=00001030002


2. Using the Import Client

2.1 Steps for Using the Import Client

  1.  Import the Import Client
  2.  Extract files from the import client
  3.  Generate the import client configuration file
  4.  Extract downloaded configuration files
  5. Replace the configuration file in the "configurations" directory of the import client"
  6. Run the import client application

2.2 Configuring the Import Client

Before you can import recordings into Constellio, you need to configure the client to define where the content will be sent. To do so;  

  1. Go to Administration;  
  2. Click on Import Records;  
  3.  Click on Import Tool Configuration;
  4.  Complete Export/Import Configuration fields
  5. If necessary, complete the  Advanced Configurations
  6.  Generate the import client configuration file
  7. Extract the "importClientProperties" file
  8. Cut the contents of the file 
  9. Open the "configurations" folder of the import client
  10. Paste previously cut content to replace files
  11. The import client is now ready to use.

2.2.1 Export/Import Configuration

ElementDescription
Import CollectionSpecify which collection the records will be imported into.
Default administrative unitSpecify the default administrative unit entered in the import file.
Topic Detection TypeIndicate how the classification plan topics will be entered into the import file
  • Use Default Rubric: Allows you to select a rubric that will be assigned to all records to be imported.
  • Detect Topics Automatically: Allows you to manually select or enter a regular expression to recognize topics in the network share. 

2.2.2 Advanced Configurations

Using advanced configurations
Be careful, it is generally not recommended to change system requirements. It is best to use the default values in most cases. 
ElementDescription
Ignore missing files when uploading filesAllows you to continue importing if files are present in the template but not present in the network share. This case figure will create empty metadata records in Constellio. 
Abandoning a file upload after 5 minutes of waitingA file will not be imported if there is more than 5 minutes of waiting.
Authentication TypeAllows you to choose how the user will be authenticated in Constellio when using the Import Client.
File Extensions to IgnoreAllows you to enter the extension of files that will not be imported into Constellio.

2.3 Export

The "Export" part allows you 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 rubric and administrative unit to manually edit them in the Excel file prior to import as needed.

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

2.3.1 Automatic Topic Detection

If the "Automatically detect topics" option is enabled, the import client will attempt to identify local folders that correspond to classification topics in Constellio.

  • Folders detected as topics will not be imported as folders into Constellio.
  • Child folders to folders detected as topics will be classified in the corresponding topic in Constellio
  • Topics corresponding to the detected codes must already exist in Constellio
Note
A folder that directly contains documents or whose parent folder is not detected as a topic will not be detected as a topic, even if its title matches the selected regular expression.

2.4 Import

The "Import" part allows you to import folders and documents into Constellio from an import template in Excel (.xlsx) format 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\monFichierAImporter.docx 

3. Example of using the import client

Go to this link for an example of how to use the import client. 


4. Release Note

VersionNew featuresSupported version of ConstellioDownload
2.10.1
  • Using security certificates recognized by the user's Windows workstation
11.1.8+
https://internal.constellio.me/constellio/dl?id=00000987372
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://internal.constellio.me/constellio/dl?id=00000906232

2.9
  • Added "import.withConnectionTimeout" configuration to disable timeouts during import
  • Fixed an issue when importing Excel templates that contain empty rows
10.0.3+
https://internal.constellio.me/constellio/dl?id=00000613671
2.8
  • Accounting with the import options "cellRange" and "keepExtraWhitespace".
  • Improved stability.
10.0.3+https://internal.constellio.me/constellio/dl?id=00000527379
2.7
  • Accounting with version 10.
  • Improved error messages.
10.0.3+https://internal.constellio.me/constellio/dl?id=00000527061
2.6.1
  • Added the "import.withConnexionTimeout" configuration. to allow the connection to never expire during uploading.
9.2https://internal.constellio.me/constellio/dl?id=00000608671
2.6
  • Increased login 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



Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
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.