Modeling catalog records
This page is for the cataloging lead and the website creator who agree on how records are stored. It shows how a typical record maps onto a content class, which shipped datatype fits each field, and how records relate to people and collections. The general rules are in Designing your content model; this page applies them to catalogs.
Contents
- Classes, objects and fields
- A record field by field
- People and organizations as their own objects
- Collections and series
- Required, searchable and translatable
- Names and addresses of records
- Changing the model later
- Review checklist
Classes, objects and fields
In Exponential each kind of record is a content class (for example "Book"), each record is a content object
of that class, and each field is an attribute with a datatype that decides what it stores and how it is edited
(Content classes for websites). The product ships 35
datatypes (Choosing datatypes); extensions add more, such as
the tags field of eztags.
A record field by field
A worked mapping for a book record. Adapt the identifiers to your own rules.
| Record field | Datatype | Why |
|---|---|---|
| Title | ezstring (Text line) | Short text, used in the object name |
| Subtitle | ezstring | Optional |
| ISBN | ezisbn | A shipped datatype for ISBNs (Choosing datatypes) |
| Other identifiers (call number, inventory number) | ezstring or ezidentifier | Not translatable |
| Creators (authors, editors) | ezobjectrelationlist | Several related Person objects, in order |
| Publisher | ezobjectrelation or ezstring | A relation if you describe publishers, a text line if not |
| Date of publication | ezdate | Sortable and filterable; a year-only field can be an ezinteger |
| Language of the item | ezselection | A fixed list editors choose from |
| Format (print, e-book, audio) | ezselection | A fixed list |
| Subjects | tags field of eztags | Controlled headings (Tagging and subject headings) |
| Summary or abstract | ezxmltext (Rich text) or eztext | Rich text when editors need paragraphs and links |
| Cover image | ezimage | With required alternative text |
| Digitized file | ezbinaryfile | Downloaded through content/download (Files and digital collections) |
| External link (catalog entry in the library system) | ezurl | A link to the master record |
| Table of contents or extra data | ezmatrix | A table of values, when the values are data |
The "choosing by need" table of the website creator's guide gives the same choices with alternatives, for example
"A date to sort or filter by: ezdate or ezdatetime" and "Several related items (authors, related articles):
ezobjectrelationlist" (Choosing datatypes).
Tip
Ask "will anyone sort, filter or browse by this?" for each field. If yes, give it a datatype that stores a value (a date, a selection, a relation, a tag), not free text.
People and organizations as their own objects
Model creators as their own class (Person, Organization) and relate records to them. Then:
- one person page lists everything they wrote, through reverse relations ("everything that points to this object", Relations and reuse);
- a correction to a name is made once;
- the person can carry their own fields (dates, biography, portrait).
Relation fields can limit which classes may be chosen, so editors can only pick a Person in the Creators field (datatype options, Content classes for websites).
Collections and series
A collection, series or shelf is a container: a class whose objects have children. Records then live below their collection in the content tree, which gives the menu and the URLs (Designing your content model, Containers and children). A record that belongs to several collections can have additional locations, or be related from each collection instead. Topics that cut across collections belong in tags, not in the tree (Tagging with eztags).
Required, searchable and translatable
| Setting | Use in a catalog |
|---|---|
| Required | Title, at least one creator or a "creator unknown" rule, date; the record cannot be published while a required field is empty |
| Searchable | Title, subtitle, creators, summary, identifiers readers type; not internal notes |
| Translatable | Titles and summaries if you describe in several languages; not ISBN, dates or call numbers |
| Category | Group fields into tabs: Description, Identifiers, Files, Internal |
Source: Content classes for websites, Attribute settings. Image fields can require an alternative text, which helps accessibility of covers and scans.
Names and addresses of records
The object name pattern builds each record's name from its fields, for example <title> or
<short_title|title> (the first that is not empty). The URL alias name pattern builds the address; empty means
the object name (Content classes for websites, Class settings).
Readable addresses help readers and search engines; see
URL aliases and nice URLs.
Changing the model later
Some changes are safe on a live catalog, others are not (Changing a class on a live site):
| Change | Safe? |
|---|---|
| Add a field | Yes; existing records get an empty value |
| Rename a field's label | Yes |
| Change a field's identifier | Risky; every template using it must change at once |
| Remove a field | Destructive; the data is deleted from every record |
| Change a datatype | Not possible in place: add a new field, migrate, remove the old one |
Large classes take a while to change because every object gets the new attribute; change them outside busy hours and with a backup (same page). Build and test class changes on a development copy and move them as a package.
Review checklist
- To do: One class per record type, not per subject.
- To do: Every field that is sorted, filtered or browsed has a value datatype.
- To do: Creators and publishers are objects if you describe them; relation fields limited to their classes.
- To do: Subjects are a tags field with a controlled vocabulary.
- To do: Required, searchable and translatable set on purpose for every field.
- To do: Object name and URL alias patterns give readable names.
- To do: A sample of real records entered and reviewed by catalogers before the import.
Related pages
- Libraries and catalogs
- Catalog planning
- Designing your content model
- Content model and editing (guide)
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.