You are here

Home » API reference » Users Export 8

README.txt in Users Export 8

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
#@codingStandardsIgnoreFile

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Troubleshooting
 * Maintainers


INTRODUCTION
------------

Provides a turn-key solution for exporting users in several different formats
included Excel, CSV, JSON, tab-delimitted, and XML.


REQUIREMENTS
------------

No special requirements


INSTALLATION
------------

Install as you would normally install a contributed Drupal module. See:
https://drupal.org/documentation/install/modules-themes/modules-8 for further
information.


CONFIGURATION
-------------

 * The functions of this module are given to users with the correct permissions.
   You can enable per-file-format permissions to user roles.

 * Per https://www.drupal.org/node/2824163, if the default export path defined
   by this module is in conflict for your website, you can alter it using
   [1]hook_menu_alter in a custom module. See users_export.api.php for an
   example.

   - Exporting:

     Visit admin/people/export, adjust your settings and click Download File.


   - Searching (views integration)

     If the views module is enabled this module ships with a view for searching
     users found at admin/people/find

   - API:
     Refer to users_export.api.php for api functions and hooks.


TROUBLESHOOTING
---------------

Large user counts will try to consume a good deal of memory and may exceed the 
PHP maximum execution time. In the advanced settings on the export form, you may
attempt to increase both of these values, but their efficacy is dependent upon
the security settings of your server.
You may have to alter these values at the server level if you continue to have
export problems with large numbers of users.

To test this you should enable the test mode and you will get a file of 10
users. If this works, but when unchecked, the export fails, you are most likely
running into limits of either memory or time.

MAINTAINERS
-----------

Current maintainers:
  * Aaron Klump (aklump) - https://www.drupal.org/user/142422

This project has been sponsored by:
 * Loft Studios

Contact:
 * In the Loft Studios
  * Aaron Klump - Developer
  * PO Box 29294 Bellingham, WA 98228-1294
  * aim: theloft101
  * skype: intheloftstudios
  * d.o: aklump
  * [2]http://www.InTheLoftStudios.com

References

 1. https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_menu_alter/7.x
 2. http://www.InTheLoftStudios.com/

File

README.txt
View source 
  1. #@codingStandardsIgnoreFile

  2. 

  3. CONTENTS OF THIS FILE

  4. ---------------------

  5. 

  6.  * Introduction

  7.  * Requirements

  8.  * Installation

  9.  * Configuration

  10.  * Troubleshooting

  11.  * Maintainers

  12. 

  13. 

  14. INTRODUCTION

  15. ------------

  16. 

  17. Provides a turn-key solution for exporting users in several different formats

  18. included Excel, CSV, JSON, tab-delimitted, and XML.

  19. 

  20. 

  21. REQUIREMENTS

  22. ------------

  23. 

  24. No special requirements

  25. 

  26. 

  27. INSTALLATION

  28. ------------

  29. 

  30. Install as you would normally install a contributed Drupal module. See:

  31. https://drupal.org/documentation/install/modules-themes/modules-8 for further

  32. information.

  33. 

  34. 

  35. CONFIGURATION

  36. -------------

  37. 

  38.  * The functions of this module are given to users with the correct permissions.

  39.    You can enable per-file-format permissions to user roles.

  40. 

  41.  * Per https://www.drupal.org/node/2824163, if the default export path defined

  42.    by this module is in conflict for your website, you can alter it using

  43.    [1]hook_menu_alter in a custom module. See users_export.api.php for an

  44.    example.

  45. 

  46.    - Exporting:

  47. 

  48.      Visit admin/people/export, adjust your settings and click Download File.

  49. 

  50. 

  51.    - Searching (views integration)

  52. 

  53.      If the views module is enabled this module ships with a view for searching

  54.      users found at admin/people/find

  55. 

  56.    - API:

  57.      Refer to users_export.api.php for api functions and hooks.

  58. 

  59. 

  60. TROUBLESHOOTING

  61. ---------------

  62. 

  63. Large user counts will try to consume a good deal of memory and may exceed the 

  64. PHP maximum execution time. In the advanced settings on the export form, you may

  65. attempt to increase both of these values, but their efficacy is dependent upon

  66. the security settings of your server.

  67. You may have to alter these values at the server level if you continue to have

  68. export problems with large numbers of users.

  69. 

  70. To test this you should enable the test mode and you will get a file of 10

  71. users. If this works, but when unchecked, the export fails, you are most likely

  72. running into limits of either memory or time.

  73. 

  74. MAINTAINERS

  75. -----------

  76. 

  77. Current maintainers:

  78.   * Aaron Klump (aklump) - https://www.drupal.org/user/142422

  79. 

  80. This project has been sponsored by:

  81.  * Loft Studios

  82. 

  83. Contact:

  84.  * In the Loft Studios

  85.   * Aaron Klump - Developer

  86.   * PO Box 29294 Bellingham, WA 98228-1294

  87.   * aim: theloft101

  88.   * skype: intheloftstudios

  89.   * d.o: aklump

  90.   * [2]http://www.InTheLoftStudios.com

  91. 

  92. References

  93. 

  94.  1. https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_menu_alter/7.x

  95.  2. http://www.InTheLoftStudios.com/