Related product I-Share

New VuFind Overview and Frequently Asked Questions (FAQ)

Last revised August 13, 2018

New VuFind Overview

VuFind is an alternative interface to I-Share catalogs, offering users what may be a better way to search and discover library resources.

  • VuFind was developed initially at Villanova University for use in libraries, which is why it is named "VuFind".
  • CARLI has adapted VuFind so that it will serve the unique needs of the consortial community, and serve libraries of all sizes within the CARLI I‑Share community.

expand / collapse all

In the fall of 2007, CARLI staff began experimenting with VuFind version 0.6 as an optional, accessible alternative to WebVoyage for interested I‑Share libraries. VuFind searches data from the Voyager database, the same data that the classic WebVoyage interface searches. In VuFind, just as in WebVoyage, users may check item availability and place requests.

In 2016, CARLI staff began working on VuFind 3.  VuFind 3 is significantly different from VuFind 0.6 that is currently in use for I-Share libraries, and should be considered a new system, rather than an upgrade to the version of VuFind now in use with I-Share. 

  • This new version of VuFind builds on the extensive work of CARLI staff in developing the Extensible Catalog (XC) modules by tying together VuFind with XC OAI, XC MST Normalization, XC MST MARC Aggregation, and Voyager services.

In December 2017, CARLI released VuFind version 4.1 under the name "New VuFind".


CARLI New VuFind Overview Webinar,  Presented on May 9, 2018

Frequently Asked Questions - General

Production NEW VuFind

Note: The New VuFind catalog contains live production data, so any requests or status changes are real.

For All I-Share libraries: https://i-share.carli.illinois.edu/all/vf/
For an individual I-Share library: https://i-share.carli.illinois.edu/vf-xxx, where xxx is that library's three-letter code.


Test NEW VuFind

I-Share library staff may also access a test version of the VuFind 4.1 server for testing. These URLs points to a Test Voyager server and are available for staff to try various request scenarios or patron account changes without affecting production.  The data on the test server are a copy of production data made at 3am on June 26, 2017.

Test server for All I-Share Libraries: https://i-share-test.carli.illinois.edu/all/vf/
Test server for an individual I-Share library: https://i-share-test.carli.illinois.edu/vf-xxx, where xxx is the library's three-letter code.

URL constructions as of Dec. 12, 2017, where "xxx" is the library's three-letter I-Share code in lowercase.  Many of these can be built using the CARLI URL Builder.

Bolded portions indicate New VuFind-specific changes.  To access the TEST server change "i-share" to "i-share-test".

Your Library's Local Catalog https://i-share.carli.illinois.edu/vf-xxx
I-Share union catalog https://i-share.carli.illinois.edu/all/vf
Your Account https://i-share.carli.illinois.edu/vf-xxx/MyResearch/Home
Saved Items section in Your Account https://i-share.carli.illinois.edu/vf-xxx/MyResearch/Favorites
Checked Out Items section in Your Account https://i-share.carli.illinois.edu/vf-xxx/MyResearch/CheckedOut
Requested Items section in Your Account https://i-share.carli.illinois.edu/vf-xxx/MyResearch/ILLRequests
Fines section in Your Account https://i-share.carli.illinois.edu/vf-xxx/MyResearch/Fines
Profile section in Your Account https://i-share.carli.illinois.edu/vf-xxx/MyResearch/Profile
Course Reserves page https://i-share.carli.illinois.edu/vf-xxx/Search/Reserves
New Items page https://i-share.carli.illinois.edu/vf-xxx/Search/NewItem
Advanced Search page https://i-share.carli.illinois.edu/vf-xxx/Search/Advanced
Individual Bib Records https://i-share.carli.illinois.edu/vf-xxx/Record/XXXdb.1234567
(where XXX is the library's three-letter I-Share code in UPPERCASE)

Note: Record IDs in the I-Share union catalog are not the same as in VuFind 0.6, and the IDs are not persistent. It is not recommended that you link to a record in the New VuFind I-Share union catalog.

Search Results https://i-share.carli.illinois.edu/vf-xxx/Search/Results/...

Note: This applies to pre-built search boxes and any links to search results.

URL stem to search for ISBN or ISSN https://i-share.carli.illinois.edu/vf-xxx/Search/Results?type=isn&lookfor=
URL stem to search for OCLC number https://i-share.carli.illinois.edu/vf-xxx/Search/Results?type=oclc_num&lookfor=

As of December 12, 2017, CARLI's New VuFind PRODUCTION server is running release 4.1.

As of December 8, 2017, CARLI's New VuFind TEST server is running release 4.1.

CARLI maintains a List of Known Issues in GitHub and a Change Log of completed work.

To provide feedback or suggestions for future development work, please email us at .

CARLI's New VuFind development to date has focused on the functional aspects of the system (i.e., consortial search, item status, requesting) to verify that New VuFind communicates properly with the Extensible Catalog (XC) modules and Voyager. CARLI staff will undertake additional development work in order to enable/modify existing features and to develop new features that are important to CARLI members.
 
All development work will be completed within the VuFind open source framework. In order to ensure that we are able to take full advantage of new features being developed by others in the VuFind community, CARLI staff will make no changes that would block our ability to use the latest version of VuFind. Staff at CARLI libraries who are interested in writing and contributing code to VuFind for issues that are critical to their patrons are encouraged to do so; find out more at https://vufind.org

VuFind 0.6 will not be adapted to work with "I-Share Next", the software that replaces Voyager.

WebVoyage Classic is Voyager-specific software, and all I-Share libraries will eventually need to cease using it before or at the time of Voyager’s replacement with "I-Share Next". 

All I-Share libraries must be using the New VuFind by the time Voyager’s replacement goes live in the next two years or so.  Of course, your library may choose to migrate to New VuFind prior to the required date!

Libraries may present the New VuFind to their users either alongside the current VuFind 0.6 interface or instead of the VuFind 0.6 interface.

BEFORE you implement New VuFind for your library:

  • when you plan to start presenting New VuFind to your users.
  • Submit a New VuFind customization form to update the banner, colors, and other help text.
  • Review the differences in features and functionality between VuFind 0.6 and New VuFind:
  • Review your library's Voyager Matrix Entries to insure they are set to work with both VuFind 0.6 and New VuFind (since patrons will be able to use either version of the OPAC).
  • Update or add links to the New VuFind catalog URL’s on:
    • Library web pages
    • Institution’s web pages
    • Library guide pages
    • Written documentation and instruction materials
    • Learning/course management systems
    • Instructions for how to log in, access Your Account, searching, requesting items, etc.
  • Libraries that have links to chat widgets, stack maps, finding tools, etc., from VuFind 0.6 should test those tools with New VuFind.
  • If your library is a customer of a third-party catalog interface such as Summon, EDS, or WorldCat Discovery*, you will need to work with your vendor to make adjustments to their system to link back to New VuFind.
    • If you only present to your local catalog through your third-party interface, you will likely only need to change the format of the links that the third-party system uses to connect to New VuFind. The section on URLs above may help.
    • If you present the I-Share union catalog through your third-party interface, the way that CARLI provides the records to your vendor from the New VuFind union catalog will change.  Please contact for more information on what to discuss with your vendor.
    • *Special note for Libraries using the WorldCat Discovery "group option": additional configuration may be required with New VuFind, and all libraries using this option must transition simultaneously.

When you are READY TO ROLLOUT New VuFind as an alternative or replacement for VuFind 0.6:

  • Publicize the changes and what they mean for your users:
    • New features
    • New login: Users log in with Last Name and Barcode. There are no longer VuFind logins that must be synced with a Voyager borrower ID and email. Patrons from institutions that have implemented single sign-on (MIL, NIU, NPU, SIC, UIC, UIS, UIU) will login with campus credentials. Libraries that want to implement single sign-on should discuss their options with CARLI staff.
    • Links to be able to place requests for items will only appear after a user has logged into New VuFind.
    • Tags/Favorites created in VuFind 0.6 will not be transferred to New VuFind accounts.
  • If your library uses SFX through CARLI, contact for information on updating your SFX target to the New VuFind catalog.
  • Optional: submit a VuFind 0.6 customization form to add text directing users to New VuFind for your library.

Your library's VuFind 0.6 catalog will continue to exist at its current URL even after you rollout the New VuFind. Library users will continue to be able to use VuFind 0.6 if they have bookmarks or links to it.

Yes! As of June 15, the following libraries have notified the CARLI Office that they are presenting New VuFind to their users. We expect this list will expand over the summer.

  • Carl Sandburg College
  • Illinois Institute of Technology
  • Lincoln College
  • Saint Xavier University
  • Western Illinois University (I-Share only)
  • Catholic Theological Union
  • Lincoln Christian University
  • School of the Art Institute of Chicago
  • Meadville Lombard Theological School
  • Joliet Junior College
  • Triton College
  • University of Illinois at Urbana-Champaign

Frequently Asked Questions - Displays

Fields that display at the top of the New VuFind Record Page, as configured in core.phtml:

Field Label MARC field(s) Notes
[Title] 245abnp  
[Summary] 520 If summary longer than 300 characters, truncates and provides "Full Description" link
New Title: 785ast  
Previous Title: 780ast  
Main Authors: 100abcd(e4) If relator term/code exists, "first author roles" only
Corporate Authors: 110ab(e4), 111abc(e4), 710ab(e4), 711ab(e4) If relator term/code exists, "first author roles" and "second author roles"
Other Authors: 700abcd(e4) If relator term/code exists, "second author roles" only
Format: CARLI custom format definitions  
Language: 008[35-37], 041a, 041d, 041h, 041j  
Published: 260abc, 264abc 264 only if second indicator is 1 or 4
Edition: 250a  
Series: 440ap, 800abcdfpqt, 830ap If none of these are present, 490a
Subjects: 600, 610, 611, 630, 648, 650, 651, 653, 655, 656 All subfields
Tags: n/a User generated

Fields that display in the Description tab:

Field Label MARC field(s) Notes
Summary: 520  
Published: 362a  
Item Description: 500  
Physical Description: 300abcefg, 530abcd  
Publication Frequency: 310ab  
Playing Time: 306a  
Format: 538  
Audience: 521  
Awards: 586  
Production Credits: 508  
Bibliography: 504  
ISBN: 020a, 773z  
ISSN: 022a, 440x, 490x, 730x, 773x, 776x, 780x, 785x  
Related Items: 580  
Access: 506  
Finding Aid: 555  
Publication Place: 752  
Author Notes: n/a Syndetic "author notes", if available, for libraries that subscribe.

Fields that display in the Holdings tab:

Coming soon!

Yes, each library can customize its banner, colors, and some descriptive text by completing the New VuFind Customization Form.

Libraries are strongly encouraged to submit updates via this form even if they are not yet ready to promote New VuFind to users to ensure that banner, colors, and textual information are current and accurate.

The New VuFind interface uses responsive web design so that the site can be viewed in a browser of any size on any desktop or mobile platform. There is not a different mobile URL for New VuFind.

Frequently Asked Questions - Logins

Users can log in by clicking the "Login" link in the upper right corner.

For users at institutions that have implemented their campus single sign-on system to work with New VuFind, you will log in to New VuFind with your local campus credentials.

  • The first time you access any "Your Account" features you will be prompted by New VuFind to enter your library barcode and last name as found in your home library’s Voyager patron record.  This will complete your profile and will only have to be done once; you will not be able to request items until it is done.
  • If your barcode changes in the future, New VuFind will present this page again and ask you to enter the current/correct barcode.

For users at institutions that have not implemented single sign-on, your New VuFind login is your library barcode and last name as found in your home library’s Voyager patron record.

CARLI’s New VuFind servers have been proven to work with a single Shibboleth Identity Provider (IdP), informally called “point-to-point,” a Shibboleth Federation such as InCommon or I-Trust, and some ADFS-based solutions.  If your campus system supports SAML 2.0, it should theoretically work with New VuFind.

Unfortunately, single sign-on with LDAP is not a practical solution in our environment due to security concerns.

If your library would like to work with CARLI to investigate setting up New VuFind to use your campus Shibboleth system, please see the information on Metadata and required attributes and testing procedures, and contact to get started.

As of July 25, CARLI has successfully implemented single sign-on in New VuFind for the following institutions:

EIU ADFS
ILC ADFS 3.0
JWC IAMCLOUD
LFC single Shibboleth Identity Provider
MIL single Shibboleth Identity Provider
NCC single Shibboleth Identity Provider
NIU Microsoft Azure AD (hosted)
NPU Microsoft Azure AD (hosted)
ROU ADFS
SIC single Shibboleth Identity Provider
UIC I-Trust Federation
UIS I-Trust Federation
UIU I-Trust Federation
WHE single Shibboleth Identity Provider

No, New VuFind is a completely separate system that will use either library barcode and last name, or Shibboleth authentication, for account login. Similarly, patron-added tags and favorites will not transfer.

Frequently Asked Questions - Record Data

VuFind 0.6 uses the Voyager Universal Catalog software to create the I-Share union catalog.  

New VuFind utilizes the eXtensible Catalog's Metadata Services Toolkit (XC-MST) to create the deduplicated I-Share union catalog.  This has several implications, including:

  • New VuFind I-Share union catalog record identification numbers are different from the I-Share union catalog in VuFind 0.6 because the VuFind 0.6 I-Share union catalog is a Voyager database created with the Voyager Universal Catalog software.
  • New VuFind I-Share union catalog record identification numbers are not persistent.
  • The deduplication and aggregation mechanisms in XC-MST used with New VuFind are more flexible and are not susceptible to discarding incoming records when there are multiple matches.
  • The XC-MST will not aggregate records on any number of 020 or 024 fields alone, which should help to cut down on the improper overlays of print version records by electronic version records in the New VuFind I-Share union catalog.
  • The output record in the New VuFind I-Share union catalog generated by the XC-MST contains unique 010/020/022/024/035 data from all matching records.

Yes, and a number of improvements have also been made to the definitions in New VuFind. See Formats in New VuFind for more information.

See Correcting Catalog Records for OAI Harvest to VuFind 3 for more information on these errors, where to find the reports, and how to correct them.

Frequently Asked Questions - Requesting Items

Click the "Request Item" link in the Holdings tab of the record for the item you wish to request.  If you have not already logged in to your account, you will be prompted to log in. 

You can also log in to your account at any time by clicking the "Login" link in the upper right corner.

Note: some I-Share libraries do not support local requests.

Request promotion is the process by which a call slip that is unfilled by the first library, where the call slip was a "Direct Request", is sent along to other I-Share libraries as a "Promoted Request" to be possibly filled.
"Request Promotion" is server functionality that is a part of Voyager.

New VuFind is a front end to the Voyager system and not a change to Voyager’s functionality itself. Any traditional Voyager request functionality, such as request promotion, will still function the same as long as we are using Voyager as our software behind the scenes.

To learn more about how Request Promotion functions in Voyager, please see the I-Share Overview Webinar, linked on the Voyager Circulation Training Video webpage, under the Circulation Workflows> I-Share Overview Webinar section. The explanation of Request Promotion begins on slide 71, but prior information about call slip types may also be useful.

Frequently Asked Questions - Search Functionality

Custom indexes in New VuFind (4.1) - CARLI has customized the New VuFind indexes to be more in line with our VuFind 0.6 indexes.  These indexes are in production and test as of Dec. 12, 2017.

Default indexes in VuFind 3 - CARLI did not customize the indexes in VuFind 3. The VuFind 3 catalogs have been decommissioned, but this information is provided here for reference.

Facets are attributes of the retrieved data that you can use to narrow your search results. Facet options display on the New VuFind Results page, on the right under the heading "Narrow Search." The options that display are drawn dynamically from the records in the retrieval set (so if none of the titles is in French, "French" will not be an option in the list of language facets). As you select facets to apply your selections will be listed at the top of the column on the right side of the Results page. Data from the following fields are exposed as facet options on the New VuFind Results page:

Facet Label Solr Field MARC Fields
Format format Combinations of data from RecType+BibLvl and variable fields
Location location Voyager Location Limit Group names
Author author_facet 100abcd, 700abcd, 800abcd, 110ab, 111abc, 410ab, 411abc, 710ab, 711ab, 810ab, 811abc
Topic topic_facet 600x, 610x, 611x, 630x, 648x, 650ax, 651x, 655x, 690x, 691x
Language language 008 bytes 35-37, 041adejh
Genre genre_facet 600v, 610v, 611v, 630v, 648v, 650v, 651v, 655av, 690v, 691v
Era era_facet 600d, 610y, 611y, 630y, 648ay, 650y, 651y, 655y, 690y, 691y
Region geographic_facet 600z, 610z, 611z, 630z, 648z, 650z, 651az, 655z, 690z, 691az
Year of Publication publishDate 260c, 264c

The “Hide eResources…” facet works very similarly in New VuFind as it did in VuFind 0.6.
It functions in the I-Share union catalog by identifying the patron’s home library affiliation by one of two methods:

  • If the user is logged in
  • If the user has accessed the union catalog via a URL that has the library’s three letter code in the URL.

After identifying the patron’s home library, the facet then limits the results to only those records that have the patron’s home library’s holdings associated with them. The results also still include the eResource record sets provided by CARLI for the CARLI eBooks, the OTN textbooks, and HathiTrust records, as these record sets are accessible by all CARLI library-affiliated patrons.

It does not consult SFX or other link resolver knowledge bases. Since it functions by looking at the patron’s home library’s holdings to determine access, it therefore also unavoidably removes from the results freely-available eResources cataloged by other I-Share libraries.

For information about common words New VuFind does not index, see the list of VuFind stop words. The stop words are the same as in VuFind 0.6.

"Browse Alphabetically" is an experimental new feature in New VuFind that provides a traditional alphabetical heading browse experience, allowing users to see all of the authors, subjects, titles, and call numbers in your collection. Authors and subjects include cross-references extracted from authority data.

A built-in API is available to retrieve individual records and search results. The New VuFind API is currently turned "on" for all local catalogs and the I-Share union catalog on the New VuFind TEST server.  If your library would like this enabled on the Production server for your database, contact with your request.

VuFind.org information about the API

There is a Swagger UI available with documentation on the /api endpoint for each catalog:
Local catalog: https://i-share-test.carli.illinois.edu/vf-xxx/api/, where xxx is that library's three-letter code.
I-Share union catalog: https://i-share-test.carli.illinois.edu/all/vf-xxx/api/, where xxx is that library's three-letter code.

You can also access the Swagger specification directly:
Local catalog: https://i-share-test.carli.illinois.edu/vf-xxx/api?swagger, where xxx is that library's three-letter code.
I-Share union catalog: https://i-share-test.carli.illinois.edu/all/vf-xxx/api?swagger, where xxx is that library's three-letter code.

To retrieve a specific local record via BIB ID in our New VuFind consortial environment, it must be formatted with the local database prefix: XXXdb.12345678 (where XXX is that library's three-letter code in UPPERCASE).
To retrieve a specific I-Share union catalog record, the record ID has no prefix (i.e 275430381).

CARLI's OPAC Search Box Builder is not yet updated for New VuFind. To build a New VuFind search box, use the OPAC Search Box Builder to create a regular VuFind 0.6 search box--or find the existing search box code on your website--and email the code to and CARLI support will update the code for New VuFind. Or, follow these easy steps to convert it yourself:

  1. Change vufind to i-share in the URL
  2. Change /Home to /Results in the URL
  3. If present, change option value="all" to value="allfields"
  4. If present, remove line no longer needed: <input type="hidden" name="advHathi" value="exclude"/>
  5. If present, remove line no longer needed: <input type="hidden" name="advHathi" value="include"/>
  6. If present, remove line no longer needed: <input type="hidden" name="start_over" value="1" />
  7. If present, remove line no longer needed: <input type="hidden" name="search" value="new" />

If you'd like to add a search type for Journal Title, add another option value line to the existing code with value="JournalTitle"

If you'd like to add a search type for Call number, add another option value line to the existing code with value="CallNumber"