TRN File Format

A .trn (transaction) file is the old Polaris offline format for uploading patron records. This file maps the data in your registration system to Polaris data fields. You are responsible for ensuring it conforms to the necessary format and content.

The upload file must be a pipe-delimited text file in the form specified below. The encoding can be ANSI, Unicode, or UTF-8.

File Name

The file name must be in the format:

PTF_<YYYY><MM><DD><HH><MI><SS>_<WorkstationName>.TRN

Where:

<YYYY> is the four digit year

<MM> is the two digit month

<DD> is the two digit date

<HH> is the two digit hour

<MI> is the two digit minute

<SS> is the two digit second

<WorkstationName> is the network computer name of a valid Polaris staff client workstation

File Header

The file begins with a one-line header in this form:

1|<time>|<date>|<branchID>|<userID>|<workstationID>|<version>

Where:

<time> is in the form HH:MM:SS

<date> is in the form YYYY-MM-DD

<branchID> is a valid Polaris OrganizationID with an organization code ID of 3 (Branch).

<userID> is a valid Polaris staff client user ID with Polaris permission to use offline Polaris.

<workstationID> is a valid Polaris workstation ID with Polaris permission to use offline Polaris.

<version> is not currently used; leave these characters as shown.

At the end of the header data, insert a CR (ASCII character 13) to indicate the end of the header.

Patron Content

Each row represents a single, implicitly structured data item (a patron). Insert a CR (ASCII character 13) at the end of each row to indicate the end of that patron’s data. Multiple patrons may be included in the patron file. You must include a valid Polaris Patron Code ID for each patron. The row takes this form:

<record code>|<creation date>|<Name Last>|<Name First>|<Name Middle>|<Name Title>|<Name Suffix>|<Patron Code ID>|<Patron Branch ID>|<Patron Barcode>|<Expiration Date>|<Patron Statistical Code ID>|<Gender ID (1, 2, 3)>|<Password>|<Language ID>|<Registration Date>|<Birth Date>|<Permission (currently is not being used)>|<Maintain Reading List (1, 0)>|<Former ID>|<User Defined Field 1>|<User Defined Field 2>|<User Defined Field 3>|<User Defined Field 4>|<User Defined Field 5>|<Do Not Delete (1, 0)>|<Exclude From Bills (1, 0)>|<Exclude From Collection (1, 0)>|<Exclude From Holds (1, 0)>|<Exclude From Overdue Notice (1, 0)>|<Use Plain Text E-mail (1, 0)>|~<Address Label>|<Address Type>|<Street One>|<Street Two>|<Street Three>|<City>|<State>|<Postal Code>|<Zip Code Plus Four>|<County>|<Country ID>|<Address Check Date>|<E-mail Address>|<Alternative E-mail Address>|<Phone 1>|<Phone1CarrierID>|<Phone 2>|<Phone2CarrierID>|<Phone 3>|<Phone3CarrierID>|<Fax Number>|< Delivery Option ID>|<PatronRecordID>|<EnableSMS>|<eReceiptOptionID|<TxtPhoneNumber>|<Exclude from Almost Overdue / Auto Renew (1, 0)>|<Exclude from Patron Record Expiration (1, 0)>|<Exclude from Inactive Patron (1, 0)>|<Obfuscated Password>|<Password Hash>|<Patrons Last Name on ID> |<Patrons First Name on ID>|<Patrons Middle Name on ID>|<Use Name on ID for Notices (1, 0)>|

For more information on patron data codes, see Patron Import Data Dictionary for .trn Files.