The batch import and update feature allows the administrator to import accounts, and optionally update existing account details by reading data from a simple text file. In addition to being able to create accounts, it enables administrators to update the following account data:
Account Name
Account PIN
Credit balance
Restriction status
Notes
Groups allowed to use the account
Users allowed to use the account
Examples of where the batch user import feature is useful include:
When importing account and balance data from another external system.
To reset the account balances at the end of a semester.
To bulk update the users and groups who are allowed to use the accounts.
To perform a batch import:
Manually inspect your file in a text editor and ensure it's in the prescribed tab-delimited format as detailed at the section called “Batch Account Import File Format”.
Navigate to the Accounts section.
Click the Batch import ... action (on the left).
Click the section called “Batch Account Import File Format”).
to select the file to import. (The format of the file is described inChoose whether you want the import to create new accounts if they do not already exist. If you clear this checkbox, lines that contain users that do not exist will be ignored and only existing users will be updated.
Press the
button.Upon completion you will be told how many accounts were updated and how many accounts were created.
The import file is in tab delimited format and contains the following fields in the given order.
Field | Description | Optional? |
---|---|---|
Account Name | The Shared Account Name | Mandatory |
Account PIN | The account PIN. The account must be unique. | Optional - PIN not set if blank |
Credit Balance | The account balance | Optional - Balance is not set if blank |
Restricted Status | The account's restricted status. (Y/N where Y = YES, and N = No) | Optional - restricted status not set if blank |
Notes | Notes about the shared account (placed in the Notes field). | Optional - notes not set if blank |
Groups |
The groups that are allowed to use the account. The list of
groups is pipe (|) delimited. To reference the special 'All Users' group, use the
syntax | Optional - groups are not updated if blank |
Users | The usernames of users that are allowed to use the account. The list of users is pipe (|) delimited. | Optional - users are not updated if blank |
Table 7.1. Shared Account Import File Format
A simple way to create a tab delimited file is to create a spreadsheet in Microsoft Excel, and then save
it in the Text (Tab delimited)
format.
The following lines shows importing all the above fields. (The fields are separated by tabs).
Maths 1234 500 N A Note group1|group2|group3 user1|user2|user3 Science 1235 100 N More notes group1 user3
The following lines show updating only the groups that can access the account. NOTE: That the tabs still exist for the pin, balance, restriction and notes fields, but each entry is blank. pin, restriction, full name fields, but each entry is blank.
Maths group1|group2|group3 Science group1
© Copyright 1999-2006. PaperCut Software Pty Ltd. All rights reserved.