G2 Fall report names PaperCut #1 in Print

Choose your language

Choose your login

Contact us

Help Center menu

PRODUCT MANUALS

PaperCut NG & PaperCut MF Manual

PRODUCTS FEATURED

Batch import and update user data

The user data batch import and update feature allows the administrator to import users, user information and optionally update existing users details by reading data from a simple text file. It enables administrators to update the following user data:

  • Credit balance

  • Restriction status

  • Full name

  • Email address

  • Department

  • Office

  • Primary Card/ID Number

  • Card/ID PIN

  • Notes

  • Secondary Card/ID Number

  • Other email addresses

  • Username alias

  • Home folder

Examples of where the batch user details import feature is useful include:

  • To set the user email addresses that are stored in another system (like a student management system).

  • When importing user and balance data from another external or legacy system.

  • When moving user balances from previous PaperCut NG/MF editions to PaperCut NG/MF.

For more information on using the batch import to import data from previous PaperCut NG/MF editions, see Upgrade from PaperCut NG/MF Quota.

To perform a batch import:

  1. Create your import file in the prescribed tab-delimited format as detailed in the Batch User Import File Format section below. You can also download an example batch-user-example.tsv via the batch-user-example.zip here.

  2. Click the Users tab.
    The User List page is displayed.

  3. In the Actions menu, click Batch import.
    The Batch User Import and Update page is displayed.

  4. Click Browse to select the file to import. (The format of the file is described in the Batch User Import File Format section below).

  5. Choose whether you want the import to create new users if they do not already exist. If you clear this check box, lines that contain users who do not exist are ignored and only existing users are updated.

  6. Click Import.
    A message is displayed informing you of how many users were updated and how many users were created.

Batch user import file format

The import file is in tab delimited format and contains the following fields in the given order.

User Import File Format

No.FieldDescriptionOptional?Limitations
1.UsernameThe user's usernameMandatoryMax. 50 characters
2.Credit BalanceThe user's credit balanceOptional - balance not set if blankA number with no currency symbol or separators, using a full stop for the decimal separator. Correct: 1.23 Incorrect: $1.23 or 1,23 or 1,023.00
3.Restricted StatusThe user's restricted status. (Y/N)Optional - restricted status not set if blank 
4.Full NameThe user's full nameOptional - full name not set if blankMax. 255 characters
5.EmailThe user's email addressOptional - email not set if blankMax. 255 characters
6.DepartmentThe user's department or facultyOptional - department not set if blankMax. 200 characters
7.OfficeThe user's office or locationOptional - office not set if blankMax. 200 characters
8.Card/ID NumberThe user's primary identity/card numberOptional - card/id number not set if blankMax. 100 characters, case insensitive
9.Card/ID PINThe user's card PIN numberOptional - card/id PIN not set if blank. If the field is '-' then the PIN is set to zero.Max. 20 digits
10.NotesNotes about the user.Optional - notes not set if blankMax. 2000 characters
11.Secondary Card/ID NumberThe user's secondary identity/card numberOptional - secondary card/id number not set if blankMax. 100 characters, case insensitive
12.Other email addressesThe user's other email addressesOptional - other email addresses not set if blankEmail addresses must be separated by commas
13.Username aliasThe user's alias. Only useful if username aliasing is enabledOptional - alias not set if blankMax. 100 characters, case insensitive
14.Home folderThe user’s home folderOptional - required for scanning to a user’s home folder.Max. 256 characters

Other limitations: Although any actual limit to the size of an import file should be large enough for any purpose, we recommend keeping the file size below 10MB.

Import file format examples

The following lines show importing all the above fields. (The fields are separated by tabs).

Username Credit Balance Restricted Status Full Name Email Department Office Card/ID Number Card/ID PIN Notes Secondary Card/ID Number Other email addresses Username alias Home folder
matt 20.00 Y Matt Johnson mattj@email.com Science Dept Head office 103251 912254 NoteA 1234 matt@email.com matt
john 25.00 N John Jackson jj@domain.com Administration Other office 963254 123254 NoteB 4346 john@email.com jon

The following lines shows importing user email addresses only.

NOTE: That the tabs still exist for balance, restriction, full name fields, but each entry is blank.

Username Credit Balance Restricted Status Full Name Email Department Office Card/ID Number Card/ID PIN Notes Secondary Card/ID Number Other email addresses Username alias Home folder
matt Matt Johnson mattj@email.com
john John Jackson jj@domain.com

The following lines shows importing the credit balance and full name for the first user and the credit balance and email address for the second user.
NOTE: The tabs characters still exist for blank fields.

Username Credit Balance Restricted Status Full Name Email Department Office Card/ID Number Card/ID PIN Notes Secondary Card/ID Number Other email addresses Username alias Home folder
matt 20.00 Matt Johnson mattj@email.com 1500 jj@domain.com john

Sample import files

For more examples, refer to the following files in the install directory:

  • [server install]/server/examples/import/user/external/batch-user-example.tsv
    • This is used for Standard users (documented on this page)
  • [server install]/server/examples/import/user/batch-internal-user-example.tsv

Comments