Importer
Elephant Importer API provides a way of loading data into modules implementing ImporterProvider.
Importers can add to the existing data or fully replace it. The importer front-end shows this option as Full import.
Provider sources
By default, data sources are CSV files uploaded into a provider. The API deals with the usual CSV formats, including differences among operating systems.
Currently accepted data sources are:
|
Name |
Description |
File extension |
|
CSV |
Comma Separated Values |
cvs |
|
TDF |
Tab-Delimited Format |
tdf |
Sources must include a first row with headers. The importer will use those headers to map columns to actual fields.
Providers
Alliance Contact Provider
Imports data into Alliance Contacts. The accepted fields are:
|
Field |
Description |
Required |
|
contactId |
Contact ID as in the internal member system. |
|
|
name |
Contact name. |
|
|
|
Contact email, used for notifications and authentication. |
|
|
pass |
Contact password bytes retrieved with UTF-8 encoding, digested using SHA3-256 and converted to an hexadecimal string. |
|
|
deactivated |
True if the contact is deactivated. Prevents this contact from authenticating and asking for participating in projects. Default is |
|
|
face |
URL to the contact profile image. |
|
|
company |
Contact's company name. |
|
|
position |
Contact's position in company. |
|
|
companyFace |
URL to the company logo image. |
Alliance Project Provider
Imports data into Alliance Projects. The accepted fields are:
|
Field |
Description |
Required |
|
projectId |
Project ID as in the internal member system. |
|
|
creation |
Project creation date using |
|
|
phaseIndex |
Phase index as in the alliance set of phases. |
|
|
projectCode |
Project code. |
|
|
name |
Project name. |
|
|
summary |
Project summary, usually a brief description of project's goal. |
|
|
categoryId |
Category ID as in the alliance collection of categories. |
|
|
source |
URL to the original project. |
Alliance Participation Provider
Imports data into Alliance Participations. The accepted fields are:
|
Field |
Description |
Required |
|
projectId |
Project ID as in the internal member system. |
|
|
contactId |
Contact ID as in the internal member system. |
|
|
creation |
Project creation date using |
|
|
admin |
True if contact is this project administrator. |
|
|
beneficiary |
True if contact is beneficiary of this project. |
|
|
consortium |
True if contact is part of a consortium within this project. |
|
|
coordinator |
True if contact is coordinator of this project. |
|
|
driver |
True if contact is driver of this project. |
|
|
funding |
True if contact does funding on this project. |
|
|
offerer |
True if contact is offerer of this project. |
|
|
research |
True if contact is part of this project research. |
|
|
support |
True if contact is part of this project support |
|
|
company |
Contact's company name. This company may differ from current contact company and should be related to creation date. |
|
|
companyFace |
URL to the company logo image. |
Alliance Tag Provider
Imports data into wide-application Tags API. The accepted fields are:
|
Field |
Description |
Required |
|
tag |
Tag name. |
|
|
entityId |
Project ID as in the internal member system. |
|
