Data model

  • first-steps
Last updated: 04-06-2024

Bibliographic data

To ensure its sustainability and interoperability, the data model for the document resource has been established on the basis of the Bibframe 2.0 standard. The cataloguing rules in application are based on RDA, the long-term objective being compliance with LRM bibliographic models.

  • For a detailed description of the bibliographic data fields, refer to the cataloguing documentation.
  • To learn more about the differences between format, standard and data model, and their use in RERO ILS, see this post.

Understanding RERO ILS resources

To use RERO ILS effectively, it's important to understand how its data is structured and presented. Different types of objects interact in RERO ILS, much like the tables in a database: documents, items, users, etc. In RERO ILS, these objects are called resources. Each type of resource is specifically described using different fields.

This data is stored in JSON, a plain text format for describing structured data, and readable by both machines and humans. The structure of each resource type is described in a JSON Schema file, which is used to check the conformity of the data fields.

Resource list

Catalog and metadata

Name Shortcut Description Schema
documents doc document: bibliographic record JSON schema
holdings hold holdings: describes a set of items linked to a document JSON schema
items item item: describes a physical or online object linked to a holdings JSON schema
records file File bucket: Container that links one or more files with a document and a library. JSON schema
remote_entity - remote entity: authority (person, corporate body, topic, place, temporal, etc.) from MEF and indexed in RERO ILS JSON schema
local_entity locent local entity: authority (person, corporate body, topic, place, temporal, etc.) recorded directly in RERO ILS (disabled in the RERO+ network : exclusive use of MEF entities) JSON schema
local_fields lofi local field: data that is specific to an organization or library and related to a document, holdings or item JSON schema
collections coll exhibition/course: grouping of items within a library JSON schema

Circulation and user management

Name Shortcut Description Schema
users - user: contains a person's personal data (first name, last name, addresses). This resource is shared by the various RERO ILS organizations, enabling the data of people registered with several organizations to be shared. JSON schema
patrons ptrn patron: describes a library patron, i.e. a person who is registered with an organization. It is therefore linked to a user resource and contains patron data useful to libraries (role, card number, specific address, etc.). JSON schema
loans loan loan: describes the status of a circulation operation, i.e. an interaction between a patron and an item. For example, when a patron requests an item, a loan resource is created. It links the patron to the item and changes status according to the operations performed: PENDING, ITEM_ON_LOAN, etc. JSON schema
patron_transactions pttr fee: amount to be charged to a patron, generated manually or by an circulation operation JSON schema
patron_transaction_events ptre transaction: creation, payment or cancellation of a fee amount JSON schema
ill_requests illr Inter-library loan request: contains request data, including references to a patron and to a pick-up location. JSON schema


Name Shortcut Description Schema
budgets budg budget: fiscal year JSON schema
acq_accounts acac account: budget item, to which an amount can be allocated JSON schema
vendors vndr vendor: an agent who can receive and fulfill document orders JSON schema
acq_orders acor order: an order sent to a vendor and containg several lines referencing documents JSON schema
acq_order_lines acol order line: data linking a document to an order, including price and order quantity JSON schema
acq_receipts acre receipt: data describing an act of reception, with several lines referring to order lines JSON schema
acq_receipt_lines acrl receipt line: data linking a receipt to order lines JSON schema
acq_invoices acin invoice: accounting data for billing JSON schema


Name Shortcut Description Schema
patron_types ptty patron type: categorization of patrons JSON schema
item_types itty item type: categorization of items JSON schema
circ_policies cipo circulation policy: set of circulation rules applying to a loan resource given a specific patron type and a specific item type JSON schema
organisations org organization: usually a network of several libraries sharing data for patron, item, etc. JSON schema
libraries lib library: institution, usually in the sense of a physical building JSON schema
locations loc location: a subsection of a library in which items are stored JSON schema
notifications notif notification: message generated and sent by the system (reminder, order, etc.) JSON schema
operation_logs oplg operation log: saves an act of edition performed on another resource: document, item, holding, loan or ill_resquest JSON schema
stats stat statistics: indicator of the system use collected at a given time, or for a specified period JSON schema
stats_cfg stat_cfg stats configuration: set of parameters that manages the production of statistical reports at regular intervals to analyze the institution's activity JSON schema
templates tmpl template: standard data with pre-filled values used for the quick creation of a document, holdings, item or patron JSON schema

Further comments

Some of the resources used by RERO ILS are transparently displayed in the interface, through brief views, detailed views or editors, most notably for documents, holdings and items. A brief view is a summary of a resource's data, often displayed in search results lists. A detailed view is the page describing the resource in detail.

Brief VS detailed views for a document

Some resources used in RERO ILS (e.g. notifications or loans) have no detailed view in the interface, but can be accessed through the API.

Keyboard shortcuts | Understanding how search works