admin:websites-import-users [Aardvark Technologies Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== User import using CSV file ======
Our platform facilitates seamless integration for client onboarding and promotional campaigns by providing a CSV import functionality. This tool is designed for two primary purposes:

  * **User Migration:** Effortlessly transition user accounts from existing systems or databases to our platform without disruption. With this feature, you can upload multiple user details simultaneously, ensuring a smooth migration process.

  * **Bulk Promotional Credit Assignment:** Streamline the process of granting promotional balances to a large group of users. This method simplifies the administrative task of applying promotional credits by processing them in bulk.

==== Getting Started with CSV Import ====
To utilize the CSV import feature, admins can upload a CSV file containing all the necessary data as outlined below. This process creates new user accounts, pre-fills wallet balances, and applies promotional credits as specified.

----

==== Import File Example ====
Attached is a sample import file pre-filled as a reference: {{ :admin:user_import_row.csv |}}

Ensure you remove the example user data from the file before uploading your user data to prevent any accidental imports.

----

==== Detailed Field Descriptions for User Import CSV File ====
Below is an explanation of each field in the user import CSV file. Please fill out the columns as described. Mandatory fields must be completed for the import to be successful.

  - **Email (Mandatory):** The user's email address. This must be a valid email format (e.g., user@example.com) and is required to uniquely identify a user account.
  - **DisplayName (Mandatory):** The name displayed within the platform for the user. This field cannot be left blank.
  - **Phone (Optional/Mandatory if set in Administrator settings):** The user's phone number. This should be entered in international format without the “+” symbol.
  - **DateOfBirth (Optional):** The user's date of birth in the format YYYY-MM-DD.
  - **Country (Optional):** The user's country of residence.
  - **Region (Optional):** The region, state, or province within the country where the user resides.
  - **City (Optional):** The city or locality of the user.
  - **LineOne (Optional):** The first line of the user's address.
  - **LineTwo (Optional):** The second line of the user's address.
  - **PostalCode (Optional):** The user's postal or ZIP code.
  - **IDType (Optional):** The type of identification document provided by the user: passport, iddocument, license (driver’s license).
  - **IDCode (Optional):** The identification number of the provided document.
  - **InitialBalance (Optional):** The initial balance to be credited to the user's wallet. Please ensure this is a number.
  - **InitialPromoBalance (Optional):** The promotional balance to be added to the user's account, if any.
  - **LocStatus (Optional):** This is a status code representing the user's location verification status. Use 'a' to indicate an approved location. If left empty, the location status will default to 'new,' indicating that it has not been reviewed or approved yet.
  - **IDStatus (Optional):** This field denotes the verification status of the user's identification. Enter 'a' for approved identification. If this field is left blank, the system will automatically mark the ID status as 'new,' suggesting that the identification needs to be reviewed or is pending approval.
  - **Password (Optional):** The user's account password. If left empty, random will be generated and sent to user email/phone after import.
  - **AddPromo (Optional):** This field allows you to add an extra amount of promotional credit to the user's account, typically used to apply promotions to multiple users in bulk. If both 'InitialPromoBalance' and 'AddPromo' are specified, the user's account will reflect two separate transactions. Please be aware that if a user is imported multiple times, the promotional credit from this 'AddPromo' field will be applied each time, resulting in multiple credits.
  - **NoEmailNotification (Optional):** This should be set to TRUE if you do not wish to send an initial welcome email to the user. Otherwise, set to FALSE or leave empty to send the email. Please note, if the password field is left blank, a random password will be generated and included in this email. If the initial email is not sent and the password field was blank, the user will need to utilize the Account Recovery feature to set their password.

----

==== Reading the results ====
If you upload a valid CSV file, you can expect one of several outcomes that will indicate the success of the import process. After uploading, reload the **'users-import'** page. If a new line appears with the state **'Done'**, it means all users have been imported successfully. If the state reads **'Done with errors'**, there were issues with some entries. In this case, you can download a report which will detail the errors at the end of each affected line.

----

==== Notifying the user ====
A random password is generated for the user and an email and sms are sent out to him regarding his account import. These messages can be edited in the admin's page by updating the: **ImportSms** and **ImportEmail** messages. Passwords are not required to include in both of them, but make sure you include it in at least one message (either email or sms) so that the user can actually login.

The passwords are generated and never stored anywhere, so if the user did not get his password the only way to actually log in for him is to use Account Recovery and change his password using his email or phone number when he visits the website.

Keep in mind, if **NoEmailNotification** field was set to **TRUE**, user will not get this email.