Patron Import Data Dictionary for CSV Files

The .csv file maps the data in your registration system to Polaris data fields. You are responsible for creating the file and ensuring that it conforms to the necessary format and content. The table below lists required and optional data fields.

If your patron record system does not include required field data, you must supply a default value. Valid values are shown in the table.

Important:
In the CSV template, the row under the Database Value is a collection of translation strings. Do not put any patron data in this row. On import, Polaris ignores the translation string row.

 

Database Value Data Type Max Data Length Valid Codes/Format Data Required?
TransactionCode Integer 32

5 = New Patron

7 = Update Patron

If you use Record Code = 7 for all patrons in the file, the system will update existing patrons and create new patrons if they do not currently exist in Polaris.

 Y
PatronLastName

String

100

 

Y
PatronFirstName

String

32

PatronFirstName might be required depending on the configuration.

Y/N
PatronMiddleName

String

32

 

N
PatronNameTitle

String

8

 

N
PatronNameSuffix

String

4

 

N
PatronCodeID

Integer

n/a

A valid Polaris Patron Code. These are listed in Polaris Administration and available from the Polaris Code Sheet provided by the Polaris Implementation Manager.

Y
PatronBranchID

Integer

n/a

A valid Polaris OrganizationID having an OrganizationCodeID of 3 (branch).

Y
PatronBarcode

String

20

Unique identifier; for example,the student identification number from the student database.

Y
ExpirationDate

Date

n/a

YYYY-MM-DD HH:MM:SS

Y
PatronStatCodeID

Integer

n/a

A valid Polaris Patron Statistical Class Code ID

N
PatronPassword String 16   N
LanguageID

Integer

n/a

LanguageID (1=English)

Y
RegistrationDate

Date

n/a

YYYY-MM-DD

N
BirthDate

Date

n/a

YYYY-MM-DD

N
MaintainReadingList

Integer

n/a

0 = Do not maintain

1 = Maintain

Y
FormerID

String

20

 

N
UserDefined1

String

64

 

N
UserDefined2

String

64

 

N
UserDefined3

String

64

 

N
UserDefined4

String

64

 

N
UserDefined5

String

64

 

N
DoNotDelete

Bit

n/a

1 = Staff may not delete the patron

0 = Staff may delete the patron

Y
ExcludeFromBills

Bit

n/a

1 = Never bill this patron

0 = This patron may be billed

Y
ExcludeFromCollection

Bit

n/a

1 = This patron may not be sent to collection agency

0 = This patron may be sent to collection agency

Y
ExcludeFromHolds

Bit

n/a

1 = This patron may not be sent hold notifications

0 = This patron may be sent hold notifications

Y
ExcludeFromOverdue

Bit

n/a

1 = This patron may not be sent overdue notifications

0 = This patron may be sent overdue notifications

Y
PlainTextNotification

Bit

n/a

1 = This patron only wants plain text notification

0 = This patron may be sent HTML notifications

Y
AddressCheckDate

Date

n/a

YYYY-MM-DD

N
EmailAddress

String

64

 

N
AlternateEmailAddress

String

64

 

N
Phone1

String

20

 

N
Phone1CarrierID

Integer

2

Unique numeric identifier for mobile phone carrier - see the Mobile Phone Carriers database table in Polaris Administration.

N
Phone2

String

20

 

N
Phone2CarrierID

 

 

Unique numeric identifier for mobile phone carrier - see the Mobile Phone Carriers database table in Polaris Administration.

 

N
Phone3

String

20

 

N
Phone3CarrierID

String

20

Unique numeric identifier for mobile phone carrier - see the Mobile Phone Carriers database table in Polaris Administration.

N
FaxNumber

String

20

 

N
DeliveryOptionID

Integer

n/a

1 = Mail

2 = Email

3 = Phone1

4 = Phone2

5 = Phone3

6 = FAX

N
PatronRecordID

Integer

 

Used internally by Polaris, automatically generated when record is created in Polaris

N
SMSEnabled

Bit

n/a

1 = This patron wants text message notification

0 = This patron does not want text message notification

N
eReceiptOptionID

Integer

 

2 = email

8 = text message

100 = both

N
txtPhoneNumber

Integer

n/a

Indicates which Phone number (1, 2, 3) should be used for text messages.

N
ExcludeFromAlmostOverdue
AutoRenew

Bit

 n/a Exclude from Almost Overdue / Auto Renew Y
ExcludeFromPatronRecExpire

Bit

 n/a Exclude from Patron Record Expiration  
ExcludeFromInactivePatron

Bit

 n/a Exclude from Inactive Patron N
GenderID

Integer

n/a

1, 2, or 3

N
PatronLegalLastName

String

32

 

Y
PatronLegalFirstName

String

32

 

Y
PatronLegalMiddleName

String

32

 

Y
UseLegalNameOnNotices Bit     N
Address1FreeTextLabel String 30   N
Address1TypeID

Integer

n/a

1 = Generic

2 = Notice

N
Address1StreetOne

String

64

 

N
Address1StreetTwo

String

64

 

N
Address1StreetThree

String

64

 

N
Address1City

String

32

 

N
Address1State

String

 

2 character abbreviation

N
Address1PostalCode

String

10

5 character postal code

N
Address1ZipPlusFour

String

4

4 character Zip+ code

N
Address1County

String

32

 

N
Address1CountryID

Integer

n/a

Country ID (1 = USA)

N
Address2FreeTextLabel String 30   N
Address2TypeID

Integer

n/a

1 = Generic

2 = Notice

N
Address2StreetOne

String

64

 

N
Address2StreetTwo

String

64

 

N
Address2StreetThree

String

64

 

N
Address2City

String

32

 

N
Address2State

String

 

2 character abbreviation

N
Address2PostalCode

String

10

5 character postal code

N
Address2ZipPlusFour

String

4

4 character Zip+ code

N
Address2County

String

32

 

N
Address2CountryID

Integer

n/a

Country ID (1 = USA)

N
Address3FreeTextLabel String 30   N
Address3TypeID

Integer

n/a

1 = Generic

2 = Notice

N
Address3StreetOne

String

64

 

N
Address3StreetTwo

String

64

 

N
Address3StreetThree

String

64

 

N
Address3City

String

32

 

N
Address3State

String

 

2 character abbreviation

N
Address3PostalCode

String

10

5 character postal code

N
Address3ZipPlusFour

String

4

4 character Zip+ code

N
Address3County

String

32

 

N
Address3CountryID

Integer

n/a

Country ID (1 = USA)

N
Address4FreeTextLabel String 30   N
Address4TypeID

Integer

n/a

1 = Generic

2 = Notice

N
Address4StreetOne

String

64

 

N
Address4StreetTwo

String

64

 

N
Address4StreetThree

String

64

 

N
Address4City

String

32

 

N
Address4State

String

 

2 character abbreviation

N
Address4PostalCode

String

10

5 character postal code

N
Address4ZipPlusFour

String

4

4 character Zip+ code

N
Address4County

String

32

 

N
Address4CountryID

Integer

n/a

Country ID (1 = USA)

N
Address5FreeTextLabel String 30   N
Address5TypeID

Integer

n/a

1 = Generic

2 = Notice

N
Address5StreetOne

String

64

 

N
Address5StreetTwo

String

64

 

N
Address5StreetThree

String

64

 

N
Address5City

String

32

 

N
Address5State

String

 

2 character abbreviation

N
Address5PostalCode

String

10

5 character postal code

N
Address5ZipPlusFour

String

4

4 character Zip+ code

N
Address5County

String

32

 

N
Address5CountryID

Integer

n/a

Country ID (1 = USA)

N