Bulk import users using SFTP in PBIL
Follow these steps to bulk import users into the PBILsystem using SFTP.
Products affected: PBIL, Intelligent Lockers
Follow these steps to bulk import users into the PBIL system using SFTP.
- Set your import options in PBIL.
- Click the Settings icon at the top and select Application.
- Click Configuration Settings, then select Import Settings.
- Click Configure.
- The “Bulk Import Email Notification” indicates when an email is sent on completion of the import. (See step 4 for definitions of selections.)
- The “Bulk User Handling” Allows for Add/Update or Add/Update/Delete. The Delete setting will delete users that are not in the import file.
- Connect to the SFTP server.
- Host: sftp.pbil.pitneybowes.com
- Port: 22
- Username:
- Production: BPN i.e. 012345678
- Sandbox: S + BPN i.e. S012345678
- Key File: (Sent to client administrator)
- Transfer the file
IMPORTANT: The file name must start with “Users,” otherwise the system will NOT process the file.- There are two folders in the SFTP account. New files should be put into the “uploads” folder.
- Transfer the file(s) to the Uploads/Users folder on SFTP site
- See Appendix for file structures
If setting “BULK IMPORT EMAIL NOTIFICATION” is set to INFO, then an email will be sent after the completion of every import. If this setting is set to ERROR, the email will ONLY be sent if there are errors in import.
If there were errors generated, a new file will be added to the “downloads” folder. The file contains every record that gave an error and a description of the error.
File structure
File name format: Users{UNIQUEDATA}.csv
All headers must be in the file, even if there is no data for every field.
Header | Type | Length | Required | Description |
---|---|---|---|---|
ReceiverCode | string | 50 | Yes | Identifier (Must be unique. Used as primary key and will affect updates/adds/deletes) |
FirstName | string | 100 | Yes | First name |
MiddleName | string | 100 | Middle name | |
LastName | string | 100 | Yes | Last name |
EmailAddress | string | 150 | Yes | Email (must be unique) |
Phone | string | 40 | Phone (no special characters or spaces) | |
SiteCode | string | 100 | Yes | Site the user belongs to |
SiteFiltering | *bool (0 or 1) | 1 | Applies to users with permissions to admin portal (defaults to true) | |
Accessible | *bool (0 or 1) | 1 | Accessible lockers required (defaults to false) | |
Enabled | *bool (0 or 1) | 1 | Defaults to true |
UPDATED: January 21, 2022