Skip to Main Content
the logo for the Library Services Platform: California Community Colleges

Systems Work Group

LSP Systems Work Group Main LibGuide- information on events, documentation, and resources

Table of Contents

Click on a topic to see related questions.

How do I access the shared sandbox to test a configuration change?

From the Alma homescreen, navigate to the Help icon located at the top menu. Scroll down and select Standard Sandbox.

If you are presented with an error indicating no sandbox has been found, please refer to our "How to access your Alma sandbox" quick tip or this video demonstrating the process for updating your sandbox URL.

What types of sandboxes are available for consortium members?

Consortium members have access to one of ten standard Alma or Primo VE sandboxes. Additionally one Network Alma sandbox is available. Consortium members who participated as migration team members can access their Sandbox Assignments, and the associated URL and account information for Alma and Primo VE Sandboxes in the CCC Alma-Primo Implementation Canvas Course. If you do not have access to Canvas course, please contact the Network Zone administrator for passwords for your sandbox.

Refer to the following documentation to learn more about standard sandbox environments: Differences Between Standard and Premium Sandboxes.

What's the difference between our sandbox and production environment?

Please refer to the comparison grid in the following documentation from Ex Libris: Differences Between the Alma Sandbox and Production Environment

What is a Cloud App?

Cloud Apps are add-ons written by ExLibris customers and shared with the community. Cloud Apps may add new functionality, create workflow shortcuts and/or integrate with external systems. Cloud Apps run inside the ExLibris platform.

What role(s) are needed to access and use Cloud Apps?

Cloud Apps work within the context of the logged-in user. If a Cloud App tries to access data but the user does not have the appropriate role, the app will display an unauthorized error

How do I limit access to Cloud Apps?

If you have the General System Administrator role, you can control which Cloud Apps can be installed by users at your institution. In Alma, go to the Configuration Menu > General > General Configuration > Cloud Apps Configuration. In the Allow or Hide Cloud Apps section, you can choose All, Allow Selected or Hide Selected.

  • All: Users can see and install all apps.
  • Allow Selected: users can see and install only the apps that have been selected in the dropdown menu
  • Hide Selected: users can see and install all apps except ones that have been selected in the dropdown menu

Where can I get help troubleshooting errors when using the Alma CSV User Load Cloud App?

Details about common errors can be found in the document Using Cloud Apps- Alma CSV User Load. Come to a Systems Work Group Office Hour, or fill the support form.

How do I configure local fields for display in Primo VE?

There are two parts of the process when you only need a local field to display in Primo VE, without any other advanced functionality such as indexing or linking—Manage display and local fields, and Configure views.

  1. Go to Discovery > Display Configuration > Manage display and local fields. Add your desired local field.
  2. Go to Discovery > Display Configuration > Configure Views. Configure your Primo VE view's Full Record Services "Record Details" to display the local field.

Follow these how-to instructions for details on adding a local field and configuring it in your view. Ex Libris documentation on Managing Display and Local Fields and SUNY Libraries Local Notes/Fields (Extensions) are good resources.

How do I update citation style versions/editions and labels for display in Primo VE?

Citation styles automatically update in Primo VE soon after a new version or edition is published. Depending on how you configure your citation style labels, you may need to update the label when a new citation version or edition is published. Here are a few tutorials to walk you through steps in the process.

How do I configure database display and priority order in "View it" results?

Go to Configuration Menu > Fulfillment > Discovery Interface Display Logic > Online Services Order and add services to the top or bottom groups as desired. By default the display is alphabetical--adding services to the groups overrides the default display. 
 

Source credit: Harvard's Wiki post titled "Configuring the Order of Electronic Resources", which includes an example of their priority list.

For multi-campus or multi-library institutions, how do I customize the order of library holdings listed in the "Get it" details of a record?

It is a two step process to customize when prioritizing certain libraries over other libraries within your institution, and must be configured first in Fulfillment "Locations Ordering Profile" and then in each Primo view that needs to override the default order set in "Locations Ordering Profile." See the how-to videos below.

  1. How to customize the "Locations Ordering Profile"
  2. How to override the customized default locations ordering profile in your Primo VE view

Step 1: Set your Locations Ordering Profile to "Use Custom Sorting"

  1. Go to Configuration Menu > Fulfillment > Discovery Interface Display Logic > Locations Ordering Profile.
  2. Select "Use Custom Sorting"
  3. Click through on "Set Custom Libraries Order" to configure the default libraries sort order for the institution.
  4. Click "+ Add Location" to add libraries to the priority list. Use order numbers to prioritize. For example "1" for first priority, where a libraries items should be displayed first.

 

Step 2: Configure the Primo VE View Get It section to override the default library order

  1. Go to Discovery > Display Configuration > Configure Views
  2. Select "Edit" from the [...] more options menu
  3. Select "Full Record Services,"
  4. Configure "getit_link1" by selecting "Configure" from the [...] more options menu
  5. Select "Set custom libraries order for the view"
  6. Add locations for first priority libraries, as in step 1. Libraries configured in the Get it section for each view will override the default library sort order configured in step 1. In this way you can prioritize the order in which libraries will appear in the list of available holdings in each View.

 

Useful documentation: Configuring the Order of Locations in Primo Search ResultsConfiguring the Get It ServiceGetIt Libraries - Customized Display Order (December 2021 Enhancement; NERS ID #6676); & Primo VE December 2021 Release Notes - Configuration Options

How can I identify the source of a record and record ID from a list of Primo VE search results?

To identify the source of a record (Library Catalog, CDI, etc.) in Primo VE, you typically have to examine each individual record by clicking through and scrolling to the bottom of the record where the source is identified in the "Details" section, and look further to identify the record id. However, by using a bookmarklet with a bit of javascript shared by SUNY Libraries Consortium's article "How can I troubleshoot Primo VE search results and links using Record Id, Display CTO and Show PNX?" you can view the information from the list of search results.

How it works: Create a bookmark in your browser, but instead of adding a URL, add the javascript instead. See full instructions, and grab the javascript for your bookmarklet on the SUNY Libraries Consortium article in the "Show record id" section.

I updated a library location's "Suppress from Discovery" checkbox, and it isn't being reflected in Primo VE--how do I fix it?

Submit a case to Ex Libris support, and request that they reindex the library location. See Suppressing Alma Records from Primo VE for more details.

How do I configure an EZProxy integration for Alma?

Integrating your EZProxy with Alma requires communication with your database vendors, EZProxy administrator, and the Network Zone Administrator if you take advantage of shared electronic resource collections in the Network Zone. Configuration work may be required in Alma (IZ and NZ), your database administrator portals, and EZProxy. Configure stanzas as needed in EZProxy, update your authentication method and settings with your vendors. You will need your EZProxy prepended URL and EZProxy IP address to complete configurations with database vendors and in Alma. Request this information from your EZProxy Administrator or OCLC as needed.

Alma EZProxy integration profile tutorials:

Once you've integrated your EZProxy in Alma, check your electronic collections activations to be sure they have the correct EZProxy selected. Contact the Network Zone Administrator for support making updates to any electronic collections managed at the NZ level. Reach out to the ERM Work Group with additional questions or for support with electronic resources management.

Does Alma have a text message (SMS) integration option available?

Yes. There are 10 Alma notification letters that may be enabled and sent to users via text message (SMS). An integration with a third party SMS service is required, as Alma itself does not send the text messages directly to the user—Alma sends the message via SFTP to the third party SMS service, which sends the message to the user. Additionally, text notifications are only sent when specific criteria are met.

Conditions:

  1. The SMS integration must be fully configured (SFTP definition and SMS integration profile) for use with a third party SMS service
  2. SMS notification letters must be enabled in Alma
  3. A user must have a preferred SMS number set to "yes" in their phone contact details

Users with a preferred text number set in their contact details will receive the text notification in addition to the email notification. For example: When an allowed notification is triggered, such as the Overdue Notice Letter (SmsFulUserOverdueNoticeLetter / FulUserOverdueNoticeLetter) it will send it to the user according to the following workflow.

 

  1. Overdue Notice Letter is triggered for a user with preferred text set to yes in their contact info
  2. Alma sends both notices: a) Overdue Notice Letter (FulUserOverdueNoticeLetter) is sent to the user's email account; and b) Overdue Notice Letter (SmsFulUserOverdueNoticeLetter) is sent to the user's mobile device

 

Basic background information

 

  • SMS integration with Alma requires a third party SMS service provider (Alma itself does not send the text message)—your campus may already have one it uses
  • Only some Alma notifications may be sent via text (overdues and reminders are included)
  • Users must opt-in to receive notifications via text (preferred SMS set to yes in user phone contact details)
  • Text notifications must be enabled and configured separately in Alma Letters/Notifications
  • Be aware that as a best practice, your Alma SMS procedures should align with your campus communication policies/protocols for sending text messages to students. Particularly if a student universally opts out from receiving any SMS from the college (this might be managed in your SIS or other CRM). Your campus policies/procedures will be mindful of FCC and other requirements.
  • SMS Communications (Ex Libris Knowledge Center)
  • SMS Communications (Ex Libris Developers Network)

 

Examples of SMS Service Providers used by other Alma institutions (Info from ALMA-L listserv posts November 2021-July 2022)

 

  • Five9 
  • Telnyx
  • Clickatell
  • Twilio
  • Bandwidth

How do I purge user accounts in Alma?

The Purge User Records job (Admin > User Management > Purge User Records) can purge records in bulk when the purge date has passed, and allows you to apply according to the record type (public or staff), user group, and fine/fee threshold. The purge date must be used consistently in order for this method to work. Additionally, the job won't purge users with no purge date. Users with active loans or with fines/fees above the set threshold will not be purged. It is recommended you evaluate your records and the application of purge date prior to running the job (use Analytics and batch updates using the Update/Notify Users job as needed to update expiry and purge dates as needed). Purge date is usually set to a date sometime after the expiry date, according to local policy.

It is recommended you are familiar with your local configuration for user deletion policy and anonymization.


Some libraries opt to control the purge of users more closely, and instead create a special user group for accounts to be purged. In this way they can create a set of users and review and adjust as needed. This is not required, but for more information see Alma User Purge (CARLI) and Patron Purge in Alma (Tech Blog, Ex Libris Developers Network).

How do I report slow performance when using Alma?

Generate a Performance Tracking File and submit to ProQuest Support for Ex Libris.

Users have been receiving error messages branded with Open CCC and California Community Colleges Chancellor's Office on login to Primo VE or Alma--who do I contact for support?

The Open CCC branding indicates the error is related to your Ex Libris single sign on integration with the CCC Technology Center. We recommend you partner with your local IT services department as needed and submit a case to the CCC Technology Center support team via email or their online support center for California community colleges staff members.

If I haven't made any AngularJS customizations to our production environment prior to November 6, 2022, do I need to take any action?

No. If you haven't made AngularJS customizations to your Primo VE view in the "custom.js" file, you are not impacted by the Angular version update, and do not have to take any action. This screenshot shows an out of the box custom.js file that has not been customized.

I'm not sure if we've made AngularJS customizations to our Primo VE view. How do I double check?

Scenario 1 - I use Primo Studio to update my Primo VE view
Navigate to Primo Studio > Editor > js\.to view and access your custom.js file. Any edits should be made and applied within the custom.js file viewer. Please contact the systems work group for additional support. 

Scenario 2 - I use "Download Package" to update my Primo VE view

  1. Go to: Discovery / Display Configuration / Configure Views
  2. Select "Edit" option for the view you want to check
  3. Select "Manage Customization Package" tab
  4. Under "Download Package" section, download the "Current View Customization Package"
  5. Unzip the file folder
  6. Navigate to the js folder, and open the "custom.js" file
  7. Examine the file for customizations.

I got my AngularJS customization code from a third party vendor. Do I need to update the code? Do I need to contact the vendor?

Yes. Your third party vendor may not be aware of Primo's update to using AngularJS 1.8. It is highly recommended you contact the third party vendor who is the source of your code so they can make updates on their end as needed, and/or support you as you modify your code.

Known examples: BrowZine & LibKey by Third Iron. Third Iron has developed a fix for most users. For more information contact Third Iron support. See additional information and examples.