Example of using the import client
  • 20 Oct 2022
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Example of using the import client

  • Dark
    Light
  • PDF

Article summary

1. Preparation

  1. Download the latest version of the import client compatible with the version of your Constellio environment from the following page "Client d'importation";
  2. Extract the contents of the downloaded zip fileGraphical user interface, text, application Description automatically generated

2. Configuring the Import Client

  1. Navigate to the " configurations " folder and then open the " config.properties " file in a text editor;
  2. Edit the values of the parameters " server.port " and " server.host " and enter the information of your Constellio environment;
    If your environment is in HTTPS, you must also set the configuration " auth.connectUsingSSL " to true; 
    For example, for a Constellio environment accessible at https://client.cloud.constellio.com/constellio/ on port 443, the configuration file should be configured as follows: 
  1. Enter the code of the Constellio collection into which the records are to be imported in the " import.collection " parameter
  2. Other import and export settings can also be changed directly in the configuration file, but it is recommended to enter them directly in the import client (Detailed in sections 4 and 5)


3. Start the import client

  1. Open the " start-program.bat " file to start the import program;Graphical user interface, text, application Description automatically generated
  2. Enter your Constellio username and password, then click on "Enter". This is the same login you use to connect to the Constellio web interface;Text Description automatically generated

Careful
For the "password" field, the characters entered are not displayed on the screen. 
  1. Once logged in, a main menu for accessing the two main functions of the program should be displayed. 

4. Generate an import template from a directory

  1. From the main menu, enter " 2 " to navigate to the network share export utility menu;
  2. Enter " 2 " to navigate to the configuration page. The current configurations will be displayed. If these seem correct, jump directly to step h;
  3.  Enter " 1 " to modify configurations;
  4. Enter the root path of the network share or directory you want to import into Constellio;A picture containing text Description automatically generated
  5. Enter the code of the administrative unit in which the imported files and documents are to be filed;
  6. If you want to use a regular expression to automatically detect folders in your network share that should match topics in Constellio, enter " " to select the " Use a regular expression " option;
  7. If you do not want to automatically detect topics, type " 2 " to select the " Use a default topic " option, then enter the code of the topic in which all folders/documents in your network share should be classified, then skip directly to step "i";
  8. Enter the regular expression that identifies the " pattern " of the title of your files;Graphical user interface, text, application, email Description automatically generated For example, in order for the following folders to be considered headings, the regular phrase "^[0-9]{2}-[0-9]{3} - .*" should be entered.


Careful
The fields must already exist in Constellio before importing.

i. Verify that all configurations are correct, then enter " 1 " to select " Generate Import File ";

j. Go to the directory where the file was generated and then open the file with Excel; Validate the information generated in the file. The "folder" tab corresponds to all the folders and subfolders in your directory and the "document" tab corresponds to all the files in your directory.
If necessary,  you can edit the values or add new metadata to this template before performing the import. 
See thegabarits d’importationpage  for more details.  


5. Import the generated template into Constellio

NOTE
Importing content can take quite a long time depending on the number of files to import and the speed of your network. Make sure you have a stable Internet connection before starting an import.

  1. From the main menu, enter " 1 " to navigate to the import utility page;Text Description automatically generated
  2. Enter " 2 " to register the import configurations. If the import has already been configured previously, skip directly to step f;
  3. A menu to define the source file and the temporary file is displayed. Enter " 1 " navigate to the " Set Source File " menu;Text Description automatically generated with medium confidence
Note
The second option allows you to define where for editing the Excel file is imported. You can usually skip this option.

d. Verify that the source file matches the template generated in step 4. If different, select " Use another file ", then enter the full path of the template to import;
Caution:  You must enter the full path of the file, including the name of the file and its extension.Text Description automatically generated with medium confidence

e. Enter " 3 " to return to the import utility menu;

f. Enter " 1 " to select the " Start importing content " option, then wait for the import to complete. 

 




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.