Applicant Import

Applicant Import

The applicant import is an open source command line tool and can be found at https://github.com/eRecruiter/eRecruiter.ApplicantImport.

Format

The input file must be a tab-separated ("\t") Textfile in UTF8 format. The rows are separated by new line and the columns are separated by tab. You can generate the input file with e.g. Microsoft Excel => Export => Change file type (*.csv). The first row must have the name of the columns to be able to map the columns to the appropriate applicant properties.
The import allows columns to have multiline values. The multiline values should be separated by usual CR, LF (\n\r) characters and must be enclosed in quotation marks ("). Microsoft Excel generates this format automatically when exporting to an Tab-separated value (TSV) file.

Not supported characters

The quotation mark (") is not allowed in a value, because it encloses column values with multiline values.

Required fields

The import file must contain the columns FirstName, LastName.

Possible columns


Column type
Name
Possible values / Input format / additional information

Gender

Gender

male: "H", "M", "Herr", "Mr", "1" / female: "F", "W", "Frau", "Ms.", "Mrs.", "0"

FirstName

First name

must never be empty

LastName

Last name

must never be empty

Title

Title

based on the mandator settings "title before name" or "title after name" is automatically set correctly.

Email
E-mail address
must be a valid email-adress
Phone
Phone number

MobilePhone
Mobile phone

Street
Street (address)

ZipCode
ZIP code

City
City (address)

Country
Country (address)
must be an existing value to be valid
Nationality
Nationality (citizenship)
must be an existing value to be valid
Birthdate
Date of birth
use  DateFormat  to specify the date format, default is  yyyy-MM-dd
Cv
CV
must be empty or a path to an existing file. allowed file extensions are: "doc", "docx", "pdf", "txt", "rtf", "odt", "xls", "xlsx"

Photo

Photo

must be empty or a path to an existing file. allowed file extensions are: "jpg", "jpeg", "png", "bmp"

Document

Document

must be empty or a path to an existing file (to import single file) or directory (to import all files in directory). Also, configuration for  SubType  is required to specify the applicant document type. the document type must be an existing value to be valid.

JobProfile

Job profile

must be an existing value to be valid

Region
Region
must be an existing value to be valid

BeginDate

Earliest possible begin date

use  DateFormat  to specify the date format, default is  yyyy-MM-dd

Id
Applicant identifier
This is actually a "magic column". If it is specified (and contains a valid applicant #), existing applicants will be updated instead of newly created. This is very handy if you want to bulk-add information to already existing applicants.
CareerLevel
Career level
must be an existing value to be valid

Referrer

Bewerberquelle

must be an existing value to be valid

ReferrerAdditionalInfo
Referrer additional information
if present, a column for  Referrer  must be present as well

Knowledge

Knowledge

configuration for  SubType  is required to specify the knowledge. must be an existing value to be valid.

CreationDate

Date of creation


use  DateFormat  to specify the date format, default is  yyyy-MM-dd.

If none is provided, the current time of creation in the database is used.


ImportantInfo
Important information (about applicant)

If present the current date and time is used for the date of this information.

Classification

Classification

must be an existing value to be valid. If present the classification date is set with the current date & time.

ClassificationReason
Classification reason
if present, a column for  Classification  must be present as well.

CustomField

Custom field

configuration for  SubType  is required to specify the custom field. Also, configuration for  DateFormat  is supported (if custom field is of type  Date ).


If custom field type is CheckBox the allowed value for true is "X" and for nothing for false.
If type is CheckboxList the values must be split by commas ",".


History

History entry

Ignore
Ignore
Specifically configure columns that should be ignored at all

Matching of columns

The column names in the first row (header row) of the input file must be mapped to the appropriate column type in a configuration file. This configuration file is a JSON file and must contain the API connection settings and the column mappings like in the code block below.
configuration.json file
{
 
    Api: {
 
        Endpoint: "< your_API_endpoint >",
 
        MandatorId: < your_mandator_ID >,
 
        Key: "< your_API_key >"
 
    },
 
     
 
    Columns: [
 
        {
 
            Header: "#",
 
            Type: "Id"
 
        },
 
        {
 
            Header: "Geschlecht",
 
            Type: "Gender"
 
        },
 
        {
 
            Header: "Vorname",
 
            Type: "FirstName"
 
        },
 
        {
 
            Header: "Nachname",
 
            Type: "LastName"
 
        },
 
        {
 
            Header: "Titel",
 
            Type: "Title"
 
        },
 
        {
 
            Header: "E-Mail",
 
            Type: "Email"
 
        },
 
        {
 
            Header: "Telefon",
 
            Type: "Phone"
 
        },
 
        {
 
            Header: "Handy",
 
            Type: "MobilePhone"
 
        },
 
        {
 
            Header: "Straße",
 
            Type: "Street"
 
        },
 
        {
 
            Header: "PLZ",
 
            Type: "ZipCode"
 
        },
 
        {
 
            Header: "Ort",
 
            Type: "City"
 
        },
 
        {
 
            Header: "Land",
 
            Type: "Country"
 
        },
 
        {
 
            Header: "Staatsbürgerschaft",
 
            Type: "Nationality"
 
        },
 
        {
 
            Header: "Geburtsdatum",
 
            Type: "Birthdate",
 
            DateFormat: "dd.MM.yyyy"
 
        },
 
        {
 
            Header: "Lebenslauf",
 
            Type: "Cv"
 
        },
 
        {
 
            Header: "Foto",
 
            Type: "Photo"
 
        },
 
        {
 
            Header: "Zeugnisse",
 
            Type: "Document",
 
            SubType: "Zeugnis"
 
        },
 
        {
 
            Header: "Anschreiben",
 
            Type: "Document",
 
            SubType: "Anschreiben"
 
        },
 
        {
 
            Header: "Berufsprofil 1",
 
            Type: "JobProfile"
 
        },
 
        {
 
            Header: "Berufsprofil 2",
 
            Type: "JobProfile"
 
        },
 
        {
 
            Header: "Dienstregion 1",
 
            Type: "Region"
 
        },
 
        {
 
            Header: "Dienstregion 2",
 
            Type: "Region"
 
        },
 
        {
 
            Header: "Einstiegsdatum",
 
            Type: "BeginDate",
 
            DateFormat: "dd.MM.yyyy"
 
        },
 
        {
 
            Header: "Karrierelevel",
 
            Type: "Careerlevel"
 
        },
 
        {
 
            Header: "Bewerberquelle",
 
            Type: "Referrer"
 
        },
 
        {
 
            Header: "Bewerberquelle (Zusatzinformation)",
 
            Type: "ReferrerAdditionalInfo"
 
        },
 
        {
 
            Header: "Kenntnis C#",
 
            Type: "Knowledge",
 
            SubType: "C#"
 
        },
 
        {
 
            Header: "Kenntnis Java",
 
            Type: "Knowledge",
 
            SubType: "Java"
 
        },
 
        {
 
            Header: "Überflüssige Information",
 
            Type: "Ignore"
 
        },
 
        {
 
            Header: "Erstellungsdatum",
 
            Type: "CreationDate",
 
            DateFormat: "dd.MM.yyyy"
 
        },
 
        {
 
            Header: "Wichtige Zusatzinformation",
 
            Type: "ImportantInfo"
 
        },
 
        {
 
            Header: "Klassifizierung",
 
            Type: "Classification"
 
        },
 
        {
 
            Header: "Klassifizierung (Begründung)",
 
            Type: "ClassificationReason"
 
        },
 
        {
 
            Header: "Sperrvermerk",
 
            Type: "CustomField",
 
            SubType: "Sperrvermerk"
 
        },
 
        {
 
            Header: "Interne Anmerkung",
 
            Type: "CustomField",
 
            SubType: "Interne_Anmerkung"
 
        },
 
        {
 
            Header: "Internes Datum",
 
            Type: "CustomField",
 
            SubType: "Internes_Datum",
 
            DateFormat: "dd.MM.yyyy"
 
        }
 
    ]  
 
}

Duplicates

Not possible with this applicant import.

Import

When importing an applicant a history entry with type "Editing" and subject "Applicant updated" is created.
When importing more than 30.000 applicants, please inform our support.



    • Related Articles

    • API - Applicant

      Prerequisites It's required to be authenticated to use the following methods. Furthermore, an API token with "Applicants" access level is mandatory. Applicant profile Essentially an applicant profile consists of basic  claim data . More Data can be ...

    • Applicant Export

      The eRecruiter support a XML feed that allows to export applicants to other systems based on either applicant ID, a search query or applicant status. The feed allows simple pagination and can be configured for the data that is required by the ...

    • Company Import

      The company import is available through a wizard in the eRecruiter backend (.../Modules/Import/Companies) if you have the permissions to import data. General data structure One account has many locations. One location can have none, one or more ...

    • API - Company Import / Synchronize

      The XML company import is available through an endpoint on the eRecruiter API, if you have the "Companies" access level granted for your API key. General data structure One account has many locations. One location can have none, one or more contacts. ...

    • E-Mail Import (POP3-Postfach)

      E-Mails, die im Postfach eingehen, können schnell und bequem in den eRecruiter geladen werden. Sowohl der E-Mailtext als auch eventuell angehängte Dateien werden übernommen und können entweder einem bestehenden Bewerber oder einem neuen Bewerber, ...