Batch User Import/Update Example .tsv files

AVAILABLE TO CUSTOMERS ON:

This article details the two bulk-import methods for users, and shows example .tsv (tab separated values) files for the batch-user import/update tools.

IMPORTANT: 💡 There are two very separate methods of bulk updating/importing users:

Standard Users - users managed by a sync source like Active Directory, LDAP - there is NO password field defined for this import method, since the password is managed externally.
Internal Users - users are managed by PaperCut, and the passwords are defined/managed within PaperCut - this template does have a password field defined.

Import method summary

Are you looking for the ‘password column’ in the import file where there doesn’t seem to be one? Or are you confused why you see a password column when you’re not expecting one? See below for the differences between ‘Standard’ and ‘Internal’ users - and the critical differences between the bulk import methods for both.

	Standard Users	Internal Users
Description	Passwords are managed by an external directory	Passwords are managed internally by PaperCut
Link to documentation	Batch import and update user data	Batch Internal User Import and Update
Can you specify a user password in the import file?	No (passwords cannot be managed internally by PaperCut)	Yes (passwords are managed internally by PaperCut)
Import method used	Interface UI only - `Users → Actions → Batch Import`	Command line import only - `server-command batch-import-internal-users`
Import file format	batch-user-example.zip	batch-internal-user-example.zip
Fields available to import/update	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 (see here for more detail)	Username Password Credit Balance Restricted Status Full Name Email Department Office Primary Card/ID Number Card/ID PIN Notes Secondary Card/ID Number Home folder (see here for more detail)

Standard Users (users which are managed by an external source like AD or LDAP)

The user import/update process is documented in the Batch import and update user data part of the manual:

Note that in this import method, you are not able to specify a password field, since the users passwords will be managed externally.
Note that you can only import Standard users through the Users → Actions → Batch Import method as detailed on the link above.

Download here: batch-user-example.zip

Internal Users (users managed entirely by PaperCut - including password)

The Internal user import/update process is documented in the Batch Internal User Import and Update part of the manual:

Note that this is the only import method where you can specify the password field, since this is for managing internal users
Note that you can only import Internal users through the ‘server-command batch-import-internal-users’ method as detailed on the link above.

Download here: batch-internal-user-example.zip

These example files are included in the PaperCut installation in the following directory:

[server install]/server/examples/import/users/batch-user-example.tsv
[server install]/server/examples/import/users/batch-internal-user-example.tsv

For a video run thru on creating/importing internal users please see below:

Categories: Reference Articles , User Management , Scripting and APIs

Keywords: tab delimited , example , file , template , tsv , csv

Comments

Last updated October 25, 2022