netexCloud (FAQ) - CSV format for massive import of users

The header format will be the following:

Operation #op#,

Username #username#,

Name #name#,

E-mail #email#,

Surname #surname#,

Active #enabled#,

Password #password#,

Language #language#,

Time zone #timezone#,

Office phone #officePhone#,

Mobile phone #mobilePhone#,

Interests #interests#,

About me #aboutMe#,

Location #location#,

Welcome mail #welcomeMail#,

#googleanalytics#,

#lcloud#,

#lcentral#

The same file used for exporting users can be used as template for importing the users in the system. In that case, is important to meet the following conditions:

  • As the headers can be localized in different languages the basic user data will be get according its position in the CSV.
  • The role data must be located in the final CSV columns according to the following rules:
    • The header is the short name of the plattform. 
    • Its value will be a list (separated by commas) of valid roles in the plattform.
    • The cloud column will be the first column of existing roles (it's useful as marker).

The following table tries to summarize the meaning of each column and the possible values.

FIeld

Mandatory

Default value

Comments

Operation

No

S

  • S: Save operation
  • M: Merge with user data. Fields in blank will not be modified in the database.
  • D: Delete operation
  • If it's applied an operation which is not S, M or D, an error will appear an error informing about a incorrect operation. If the operation field is blank it will be understood S operation.

User name

Yes

Our key for searching the user (findOrSaveBy in grails)

Name

If S operation is set or o no operation is set

Email

If S operation is set or o no operation is set


Surname

If S operation is set or o no operation is set

Active

No

1 / true / on

If a value is set for this field, that will apply

If a value is not set and the operation is S or there is no operation set, it will apply the default value.

If a value is not set and the operation and the operation is M, the existing value will not be modified.

Password

If S operation is set or o no operation is set

Language

No

The customer language updated

If a value is set for this field, that will apply

If a value is not set and the operation is S or there is no operation set, it will apply the default value. (An error will appear if this field either customer is not set, because we could not deduce the language to apply).

If a value is not set and the operation and the operation is M, the existing value will not be modified.

Time Zone

No

The customer timezone updated

If a value is set for this field, that will apply

If a value is not set and the operation is S or there is no operation set, it will apply the default value. (An error will appear if this field either customer is not set, because we could not deduce the language to apply).

If a value is not set and the operation and the operation is M, the existing value will not be modified.

Office Phone

No

Mobile Phone

No

Interests

No

About me

No

Location

No

welcomeMail

No

false

If the operation is S or M and the value true, a welcome e-mail will be sent to the created/updated user.

lcloud

If S operation is set or o no operation is set

Separated by comma list of Cloud user roles to apply.

lcentral

No

Separated by comma list of Central user roles to apply.

lsocial

No

"Your Community" rol to apply

The following aspects must be taken into account to not produce errors:

  • M operation will modify only existing values. It will never modify blank fields. Also M operation will never set as blank an existing value.
  • S operation will modify the data in any case.
  • The D operation does not need more information than 'User Name', with that it will know which user to delete, and it will be deleted in all plattforms that the user exists. We must be careful trying to delete an user of a single plattform with this operation and the plattform in which we want to delete, because the user will be completely deleted. Deleting a user from a plattform should be done with M operation selecting all the plattforms except the one to eliminate.