Ares Database Tables

Follow

This page provides a complete alphabetical list of the database tables and fields used in Ares. Primary keys for the tables are designated in the PK column in each table.

Addons

PKField NameField Type
PKIDint
 Namenvarchar(100)
 AddonTypenvarchar(50)
 Activebit
 Packagevarbinary(max)
 Settingsnvarchar(max)
 LastUpdateddatetime

CancellationReasons

PK
Field Name
Field Type
PKIDint
 Reasonnvarchar(255)
 DefaultNotenvarchar(max)
 CancelTypenvarchar(50)

Courses

PKField NameField Type
PKCourseIDint
 Namenvarchar(200)
 CourseCodenvarchar(20)
 Descriptionnvarchar(max)
 URLnvarchar(255)
 Semesternvarchar(50)
 StartDatesmalldatetime
 StopDatesmalldatetime
 Departmentnvarchar(50)
 Instructornvarchar(50)
 CourseNumbernvarchar(50)
 CoursePasswordnvarchar(50)
 MaxCopyrightmoney
 DefaultPickupSitenvarchar(10)
 CourseEnrollmentint
 ExternalCourseIdnvarchar(255)
 RegistrarCourseIdnvarchar(255)
 CreationDatedatetime
 CreatedBynvarchar(50)
 CreatedVianvarchar(30)

CoursesSharedListsLink

PKField NameField Type
PKCourseIDint
PKListIDint

CourseUserAuthorizations 

PKField NameField Type
PKCourseIDint
PKLibraryIDnvarchar(50)

CourseUsers

PKField NameField Type
PKCourseIDint
PKUsernamenvarchar(50)
 UserTypenvarchar(50)
 AddedBynvarchar(50)

CourseUserSubscription

PKField NameField Type
PKCourseIDint
PKUsernamenvarchar(50)

CourseUserValidation

PKField NameField Type
PKRegistrarCourseIdnvarchar(50)
PKLibraryIDnvarchar(50)
 UserTypenvarchar(50)

CourseValidation

PKField NameField Type
PKRegistrarCourseIdnvarchar(255)
 ExternalCourseIdnvarchar(255)
 Namenvarchar(200)
 CourseCodenvarchar(20)
 Descriptionnvarchar(max)
 URLnvarchar(255)
 Semesternvarchar(50)
 StartDatesmalldatetime
 StopDatesmalldatetime
 Departmentnvarchar(50)
 Instructornvarchar(50)
 CourseNumbernvarchar(50)
 CoursePasswordnvarchar(50)
 MaxCopyrightmoney
 DefaultPickupSitenvarchar(10)
 CourseEnrollmentint

CrossListCourse

PKField NameField Type
PKXCourseIDint
 ParentCourseIDint
 Departmentnvarchar(50)
 CourseNumbernvarchar(50)
 CourseCodenvarchar(50)
 Namenvarchar(200)

CustomDropDown

PKField NameField Type
PKGroupNamenvarchar(100)
PKLabelNamenvarchar(200)
 LabelValuenvarchar(100)

Customization

PKField NameField Type
PKCustKeynvarchar(60)
 Valuenvarchar(1000)
 KeyDescriptionnvarchar(max)
 Categorynvarchar(50)
 SubCategorynvarchar(50)
 KeyTypenvarchar(50)
 ReadOnlybit
PKProcessingLocationnvarchar(10)

CustomizationLookup

PKField NameField Type
PKIDint
 CustKeynvarchar(60)
 LookupValuenvarchar(1000)

CustomizationTracking

PKField NameField Type
PKCustKeynvarchar(100)
 ValueChangedFromnvarchar(1000)
 ValueChangedTonvarchar(1000)
PKChangedTimedatetime
 ChangedBynvarchar(20)
PKProcessingLocationnvarchar(10)

CustomQueues

PKField NameField Type
PKQueueNamenvarchar(50)
 IsFlagbit
 CanClonebit

DailyTaskReports

PKField NameField Type
PK

ID

int
 Processnvarchar(100)
 RunTimedatetime
 Resultnvarchar(10)
 Descriptionnvarchar(255)

DisplayStatuses

PKField NameField Type
PKIDint
 ItemStatusnvarchar(255)
 WebDisplayStatusnvarchar(255)

DocumentTypes

PKField NameField Type
PKDocumentTypeNamenvarchar(50)
 DocumentTypeValuenvarchar(50)
 Extensionnvarchar(50)
 Iconnvarchar(200)
 ContentTypenvarchar(100)
 ForceReviewbit
 ForceReviewOnClonebit

ElectronicFiles

PKField NameField Type
PKIDint
 FileNamenvarchar(max)
 FileSizebigint
 Hashbinary(32)
 Pendingbit

EmailCopies

PKField NameField Type
PKIDint
 EmailDatedatetime
 EmailTypenvarchar(50)
 EmailReferencenvarchar(50)
 Staffnvarchar(50)
 EmailTonvarchar(500)
 EmailFromnvarchar(500)
 EmailCCnvarchar(500)
 EmailBCCnvarchar(500)
 Subjectnvarchar(255)
 Bodynvarchar(max)
 Statusnvarchar(100)
 Notenvarchar(255)

EmailRouting

PKField NameField Type
PKERoutingNamenvarchar(50)
 EmailTemplatenvarchar(50)
 DefaultStatusnvarchar(50)

EmailTemplates

PKField NameField Type
PKNamenvarchar(50)
 Descriptionnvarchar(255)
 Subjectnvarchar(255)
 CCAddressnvarchar(500)
 Textnvarchar(max)
 ToNamenvarchar(200)
 ToAddressnvarchar(200)
 Typenvarchar(50)
 SystemTemplatebit
 FromAddressnvarchar(200)
 FromNamenvarchar(200)

EventLog

PKField NameField Type
PKLogDatedatetime
PKSubjectnvarchar(20)
PKStatusnvarchar(255)
 Usernamenvarchar(50)

ItemCopyright

PKField NameField Type
PKItemIDint
 CopyrightProvidernvarchar(50)
 Feemoney
 OrderHeadernvarchar(50)
 OrderDetailnvarchar(50)
 OrderedBynvarchar(50)
 OrderDatedatetime
 Termsnvarchar(max)
 RightStatusnvarchar(50)
 RightUpdateddatetime
 NumStudentsint
 NumPagesint
 Completedbit
 PermissionDocFileNamenvarchar(50)

ItemCopyrightHistory

PKField NameField Type
PKIDint
 ItemIDint
 CopyrightProvidernvarchar(50)
 Feemoney
 OrderHeadernvarchar(50)
 OrderDetailnvarchar(50)
 OrderedBynvarchar(50)
 OrderDatedatetime
 Termsnvarchar(max)
 RightStatusnvarchar(50)
 RightUpdateddatetime
 NumStudentsint
 NumPagesint
 Completedbit
 PermissionDocFileNamenvarchar(50)
 EntryDatedatetime

ItemFlags

PKField NameField Type
PKItemIDint
PKFlagnvarchar(50)

ItemHistory

PKField NameField Type
PKItemIDint
PKDateTimedatetime
PKEntrynvarchar(255)
PKUsernamenvarchar(50)

ItemNotes

PKField NameField Type
 ItemIDint
 AddedBynvarchar(50)
 NoteDatedatetime
 NoteTypenvarchar(50)
 Notenvarchar(max)
PKNoteIDint

Items

PKField NameField Type
PKItemIDint
 CourseIDint
 PickupLocationnvarchar(10)
 ProcessingLocationnvarchar(10)
 CurrentStatusnvarchar(50)
 CurrentStatusDatedatetime
 ItemTypenvarchar(50)
 DigitalItembit
 Locationnvarchar(max)
 AresDocumentbit
 InstructorProvidedbit
 CopyrightRequiredbit
 CopyrightObtainedbit
 VisibleToStudentsbit
 ActiveDatedatetime
 InactiveDatedatetime
 Callnumbernvarchar(100)
 ReasonForCancellationnvarchar(255)
 Proxybit
 Titlenvarchar(255)
 Authornvarchar(255)
 Publishernvarchar(50)
 PubPlacenvarchar(30)
 PubDatenvarchar(30)
 Editionnvarchar(30)
 ISXNnvarchar(20)
 ESPNumbernvarchar(32)
 CitedInnvarchar(255)
 DOInvarchar(50)
 ArticleTitlenvarchar(255)
 Volumenvarchar(30)
 Issuenvarchar(30)
 JournalYearnvarchar(30)
 JournalMonthnvarchar(30)
 Pagesnvarchar(100)
 ShelfLocationnvarchar(100)
 DocumentTypenvarchar(50)
 ItemFormatnvarchar(50)
 Descriptionnvarchar(255)
 CCCNumbernvarchar(50)
 LoanPeriodint
 Editornvarchar(255)
 ReferenceNumbernvarchar(50)
 ItemBarcodenvarchar(50)
 NeededBynvarchar(50)
 PagesEntireWorksmallint
 PageCountsmallint
 NatureOfWorknvarchar(50)
 SortOrderint
 ItemInfo1nvarchar(255)
 ItemInfo2nvarchar(255)
 ItemInfo3nvarchar(255)
 ItemInfo4nvarchar(255)
 ItemInfo5nvarchar(255)
 ListItemIDint

ItemSize

PKField NameField Type
PKItemIDint
 Limitedbit
 ItemSizefloat

ItemTags

PKField NameField Type
PKItemIDint
PKTaggernvarchar(50)
PKItemTagnvarchar(255)
 TagAddedsmalldatetime

ItemText

PKField NameField Type
PKItemIDint
 ItemTextnvarchar(max)

ItemTracking

PKField NameField Type
PKItemIDint
PKTrackingDateTimedatetime
PKStatusnvarchar(50)
 Usernamenvarchar(50)

LinkCheck

PKField NameField Type
PKItemIDint
 UpdateMethodnvarchar(50)
 Statusnvarchar(50)
 StatusUpdaternvarchar(50)
 StatusTimesmalldatetime
 HTTPCodenvarchar(50)
 HTTPDescriptionnvarchar(50)

LoanPeriods

PKField NameField Type
PKLoanPeriodIDint
 Sitenvarchar(10)
 Descriptionnvarchar(50)
 Minutesint
 Visible to Instructorsbit

LTIConsumers

PKField NameField Type
PKConsumerKeynvarchar(50)
 SharedSecretnvarchar(50)
 InstructorRolesnvarchar(1000)
 AresWebURLnvarchar(1000)

LTIFieldMappings

PKField NameField Type
PKAresFieldNamenvarchar(100)
PKAresObjectNamenvarchar(100)
 LTIFieldNamenvarchar(100)

LTINonceEntries

PKField NameField Type
PKNoncenvarchar(50)
PKRequestTypeint
 TimeStampdatetime

MessageBoard

PKField NameField Type
PKMBIDint
PKBoardIdint
 Threadint
 Titlenvarchar(300)
 PostDatedatetime
 Usernamenvarchar(50)
 Messagenvarchar(max)

OpenURLDestinations

PKField NameField Type
PKDestinationnvarchar(50)
 DestinationURLnvarchar(500)
 DestinationStatusnvarchar(50)

OpenURLMapping

PKField NameField Type
PKIDint
 URL_Vernvarchar(50)
 rfr_idnvarchar(100)
 AresActionnvarchar(50)
 AresFieldNamenvarchar(100)
 OpenURLFieldValuesnvarchar(250)
 AresValuenvarchar(100)

PrintDetails

PKField NameField Type
PKSessionIDint
PKItemIDint

PrintSessions

PKField NameField Type
PKSessionIDint
 Usernamenvarchar(50)
 PrintDateTimedatetime
 PrintTypenvarchar(50)
 ItemsPrintedint

ProxyUsers

PKField NameField Type
PKInstructorUsernamenvarchar(50)
PKProxyUsernamenvarchar(50)

RightsholderJournals

PKField NameField Type
PKRightsholderIDint
PKJournalnvarchar(255)
PKISSNnvarchar(50)

Rightsholders

PKField NameField Type
PKRightsholderIDint
 RightsholderNamenvarchar(200)
 Address1nvarchar(200)
 Address2nvarchar(200)
 Address3nvarchar(200)
 Citynvarchar(100)
 Statenvarchar(100)
 PostalCodenvarchar(50)
 Countrynvarchar(100)
 ContactNamenvarchar(100)
 Phonenvarchar(50)
 Faxnvarchar(50)
 Emailnvarchar(50)
 Commentsnvarchar(max)
 RightsholderTypenvarchar(50)
 PaymentPreferencenvarchar(50)
 RequestMethodnvarchar(50)
 RightsholderURLnvarchar(255)

Routing

PKField NameField Type
PKRuleIDint
 Activebit
 Statusnvarchar(50)
 Matchnvarchar(500)
 NewStatusnvarchar(50)
 Descriptionnvarchar(255)

Semesters

PKField NameField Type
PKSemesterNamenvarchar(50)
 StartDatedatetime
 EndDatedatetime
 ItemAdditionDatedatetime

ServerAddons

PKFieldField Type
PKIDint
 Namenvarchar (100)
 Configurationnvarchar(max)
 Codenvarchar(max)

SharedListItems

PKField NameField Type
PKListItemIDint
 ListIDint
 PickupLocationnvarchar(10)
 ProcessingLocationnvarchar(10)
 ItemTypenvarchar(50)
 DigitalItembit
 Locationnvarchar(max)
 AresDocumentbit
 InstructorProvidedbit
 CopyrightRequiredbit
 CopyrightObtainedbit
 VisibleToStudentsbit
 Callnumbernvarchar(100)
 ReasonForCancellationnvarchar(255)
 Proxybit
 Titlenvarchar(255)
 Authornvarchar(255)
 Publishernvarchar(50)
 PubPlacenvarchar(30)
 PubDatenvarchar(30)
 Editionnvarchar(30)
 ISXNnvarchar(20)
 ESPNumbernvarchar(32)
 CitedInnvarchar(255)
 DOInvarchar(50)
 ArticleTitlenvarchar(255)
 Volume

nvarchar(30)

 Issuenvarchar(30)
 JournalYearnvarchar(30)
 JournalMonthnvarchar(30)
 Pagesnvarchar(30)
 ShelfLocationnvarchar(100)
 DocumentTypenvarchar(50)
 ItemFormatnvarchar(50)
 Descriptionnvarchar(255)
 CCCNumbernvarchar(50)
 LoanPeriodint
 Editornvarchar(255)
 ReferenceNumbernvarchar(50)
 ItemBarcodenvarchar(50)
 PagesEntireWorksmallint
 PageCountsmallint
 NatureOfWorknvarchar(50)
 SortOrderint
 ItemInfo1nvarchar(255)
 ItemInfo2nvarchar(255)
 ItemInfo3nvarchar(255)
 ItemInfo4nvarchar(255)
 ItemInfo5nvarchar(255)

SharedListItemText

PKField NameField Type
PKListItemIDint
 ItemTextnvarchar(max)

SharedLists

PKField NameField Type
PKListIDint
 ListTypenvarchar(50) 
 ListReferencenvarchar(50)
 ListNamenvarchar(255)

Sites

PKField NameField Type
PKSiteCodenvarchar(10)
 SiteNamenvarchar(50)
 DefaultProcessingSitenvarchar(10)
 AvailableForPickupbit
 AvailableForProcessingbit

Staff

PKField NameField Type
PKUsernamenvarchar(50)
 Passwordnvarchar(50)
 FirstNamenvarchar(50)
 LastNamenvarchar(50)
 Descriptionnvarchar(100)
 ClientPermissionsint
 CustomizationManagerPermissionsint
 StaffManagerPermissionsint
 AddonPermissionsint

StaffLayouts

PKField NameField Type
PKUsernamenvarchar(50)
PKLayoutTypenvarchar(150)
 Layoutvarbinary(max)

SystemAlerts

PKField NameField Type
PKAlertIDint
 AlertTitlenvarchar(255)
 AddedBynvarchar(50)
 DateAddeddatetime
 ActiveDatedatetime
 InactiveDatedatetime
 IdentifierTypenvarchar(50)
 IdentifierValuenvarchar(50)
 AllowDeletionbit
 AlertMessagenvarchar(max)

UserHotList

PKField NameField Type
PKUsernamenvarchar(50)
PKItemIDint

UserNotes

PKField NameField Type
PKNoteIDint
 Usernamenvarchar(50)
 NoteDatedatetime
 Notenvarchar(max)

Users

PKField NameField Type
PKUsernamenvarchar(50)
 LastNamenvarchar(50)
 FirstNamenvarchar(50)
 LibraryIDnvarchar(50)
 Address1nvarchar(50)
 Address2nvarchar(50)
 Address3nvarchar(50)
 Citynvarchar(50)
 Statenvarchar(50)
 Zipnvarchar(10)
 Departmentnvarchar(255)
 Statusnvarchar(50)
 EmailAddressnvarchar(100)
 Phone1nvarchar(20)
 Phone2nvarchar(20)
 UserTypenvarchar(20)
 Passwordnvarchar(50)
 PasswordHintnvarchar(50)
 LastChangedDatedatetime
 LastLoginDatedatetime
 Clearednvarchar(5)
 ExpirationDatedatetime
 Trustedbit
 AuthMethodnvarchar(50)
 CourseEmailDefaultbit
 ExternalUserIdnvarchar(50)
 RSSIDnvarchar(50)
 UserInfo1nvarchar(255)
 UserInfo2nvarchar(255)
 UserInfo3nvarchar(255)
 UserInfo4nvarchar(255)
 UserInfo5nvarchar(255)

UserSystemAlerts

PKField NameField Type
PKAlertIDint
PKUsernamenvarchar(50)
PKDateAlertReaddatetime

UserValidation

PKField NameField Type
PKLibraryIDnvarchar(50)
 Usernamenvarchar(50)
 LastNamenvarchar(50)
 FirstNamenvarchar(50)
 Address1nvarchar(50)
 Address2nvarchar(50)
 Address3nvarchar(50)
 Citynvarchar(50)
 Statenvarchar(50)
 Zipnvarchar(10)
 Departmentnvarchar(255)
 Statusnvarchar(50)
 EmailAddressnvarchar(100)
 Phone1nvarchar(20)
 Phone2nvarchar(20)
 UserTypenvarchar(20)
 ClearTextPasswordnvarchar(64)
 PasswordHintnvarchar(50)
 Clearednvarchar(5)
 ExpirationDatedatetime
 Trustedbit
 AuthMethodnvarchar(50)
 CourseEmailDefaultbit
 ExternalUserIdnvarchar(50)
 UserInfo1nvarchar(255)
 UserInfo2nvarchar(255)
 UserInfo3nvarchar(255)
 UserInfo4nvarchar(255)
 UserInfo5nvarchar(255)

WebFormValues

PKField NameField Type
PKFormnamenvarchar(40)
PKSubmitButtonValuenvarchar(100)
PKSubmitButtonTextnvarchar(100)

WebServiceAgents

PKField NameField Type
PKAgentnvarchar(450)

WebSession

PKField NameField Type
PKUsernamenvarchar(50)
 SessionIDnvarchar(40)
 Expirationdatetime
 RunModeint

WebValidation

PKField NameField Type
PKFormnamenvarchar(40)
PKFieldnamenvarchar(60)
PKValidationTypenvarchar(50)
 Validationnvarchar(200)
 Errornvarchar(200)
 Summarynvarchar(200)
 ErrorTagnvarchar(60)

ZProfiles

PKField NameField Type
PKProfileNamenvarchar(50)
 DBNamenvarchar(50)
 Portnvarchar(10)
 SearchSystemNumbernvarchar(200)
 SearchTitlenvarchar(200)
 SearchAuthornvarchar(200)
 SearchISSNnvarchar(200)
 SearchISBNnvarchar(200)
 SearchDatenvarchar(200)
 SearchKeywordTitlenvarchar(200)
 SearchKeywordAuthornvarchar(200)
 ZTypenvarchar(50)
 ZIdentifiernvarchar(50)
 ZCallNumbernvarchar(50)
 ZAvailabilitynvarchar(50)
 ZLocationnvarchar(50)
 AvailabilityTypenvarchar(50)
 AvailabilityRegExpnvarchar(255)
 AvailableTextTypenvarchar(50)
 AvailableTextnvarchar(50)
 NotAvailableTextTypenvarchar(50)
 NotAvailableTextnvarchar(50)
 SearchCallNumbernvarchar(200)

ZSearches

PKField NameField Type
PKSearchNumberint
 SearchNamenvarchar(50)
 ServerConfigNumbersnvarchar(100)
 DefaultSearchnvarchar(20)
 SortOrderint

ZServerConfig

PKField NameField Type
PKServerConfigNumberint
 Namenvarchar(50)
 Servernvarchar(50)
 Portint
 DBNamenvarchar(50)
 ServerTypenvarchar(50)
 SearchSystemNumbernvarchar(200)
 SearchTitlenvarchar(200)
 SearchAuthornvarchar(200)
 SearchISSNnvarchar(200)
 SearchISBNnvarchar(200)
 SearchDatenvarchar(200)
 SearchKeywordTitlenvarchar(200)
 SearchKeywordAuthornvarchar(200)
 AuthUsernvarchar(50)
 AuthPassnvarchar(50)
 ZTypenvarchar(50)
 ZIdentifiernvarchar(50)
 ZCallNumbernvarchar(50)
 ZAvailablitynvarchar(50)
 ZLocationnvarchar(50)
 AvailabilityTypenvarchar(50)
 AvailabilityRegExpnvarchar(255)
 AvailableTestTypenvarchar(50)
 AvailableTextnvarchar(50)
 NotAvailableTextTypenvarchar(50)
 NotAvailableTextnvarchar(50)
 SearchCallNumbernvarchar(200)

Questions?

If this article didn’t resolve your issue, please take a moment and answer a few questions to help improve our documentation:

Feedback