Alma Administartion Guide

354 Pages·2015·7.22 MB·English

Alma Administration
Ex Libris Confidential
CONFIDENTIAL INFORMATION
The information herein is the property of Ex Libris Ltd. or its affiliates and any misuse or abuse 
will result in economic loss. DO NOT COPY UNLESS YOU HAVE BEEN GIVEN SPECIFIC 
WRITTEN AUTHORIZATION FROM EX LIBRIS LTD.
This document is provided for limited and restricted purposes in accordance with a binding 
contract with Ex Libris Ltd. or an affiliate. The information herein includes trade secrets and is 
confidential.
DISCLAIMER
The information in this document will be subject to periodic change and updating. Please confirm 
that you have the most current documentation. There are no warranties of any kind, express or 
implied, provided in this documentation, other than those expressly agreed upon in the 
applicable Ex Libris contract. This information is provided AS IS. Unless otherwise agreed, Ex 
Libris shall not be liable for any damages for use of this document, including, without limitation, 
consequential, punitive, indirect or direct damages.
Any references in this document to third‐party material (including third‐party Web sites) are 
provided for convenience only and do not in any manner serve as an endorsement of that third‐
party material or those Web sites. The third‐party materials are not part of the materials for this Ex 
Libris product and Ex Libris has no liability for such materials.
TRADEMARKS
ʺEx Libris,ʺ the Ex Libris bridge, Alma, Primo, Aleph, Alephino, Voyager, SFX, MetaLib, Verde, 
DigiTool, Preservation, Rosetta, URM, ENCompass, Endeavor eZConnect, WebVoyáge, Citation 
Server, LinkFinder and LinkFinder Plus, and other marks are trademarks or registered 
trademarks of Ex Libris Ltd. or its affiliates. 
The absence of a name or logo in this list does not constitute a waiver of any and all intellectual 
property rights that Ex Libris Ltd. or its affiliates have established in any of its products, features, 
or service names or logos. 
Trademarks of various third‐party products, which may include the following, are referenced in 
this documentation. Ex Libris does not claim any rights in these trademarks. Use of these marks 
does not imply endorsement by Ex Libris of these third‐party products, or endorsement by these 
third parties of Ex Libris products.
Oracle is a registered trademark of Oracle Corporation.
UNIX is a registered trademark in the United States and other countries, licensed exclusively 
through X/Open Company Ltd.
Microsoft, the Microsoft logo, MS, MS‐DOS, Microsoft PowerPoint, Visual Basic, Visual C++, 
Win32,
Microsoft Windows, the Windows logo, Microsoft Notepad, Microsoft Windows Explorer, 
Microsoft Internet Explorer, and Windows NT are registered trademarks and ActiveX is a 
trademark of the Microsoft Corporation in the United States and/or other countries.
Unicode and the Unicode logo are registered trademarks of Unicode, Inc.
Google is a registered trademark of Google Inc.
iPhone is a registered trademark of Apple Inc.
Copyright Ex Libris Limited, 2015. All rights reserved.
Document released: December 2015
Web address: http://www.exlibrisgroup.com
Ex Libris Confidential
Table of Contents
Chapter 1 Introduction to Administration............................................................... 7
Chapter 2 Overview of User Management in Alma.............................................. 9
Chapter 3 User Management.................................................................................... 11
Managing Users........................................................................................ 11
Adding Users .........................................................................................15
Editing Users .........................................................................................46
Deleting Users ........................................................................................48
Deactivating Users .................................................................................49
Distributing Users .................................................................................50
Unlocking Locked‐Out Users .................................................................50
Converting Users from External to Internal......................................... 50
Purging Users............................................................................................ 51
Notifying Users......................................................................................... 53
Waiving Fines in Bulk.............................................................................. 53
Managing User Roles............................................................................... 57
Adding Roles to Users ............................................................................57
Editing Roles Assigned to Users ............................................................60
Removing Roles from Users ...................................................................62
User Roles – Descriptions and Accessible Components ........................62
Managing Circulation Desk Operators .................................................81
Roles Managed at the Library Level .......................................................85
User Sets..................................................................................................... 86
User Identifiers .......................................................................................87
Chapter 4 Configuring User Management............................................................ 89
User Management Activities................................................................... 89
Roles and Registration Configuration................................................... 92
Configuring Role Profiles .......................................................................93
Configuring Role Assignment Rules .....................................................98
Configuring User Registration Rules ..................................................101
Roles Report .........................................................................................105
Privileges Report ..................................................................................106
Mandatory Fields Configuration.......................................................... 108
December 2015 3
Ex Libris Confidential
Alma Fulfillment
Table of Contents
Configuring UserMandatory Fields – Public  .....................................108
Configuring UserMandatory Fields – Staff  ........................................111
Configuring User Mandatory Fields – External Contacts ..................114
User Details Configuration................................................................... 117
Configuring User Groups ....................................................................117
Configuring User Record Type/User Group Sets ................................121
Configuring Job Categories ..................................................................125
Configuring User RecordTypes/Job Category Sets  .............................129
Configuring UserName Display  .........................................................133
Configuring Statistical Categories .......................................................135
Creating Statistical Category Types ....................................................138
Mapping Statistical Categories to Category Types .............................140
Configuring User Titles .......................................................................141
Patron Charges Configuration.............................................................. 143
Configuring Fines/Fees Behavior .........................................................143
Configuring Reasons for Waiving Fines/Fees ......................................145
Configuring Fines/Fees Notification Profiles ......................................148
Configuring Other Settings................................................................... 149
Configuring User Notification Types.................................................. 153
Configuring User Information for Pop‐ups........................................ 156
Configuring User ID Generation.......................................................... 158
Configuring Delete User Policy Settings............................................. 158
Linking Users in Collaborative Networks.......................................... 160
Configuring Linked Account Rules .....................................................160
Chapter 5 Advanced Tools...................................................................................... 163
HealthCheck Tool................................................................................... 163
Chapter 6 Configuring General Alma Functions............................................... 169
Configuring General Activities............................................................ 169
Libraries................................................................................................... 172
Managing Institutions and Libraries ...................................................172
Configuring General Relationships .....................................................184
Configuring Campuses ........................................................................184
Locations.................................................................................................. 189
Configuring Physical Locations ...........................................................189
Configuring Remote Storage Facilities ................................................190
Work Orders and Departments............................................................ 190
4 December 2015
Ex Libris Confidential
Alma Fulfillment
Table of Contents
Configuring Work Order Types ...........................................................191
Configuring Work Order Type Statuses ..............................................198
Configuring Work Order Departments ...............................................200
External Systems..................................................................................... 203
Configuring Integration Profiles ..........................................................204
Configuring S/FTP Connections .........................................................208
Configuring Allowed Emails ................................................................212
Configuring Allowed S/FTP Connections During Testing .................215
Branding/Logo........................................................................................ 217
Configuring Alma Branding ................................................................217
Configuring Skins ................................................................................219
Configuring Alma Letters..................................................................... 219
Configuring Other Settings................................................................... 261
Configuring Institution Languages...................................................... 267
Configuring CRM Contacts................................................................... 268
Staff Login Report................................................................................... 269
Widgets.................................................................................................... 270
Configuring Widgets ............................................................................270
Adding a Widget .............................................................................271
Configuring the Home Page Notification Widget ..........................272
Configuring Primo Widgets .................................................................273
Security..................................................................................................... 274
Configuring IP Group Configuration ..................................................274
Configuring Login Restriction Configuration .....................................276
Configuring a User to Not Have IP Restrictions Apply .....................278
Importing Information to Code Tables................................................ 279
Chapter 7 Managing Jobs........................................................................................ 283
Overview of Jobs..................................................................................... 283
Overview of Profiles .............................................................................284
Running Manual Jobs on Defined Sets................................................ 285
Manual Jobs and Their Relevant Parameters .................................290
Viewing Scheduled Jobs........................................................................ 312
Viewing Scheduled Job Summary Status .............................................312
Viewing All Scheduled Jobs ..................................................................313
Configuring Email Notifications for Scheduled Jobs ......................329
December 2015 5
Ex Libris Confidential
Alma Fulfillment
Table of Contents
Viewing Running Jobs........................................................................... 331
Job Types with Their Own Management Pages .............................332
Viewing Completed Jobs....................................................................... 334
Viewing Job Reports .............................................................................338
Viewing Authority Processes Job Reports ......................................339
Viewing Deleted Records Job Report ..............................................339
Viewing the Link Local Electronic Resources to the Community 
Zone Job Report ...............................................................................340
Viewing the Overlap Analysis Job Report ......................................341
Viewing Network Publishing Job Report ........................................345
Viewing Lost Loan Job Report ........................................................345
Viewing EDI Job Reports ................................................................346
Viewing the Export PO Lines (POL) Job Report ............................349
Viewing Extracted Electronic Portfolio URLs Job Report ..............349
Viewing Dematic ASRS Job Report ................................................349
Viewing Records Not Imported Due to Version Prevention in a Job 
Report ..............................................................................................351
Viewing Analytics Scheduled Job Report .......................................353
Viewing Job Events ..............................................................................353
6 December 2015
Ex Libris Confidential
1
Introduction to Administration
This guide describes general administration tasks that affect all areas of Alms, 
including user management and configuration, general configuration options, 
and managing jobs. This guide contains the following sections:
 Overview of User Management in Alma – This section provides an 
overview of the way in which users are created and managed in Alma. For a 
detailed explanation, see Overview of User Management in Alma on 
page9.
 User Management – This section governs user information that is managed 
by an authorized operator. User management includes the management of 
both public, staff, and contact users. For a detailed explanation, see User 
Management on page11.
 User Configuration – This section describes configuration management 
activities. For a detailed explanation, see Configuring User Management on 
page89.
 General Configuration – This section describes Administration 
configuration activities. For a detailed explanation, see Configuring 
General Alma Functions on page169.
 Alma Jobs ‐ This section provides an overview of jobs in Alma and 
describes how to run and monitor them. For a detailed explanation, see 
Managing Jobs on page283.
Additional administration tasks that are relevant to specific sections of Alma are 
presented in other sections, including:
 The sandbox environment: Alma Sandbox Environments in the Alma 
Sandbox Environments Guide
 Resource management: Configuring Resource Management in the 
Alma Resource Management Guide
 Fulfillment: Configuring Fulfillment in the Alma Fulfillment Guide
 Acquisitions: Configuring Acquisitions in the Alma Acquisitions Guide
 Integrating with external systems: Acquisitions, Resource 
Management, Fulfillment, User Management, General, and bX in the 
Alma Integrations with External Systems Guide
December 2015 7
Ex Libris Confidential
Alma Fulfillment
Chapter 1: Introduction to Administration
 Integrating with Primo: Basic Primo Configuration for Integration 
with Alma, Configuring the Primo Front End for an Alma Data 
Source, Configuring the Primo Front End for Alma’s Link Resolver, 
and Configuring Alma’s Delivery System in the Alma‐Primo Integration 
Guide
8 December 2015
Ex Libris Confidential
2
Overview of User Management in Alma
A complete overview of the way in which users are created and managed in 
Alma is provided on the Developer Network. The user management sections on 
the Developer Network are organized as follows:
 Information on user accounts (internal and external users), user record 
structure, user roles and types, and user identifiers (including information 
on sharing user IDs in a fulfillment network) can be found on the following 
page: https://developers.exlibrisgroup.com/alma/integrations/user‐
management
 Information on Student Information Systems (SIS), loading external users 
from SIS into Alma, and synchronizing SIS users with Alma can be found on 
the following page: https://developers.exlibrisgroup.com/alma/integrations/
user‐management/sis
 Information on authenticating external users in LDAP can be found on the 
following page: https://developers.exlibrisgroup.com/alma/integrations/
user‐management/authentication/ldap
 Information on authentication using SAML can be found on the following 
page: https://developers.exlibrisgroup.com/alma/integrations/user‐
management/authentication/saml
 Information on authentication using CAS can be found on the following 
page: https://developers.exlibrisgroup.com/alma/integrations/user‐
management/authentication/CAS
 Information on the authentication of Primo users to retrieve Alma 
information can be found on the following page: https://
developers.exlibrisgroup.com/alma/integrations/user‐management/
authentication/primo 
December 2015 9
Ex Libris Confidential
Alma Fulfillment
Chapter 2: Overview of User Management in Alma
10 December 2015
Ex Libris Confidential