You are here

README.txt in User Import 5.2

********************************************************************
                     D R U P A L    M O D U L E
********************************************************************
Name: user import module
Author: Robert Castelo <www.cortextcommunications.com>
Drupal: 5.x
********************************************************************
DESCRIPTION:

Import users into Drupal from a csv file (comma separated file).

Features include:

* Creates an account for each user.
* Match csv columns to profile fields.  
* Can optionally use the file's first row to map csv data to user profile fields.
* Option to create Usernames based on data from file, e.g. "John" + "Smith" => "JohnSmith".
* Usernames can be made of abbreviated data from file, e.g. "Jane" + "Doe" => "JDoe".
* Option to create random, human readable, Usernames.
* Option to import passwords
* Option to create random passwords for each user.
* Can set user roles.
* Option to send welcome email, with account details to each new user.
* Can set each user's contact form to enabled
* Test mode option to check for errors.
* Processing can be triggered by cron or manually by an administrator.
* Can stagger number of users imported, so that not too many emails are sent at one time.
* Multiple files can be imported/tested at the same time.
* Import into Organic Groups
* Option to make new accounts immediately active, or inactive until user logs in
* Use CSV file already uploaded through FTP (useful for large imports)
* Designed to be massively scalable.

Supported CSV File Formats:

Make sure csv file has been saved with 'Windows' line endings.
If file import fails with "File copy failed: source file does not exist." try
setting the file extension to .txt.


********************************************************************
PREREQUISITES:

  Must have customized Profile fields already entered 
  if data is to be imported into user profiles.


********************************************************************
INSTALLATION:

Note: It is assumed that you have Drupal up and running.  Be sure to
check the Drupal web site if you need assistance.

1. Place the entire user_import directory into your Drupal directory:
   sites/all/modules/
   

2. Enable the user_import modules by navigating to:

   administer > build > modules
     
  Click the 'Save configuration' button at the bottom to commit your
  changes.
  
  
********************************************************************
USAGE

1. To set permissions of who can import users into the site, navigate to:

'Administer' 
    -- 'User management'
        -- 'Access control' (admin/user/access)
    

2. To import users, navigate to:

'Administer'
    -- 'User management'
        -- 'User imports'  (admin/user/user_import)
        
3. Select 'Import' tab (admin/user/user_import/add)

4. Press the 'browse' button to select a file to import,
    or select a file already added through FTP.

5. Click on Next.

6. Under CSV file you should see the name of the file you just uploaded.

7. Under Options you should see Ignore First Line ( use if the first row are labels ), 
    
    Contact, and Send Email.  Select whichever is appropiate.

8. Under Field Match you should see the various columns from your profile page.

9. For each csv column select a Drupal field to map. 

10. Under username select 'No', if the field is not to be used to generate the username, or select '1' - '4' 
    for the order to use the field in generating username.

    Example: 'LastName' and 'FirstName' are fields to be used as username.  So under the username
    selection chose '1' for 'FirstName' and '2' for 'Lastname', and the username generated will be in 
    the form 'FirstNameLastName'.

11. Under Role Assign select the roles the imported users will be assigned.

12. Under Save Settings, you can save your settings for use on future imports.

13. Click "Test" to do an import without committing changes to the database.  Fix any errors that are generated.

14. Click "Import" to complete the import.


********************************************************************
AUTHOR CONTACT

- Report Bugs/Request Features:
   http://drupal.org/project/user_import
   
- Comission New Features:
   http://drupal.org/user/3555/contact
   
- Want To Say Thank You:
   http://www.amazon.com/gp/registry/O6JKRQEQ774F

        
********************************************************************
ACKNOWLEDGEMENT

- Initial reference point for this module was a script by David McIntosh (neofactor.com).


- Documentation help Steve (spatz4000)
- patch by mfredrickson
- patch by idealso
- code from Nedjo Rogers

File

README.txt
View source
  1. ********************************************************************
  2. D R U P A L M O D U L E
  3. ********************************************************************
  4. Name: user import module
  5. Author: Robert Castelo
  6. Drupal: 5.x
  7. ********************************************************************
  8. DESCRIPTION:
  9. Import users into Drupal from a csv file (comma separated file).
  10. Features include:
  11. * Creates an account for each user.
  12. * Match csv columns to profile fields.
  13. * Can optionally use the file's first row to map csv data to user profile fields.
  14. * Option to create Usernames based on data from file, e.g. "John" + "Smith" => "JohnSmith".
  15. * Usernames can be made of abbreviated data from file, e.g. "Jane" + "Doe" => "JDoe".
  16. * Option to create random, human readable, Usernames.
  17. * Option to import passwords
  18. * Option to create random passwords for each user.
  19. * Can set user roles.
  20. * Option to send welcome email, with account details to each new user.
  21. * Can set each user's contact form to enabled
  22. * Test mode option to check for errors.
  23. * Processing can be triggered by cron or manually by an administrator.
  24. * Can stagger number of users imported, so that not too many emails are sent at one time.
  25. * Multiple files can be imported/tested at the same time.
  26. * Import into Organic Groups
  27. * Option to make new accounts immediately active, or inactive until user logs in
  28. * Use CSV file already uploaded through FTP (useful for large imports)
  29. * Designed to be massively scalable.
  30. Supported CSV File Formats:
  31. Make sure csv file has been saved with 'Windows' line endings.
  32. If file import fails with "File copy failed: source file does not exist." try
  33. setting the file extension to .txt.
  34. ********************************************************************
  35. PREREQUISITES:
  36. Must have customized Profile fields already entered
  37. if data is to be imported into user profiles.
  38. ********************************************************************
  39. INSTALLATION:
  40. Note: It is assumed that you have Drupal up and running. Be sure to
  41. check the Drupal web site if you need assistance.
  42. 1. Place the entire user_import directory into your Drupal directory:
  43. sites/all/modules/
  44. 2. Enable the user_import modules by navigating to:
  45. administer > build > modules
  46. Click the 'Save configuration' button at the bottom to commit your
  47. changes.
  48. ********************************************************************
  49. USAGE
  50. 1. To set permissions of who can import users into the site, navigate to:
  51. 'Administer'
  52. -- 'User management'
  53. -- 'Access control' (admin/user/access)
  54. 2. To import users, navigate to:
  55. 'Administer'
  56. -- 'User management'
  57. -- 'User imports' (admin/user/user_import)
  58. 3. Select 'Import' tab (admin/user/user_import/add)
  59. 4. Press the 'browse' button to select a file to import,
  60. or select a file already added through FTP.
  61. 5. Click on Next.
  62. 6. Under CSV file you should see the name of the file you just uploaded.
  63. 7. Under Options you should see Ignore First Line ( use if the first row are labels ),
  64. Contact, and Send Email. Select whichever is appropiate.
  65. 8. Under Field Match you should see the various columns from your profile page.
  66. 9. For each csv column select a Drupal field to map.
  67. 10. Under username select 'No', if the field is not to be used to generate the username, or select '1' - '4'
  68. for the order to use the field in generating username.
  69. Example: 'LastName' and 'FirstName' are fields to be used as username. So under the username
  70. selection chose '1' for 'FirstName' and '2' for 'Lastname', and the username generated will be in
  71. the form 'FirstNameLastName'.
  72. 11. Under Role Assign select the roles the imported users will be assigned.
  73. 12. Under Save Settings, you can save your settings for use on future imports.
  74. 13. Click "Test" to do an import without committing changes to the database. Fix any errors that are generated.
  75. 14. Click "Import" to complete the import.
  76. ********************************************************************
  77. AUTHOR CONTACT
  78. - Report Bugs/Request Features:
  79. http://drupal.org/project/user_import
  80. - Comission New Features:
  81. http://drupal.org/user/3555/contact
  82. - Want To Say Thank You:
  83. http://www.amazon.com/gp/registry/O6JKRQEQ774F
  84. ********************************************************************
  85. ACKNOWLEDGEMENT
  86. - Initial reference point for this module was a script by David McIntosh (neofactor.com).
  87. - Documentation help Steve (spatz4000)
  88. - patch by mfredrickson
  89. - patch by idealso
  90. - code from Nedjo Rogers