- Print
- DarkLight
- PDF
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.
Version | New features | Supported version of Constellio | Download |
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
- Import the Import Client
- Extract files from the import client
- Generate the import client configuration file
- Extract downloaded configuration files
- Replace the configuration file in the "configurations" directory of the import client"
- 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;
- Go to Administration;
- Click on Import Records;
- Click on Import Tool Configuration;
- Complete Export/Import Configuration fields
- If necessary, complete the Advanced Configurations
- Generate the import client configuration file
- Extract the "importClientProperties" file
- Cut the contents of the file
- Open the "configurations" folder of the import client
- Paste previously cut content to replace files
- The import client is now ready to use.
2.2.1 Export/Import Configuration
Element | Description |
---|---|
Import Collection | Specify which collection the records will be imported into. |
Default administrative unit | Specify the default administrative unit entered in the import file. |
Topic Detection Type | Indicate how the classification plan topics will be entered into the import file
|
2.2.2 Advanced Configurations
Element | Description |
---|---|
Ignore missing files when uploading files | Allows 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 waiting | A file will not be imported if there is more than 5 minutes of waiting. |
Authentication Type | Allows you to choose how the user will be authenticated in Constellio when using the Import Client. |
File Extensions to Ignore | Allows 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
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
Version | New features | Supported version of Constellio | Download |
2.10.1 |
| 11.1.8+ | https://internal.constellio.me/constellio/dl?id=00000987372 |
2.10 |
| 11.1.8+ | https://internal.constellio.me/constellio/dl?id=00000906232 |
2.9 |
| 10.0.3+ | https://internal.constellio.me/constellio/dl?id=00000613671 |
2.8 |
| 10.0.3+ | https://internal.constellio.me/constellio/dl?id=00000527379 |
2.7 |
| 10.0.3+ | https://internal.constellio.me/constellio/dl?id=00000527061 |
2.6.1 |
| 9.2 | https://internal.constellio.me/constellio/dl?id=00000608671 |
2.6 |
| 9.2+ 9.1.0.7 8.2.1.96 | Constellio-importExportScript_v2.6.zip |
2.5 |
| 9.2+ 9.1.0.7 8.2.1.969 | Constellio-importExportScript_v2.5.zip |
2.4.1 |
| 9.2+ 9.1.0.7 8.2.1.969 | Constellio-importExportScript_v2.4.1.zip |
2.3.1 |
| 9.1 8.2.1.968 | Constellio-importExportScript_v2.3.1.zip |