Skip to content
English
  • There are no suggestions because the search field is empty.

Importing reviews to Elevo deployment

This article is intended for administrators.

To facilitate the centralization of your employees' reviews, you can import the personal reviews carried out in another tool before launching the platform.

It is possible to import only the information associated with the review (review title, review date, associated tag, etc.), or to import the review's PDF so that it is available directly on Elevo.

1️⃣ Setting up the import

The protocol used is SFTP (SSH File Transfer Protocol). Sessions must be established by you, whether it involves sending or receiving data. You will have a dedicated account, secured by an SSH key that you will have provided us. Elevo verifies that the login request originates from the company using an identification/authentication mechanism, which is performed using the encryption key. Additionally, a network whitelisting of the company outbound IPs is necessary.

The connection details to the SFTP server (domain name, port and username) will be provided by support@elevo.io. Once the connection is established, the files must be uploaded to the "/uploads/users" folder.

Contact our support@elevo.io with the following information:

  • a technical contact,
  • the IP address or a range of IP addresses you will use to connect to our gateway,
  • an SSH public key that you will use to connect.

Elevo support will then provide you with:

  • your login details for our SFTP server,
  • our public GPG key to cipher the files before upload (optional),
  • confirmation that Elevo is ready to process files for synchronization.

2️⃣ Additional information about SFTP

💪🏼 Supported algorithms

KexAlgorithms diffie-hellman-group-exchange-sha256,curve25519-sha256@libssh.org,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512
Ciphers diffie-hellman-group-exchange-sha256,curve25519-sha256@libssh.org,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512
MACs hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-128-etm@openssh.com
HostKeyAlgorithms ssh-ed25519,ssh-ed25519-cert-v01@openssh.com,sk-ssh-ed25519@openssh.com,sk-ssh-ed25519-cert-v01@openssh.com,rsa-sha2-256,rsa-sha2-512,rsa-sha2-256-cert-v01@openssh.com,rsa-sha2-512-cert-v01@openssh.com

🗒 Correspondence file format

The name of the file must be import.csv The file must respect the following constraints:

  • Respect the CSV format RFC 4180,
  • Be encoded in UTF-8 format,
  • The first row should define the column headers,
  • Must contain all mandatory columns,
  • May not contain optional columns,
  • Unrecognized columns will be ignored,
  • The columns can be in any order.

Columns in the CSV file

Column header

Mandatory / Optional

Restrictions

Detail

login

Mandatory

Character strings

Must be unique across all users

Unique identifier for a user:
Either the user's email
Or the user's username

review_date

Mandatory

In ISO 8601 format (ex: 2015-02-25)

Review date

review_title

Mandatory

Character strings

Title of the review that will be displayed in the Elevo interface

The name will be converted to Proper Case (each word starts with a capital letter)

tags

Optional

Character strings, if several tags are entered, they must be separated by a semicolon ";"

Keyword used to identify a review according to certain criteria ("Annual Review" for example).

Adding one or more tags to a campaign

-

Ensuring review conformity using Audit Reports

has_pdf Optional "true" or "false" (Boolean)

Indicate whether or not the review is associated with a pdf file to be imported.

file_name

Mandatory if "true" is specified in the "has_pdf" column

Character strings

Must be unique and match the name of one of the files to import.

Name of the file to be imported (with the file extension but without the path)

Make sure not to include accents or special characters in the title of the files to be imported ⛔️

3️⃣ Preparing to import historical reviews.

To import your users' past reviews into Elevo, you'll need to provide us with the PDF files to import and a matching file.

  1. Get the template of the correspondence file on this link,
  2. Optional : Prepare the files to be imported in PDF format with a maximum size of 1Mb + Make sure not to include accents or special characters in the title of the files to be imported ⛔️.
  3. Fill in the correspondence file with the information concerning the maintenance to be imported according to the specifications listed below in the article,
  4. The files will be transmitted via our dedicated Elevo SFTP.

4️⃣ Importing files via SFTP

1) Upload your files to our SFTP :

  • The correspondence file is in CSV format and named: import.csv in the folder /uploads/imported_reviews
  • Optional: The pdf files associated with the reviews have to be imported into a subfolder /uploads/imported_reviews/files/

2) Send an email to support@elevo.io to inform us that the import is ready to be launched.

3) The import will be launched by the Elevo team:

  • The import.csvfile will be read line by line (each line corresponding to the import of a file)
  • The results of the import will be visible in the /reports/imported_reviews/ folder
      1. In case of a successful import of a file, the corresponding line will be copied to the file /reports/imported_reviews/DATETIME_import_successes.csv
      2. If the import of a file fails, the corresponding line will be copied in the file /reports/imported_reviews/DATETIME_import_failures.csv with the reasons for the failure (see "types of errors during import")

4) The Elevo team will send you a notification when the import is complete.

  • You will be able to view the import report in the /reports/imported_reviews/ folder.
  • The import.csv file will be archived in the /archived/imported_reviews/DATETIME_import.csv folder
  • The files will remain in the /uploads/imported_reviews/files/ folder

What if I have error lines?

1) Identify the affected rows and the cause of the error using the file /reports/imported_reviews/DATETIME_import_failures.csv

2) Correct errors related to the correspondence file and/or imported files

  1. If your errors concern the correspondence table, correct the file, name it: import.csv, and put it in the /uploads/imported_reviews folder
  2. If your errors concern the files to be imported, add the new files in the subfolder /uploads/imported_reviews/files/ (and have them replaced if necessary)

🙅🏻 Import error types

You will find below the list of possible errors. They are visible in the file /reports/imported_reviews/DATETIME_import_failures.csv .

Error message

Type of error

Resolution

Missing value for 'login'.

The login is missing

Add the user's login

Missing value for 'file_name

The .pdf file is not filled in

Indicate the corresponding .pdf file

Missing value for 'review_date'.

The date of the review is not filled in

Enter the date of the review in ISO 2021/12/01 format

Unauthorized file type: 'filename.png' must be a .pdf file

The file format is not in .pdf format

Change the file format to pdf and indicate this in the correspondence file

Unable to read the file name.from.file.png

The file does not exist or is unreadable

Indicate the corresponding .pdf file

file.name.png' is too big (XX Mb > 1 Mb)

The file is too big and exceeds the 1Mb allowed

Reduce the size of the file to below 1 MB

The user jean.dupont@gmail.com was not found

The user does not exist

Correct the user's login if this person exists

 

5️⃣ Import completed

Once you are satisfied with the results of the import, send us an email at support@elevo.io and we will remove all the content on the SFTP.

🙋🏻‍♂️ Questions

➡️ What happens in the interface if I don't enter a title?

If you are not importing an associated file, the review title is mandatory. If you are importing an associated file, then the default name will be the imported file's title. Example: "John Smith - 2020 annual review".

➡️ What types of files are accepted?

Only PDF files with a maximum size of 1 MB.

➡️ What happens if I add an extra column in the import file?

The column will be ignored during the import and will not cause an error.

➡️ What happens if there is no failed line during the import?

The DATETIME_import_failures.csv file will be empty.

➡️ Can I have a file that mixes lines with and without a pdf document?

Yes, no problem. Just make sure you fill in the "has_pdf" column correctly in this case.

➡️ Can tags be added to previous imports of past reviews?

Yes, but to do so you'll need to supply a csv file (see template in the article, or use the one used at the time) and add the associated tags in the corresponding column. It is absolutely essential that the names of past reviews are strictly identical, to avoid creating duplicates.