Back
General
Subscribe by RSS
Share page by email
Save as PDF
Share
Discovery Interface Display Logic Configuring Copyright Management
Configuring Fulfillment Jobs
To configure fulfillment jobs, you must have one of the following roles:
You can configure some aspects of some fulfillment jobs on the Fulfillment Jobs Configuration page (Configuration Menu > Fulfillment > General > Fulfillment Jobs Configuration). Configurations performed on this page are applicable at the institution level only.
Fulfillment Jobs Configuration Page
For more information on these jobs, see Viewing Scheduled Jobs.
If a scheduled job is not run, the records that were missed are selected for the following run. This is true for all jobs except for Send Overdue Notices.
Each job may be activated, deactivated, or scheduled. Additionally:
For details on letters that Alma sends to patrons with these jobs, see Configuring Alma Letters.
Configuring Anonymization
This section deals with transactional anonymization relating to transactions of type loans, fines and fees, resource sharing requests, and requests. For information about non-transactional anonymization, see Anonymizing Analytics Report Details.
To configure the Anonymization job:
The should_anonymize_requests_immediately_when_complete parameter, when set to true anonymizes the request as soon as it is completed and also ignores the anonymization rules.
When the job runs, the Borrower Name and Borrower ID are removed from the item history of all loaned items. For example, before the job runs, the Borrower Name and Borrower ID are displayed:
Loan History
After the job runs, the Borrower Name and Borrower ID do not appear:
Loan History After Anonymization
For anonymization to occur in Alma Analytics, first the Handle Historical Archiving job must be run and then the ETL must occur. After anonymization, none of the user details are displayed in Analytics; however, the following information is displayed:
Analytics After Anonymization
To configure Anonymization Rules:
Loan Anonymization Rule Editor
  1. After selecting any of the anonymize options, each option has a rules link next to it. Select the link. The anonymization rules are activated only when the Anonymize item loans check box is selected.
  2. Add a new rule or edit an existing rule.
  3. The input parameters are as follows:
    Loan
    Days since loan ended
    <, >, =, not equals
    Whole numbers are counted. So if Days since loan ended > 1 and the loan ended yesterday, the loan is not anonymized.
    Days since user expiry
    <, >, =, not equals
    Whole numbers are counted. So if Days since user expiry > 1 and the user expired yesterday, the loan is not anonymized.
    Library
    =, in list, is empty, is not empty, not equals, not in list, contains
     
    Location
    =, in list, is empty, is not empty, not equals, not in list, contains
    If Library input was added, the location list is populated according to the selected libraries.
    If library input was not added, the list is empty.
    Number of loans to retain
    =
    For example, if a rule is set with Number of loans to retain = 3 and there are three loan history records for an item, they are not anonymized. If there are four loan history records for the item then only the oldest one is anonymized.
    User group
    =, in list, is empty, is not empty, not equals, not in list, contains
     
    Fines and Fees
    Days since fine/fee closed
    <, >, =, not equals
     
    Days since user expiry
    <, >, =, not equals
     
    Library
    =, in list, is empty, is not empty, not equals, not in list, contains
     
    User group
    =, in list, not equals, not in list
     
    Request Anonymization Rule
    Days since request ended
    <, >, =, not equals
     
    Days since user expiry
    <, >, =, not equals
     
    Library
    =, in list, is empty, is not empty, not equals, not in list, contains
     
    Location
    =, in list, is empty, is not empty, not equals, not in list, contains
     
    User group
    =, in list, not equals, not in list
     
    Borrowing Request Anonymization Rules
    Days since borrowing request ended
    <, >, =, not equals
     
    Days since user expiry
    <, >, =, not equals
     
    Library
    =, in list, is empty, is not empty, not equals, not in list, contains
     
    User group
    =, in list, not equals, not in list
     
    When a request is fulfilled, if there are multiple items available and the request was attached to a specific item (for instance, item level request or item already fulfilled the request) the library and location of the item is used. If the request can still be fulfilled by multiple items, the library and location are taken from the holding selected automatically as preferred for fulfilling the request.
  4. Select True or False for the output parameter, Anonymize.
  5. Select Save.
By default, the Loan Anonymization Rules are set to False. In cases where select loan types should not be anonymized, the rule should be set to False.
Configuring Other Settings (Fulfillment)
To configure other settings, you must have one of the following roles:
This option enables you to customize settings that are not specific to any other fulfillment action. These other settings can be configured on the institution level only.
You configure other settings on the Customer Parameters Mapping Table page (Configuration Menu > Fulfillment > General > Other Settings).
Mapping Table Page – Other Settings
Other settings can be configured at the institution level only. Select the required institution from the Configuring filter on the Configuration page.
The following table describes the Other Settings options:
Other Settings Options
Parameter KeyDescription
add_checked_at_information_to_loan_details_in_primoSet to true to enable to the display of the checkout location on the Location field on the Primo My Account Loans. By default, this parameter is set to false, which suppresses the checkout location.
allow_activity_on_transferred_finesfeesIf the bursar import is activated and this is set to true, you can perform activities such as payment or waive on fines/fees that have been exported to the bursar system. The Waive link appears on the row action menu of the Fines/Fees tab of the User Details page when this parameter is set to true. When set to false, which is the default, transferred fees cannot be changed. See Managing User Fines and Fees.
auto_renew_loan_daysThe number of days entered determines which loans are considered for automatic renewal. So, for instance, if auto_renew_loan_days contains 7, all loans whose due date is within the next 7 days are considered. For those loans, the renewal is carried out according to the automatic renewal policies. See Configuring Automatic Loan Renewal Rules.
auto_attach_digitization_to_citation
New for April!
Set to true to include an option to automatically attach files to a citation in a digitization request. When set to false, the option is unavailable.
blocks_display_remove_duplicatesDetermines whether to display only one block of each type when a user has multiple blocks of the same type. 
When false, which is the default, all blocks are displayed. When true, duplicate blocks are removed from the following displays:
  • The blocks list in the Primo My account page.
  • The pop-up window that displays blocks when attempting to loan or renew an item for a blocked user.
  • The failure message that displays when attempting to create a request for a blocked user, in both Alma and Primo.
borrower_document_delivery_maximum_viewsThe maximum number of times patrons are able to access the link for a file delivered by a resource sharing document delivery service
borrower_document_delivery_send_automaticallyDetermines if an email to the patron is sent automatically when a digital document is received on the borrower side as a link
check_patron_duplicate_borrowing_requests
Set to true to enable a check to verify that the request is not a duplicate of an already existing active request for the user. The fields that Alma uses to determine if the request is a duplicate are:
  • Requester ID
  • Title
  • Journal Title
  • OCLC Number
  • ISBN/ISSN
  • Volume
  • Chapter
  • Pages
  • Issue
  • Comment
If the requests are the same, a message appears to indicate that the new request is not saved. The text of the message can be configured on the Labels page (c.uresolver.request.ill.patron_has_duplicate_request). By default, this is set to false, which does not enable the check for duplicates. See Managing Resource Sharing Borrowing Requests.
check_self_ownership_serialSet to true to enable self-ownership checks to be performed for serial titles; the Resource Sharing link is hidden in the Get It/View It tabs in Primo. When false, self-ownership checks are not performed for serial titles, and the Resource Sharing link displays in Primo whether or not the serial is self-owned.
citation_solr_max_size_for_groupingThe maximum number of citations to include in a group query. Note that limiting the group size improves query speed but causes incorrect results in the facets count.
citation_rs_default_actual_pickup_location
 
 
(Optional) The default actual pickup location code when initiating a resource sharing request for a citation. When set, the checkbox For Reading-Room Use Only is selected in the request form (and cannot be disabled). This parameter is ignored if citation_rs_default_requester​, citation_rs_default_owner, and citation_rs_default_requested_pickup_location are not set. See Managing Citations and Creating a Borrowing Request.
citation_rs_default_owner(Optional) The default resource sharing library code owning the request when initiating a resource sharing request for a citation. This parameter is ignored if citation_rs_default_requester is not set. See Managing Citations and Creating a Borrowing Request.
citation_rs_default_requested_pickup_location(Optional) The default requested pickup location code when initiating a resource sharing request for a citation. This parameter is ignored if citation_rs_default_requester and citation_rs_default_owner are not set. See Managing Citations and Creating a Borrowing Request.
citation_rs_default_requester(Optional) The default requesting librarian username when initiating a resource sharing request for a citation. See Managing Citations and Creating a Borrowing Request.
close_paid_lost_loanSet to true to enable a loan status to be changed to Lost and paid and the loan closed when an on loan item's status was changed to Lost and the last lost or replacement fee is closed. When set to false, which is the default for customers installed prior to the January 2019 release, the loan remains active in the loan list until the Close Lost Loans job is executed, and the item process type is changed to Lost even if the patron paid the lost fees. See Lost Loan Management.
copyright_regionThe two letter country code indicating the institution's region. Used for determining copyright licensing options and approval. The values are case sensitive.
Currently, the only values that have any effect are:
  • UK - Alma adds additional UK-related options to the Source for Copyright field (see Creating a Request) and the Creative Commons License field (see Managing Citations). In addition, Leganto integration with the UK Copyright Licensing Agency (CLA) and the Digital Content Store (DCS) is enabled; see Integrating with the UK's Digital Content Store (DCS). The Source for Copyright options are:
    • A - From paper original owned by institution
    • B - From digital original licensed to institution
    • C - From copyright fee paid copy
    • D - From another HEI under sharing provision
  • AU (Australia) - Alma adds additional AU-related options to the Source for Copyright field (see Creating a Request) and the Creative Commons License field (see Managing Citations). The Source for Copyright options are:
    • W - Electronic and non Paginated
    • P - Hardcopy, or Electronic and Paginated
    • G - Graphic/Artwork only
default_course_end_dateThe default end date selected when adding a course (see Adding a Course). If not set, the current date is used. The date must be formatted according to the institution's date format.
default_course_start_dateThe default start date selected when adding a course (see Adding a Course). If not set, the current date is used. The date must be formatted according to the institution's date format.
default_user_group_for_fulfillment_network_locateUsed by a resource sharing lender to define the default user group for the fulfillment network locate process and its rules calculation. Any institution level user group code can be used. By default, the value is empty. See Fulfillment Network Partner Configuration.
delivery_service_allowed_originsWhen receiving a JSON HTTP response to your digital file viewer request (see Configuring Digital File Viewer Services), you can ask Alma to add a URL for the CORS Access-Control-Allow-Origin header in the response. When left empty, Alma uses the request URL.
demand_in_other_lists_start_dateWhich courses to check for demand. Possible values:
  • <no value> – scan all courses
  • active – scan only active courses
  • date – scan courses from this date and later (in date format configured in system_date_format format)
demerit_enableSet to true to enable demerit functionality. For more information, see Enabling the Demerit System.
demerit_history_daysThe length of the demerit tracking period in days. If the user's demerit points exceed the value specified in the demerit_maximum_threshold parameter during the demerit tracking period (that is the last number of days specified by this parameter), the system places a block on the user. For more information, see Enabling the Demerit System.
demerit_maximum_thresholdThe maximum number of points allowed during the tracking period. For more information, see Enabling the Demerit System.
demerit_suspension_daysThe length of a user's suspension period in days. For more information, see Enabling the Demerit System.
display_additional_digitization_attributesSet to true to show the following partial digitization fields on the Get It form.
  • chapterArticleAuthor
  • chapterArticleTitle
  • startPage
  • endPage
Set to false to suppress the partial digitization fields from the Get It form.
For more information, see Customizing Primo Request Forms.
display_course_studentsSet to true to display the course’s list of students on the Manage Course Information Page.
distribute_fulfill_changes_last_runThe last run of the Distribute network fulfillment changes to members job. Relevant only for the Network Zone. See Configuring Fulfillment Information in the Network Zone.
document_delivery_cleanup_daysThe number of days that digitized files remain on the document server. The default is 30, and the maximum is 90. See Attaching Digitized Items To Be Sent To a Patron.
email_partner_configurable_line1Not currently supported
email_partner_configurable_line2Not currently supported
enable_booking_workflowWhen true, booking requests behave as all other patron physical requests. When false, a booking request is not activated, does not go through the hold shelf workflow, and does not appear in task lists.
enable_moving_item_to_hold_shelf_from_self_checkIf set to false (which is the default value), a requested item that is checked in using a self-check machine is not placed on the hold shelf and the On Hold Shelf Letter is not sent. If set to true, the item is placed on the hold shelf and the On Hold Shelf Letter is sent.
Note that the system determines whether the item should be placed on the hold shelf or enter hold shelf processing based on the definition of the Has hold shelf processing parameter at the circulation desk. It is also relevant only for self-check circulation desks with hold shelves. If there is no hold shelf at the circulation desk, the item enters the transit process.
enable_open_access_services_from_unpaywall_apiSet this customer parameter to true to include the open access service (when available) in the link resolver View It. When this customer parameter is set to false, the open access service is excluded from the link resolver View It.
With this customer parameter set to true, the option Disable direct linking when Open Access service is available appears in the Direct Linking Configuration options. See Configuring Direct Linking for more information.
The default setting for this parameter is false.
enable_request_during_loan_for_different_ policySet to true to enable patrons to request an item belonging to a bibliographic record for which the patron already has an item on loan, if the newly requested item has a different loan period policy than the original item.
exclude_lost_and_claimed_returned_loans_from_overdueSet to True to exclude lost and claimed returned loans from the overdue limit (number of loans that are allowed to be overdue).
export_xlsx_fines_fees_reportSet to True to generate the Fines and Fees Report file in *,xlsx format. When the parameter is false, *.xls format is generated.
ful_network_default_pickup_instThe initial value of the pickup institution field in a fulfillment network request form.
  • blank: The initial value of the pickup institution is blank.
  • patron: The initial value is set to the patron's institution, meaning that linked account users show the patron's source institution.
  • local: The initial value is set to the local institution, as it has been in the past. This is the default.
fulfillment_network_shared_primoSet to true to indicate that when working with local fulfillment network members (and not a Network Zone), you can use the Intellectual Entity information to enable the borrower to locate the item more accurately on the lender side.
fulfillment_network_unique_barcodes
Whether a fulfillment network uses unique item barcodes:
  • FULL - Barcodes are unique across all members of the fulfillment network and are not duplicated. The Item Owner drop-down list does not appear on the Manage Patron Services, Return Items, or Scan In pages. Alma searches for the barcode, first locally, then in all other institutions. The search completes as soon as the barcode is matched and processing continues automatically.
    Because the Full setting widens the search, this may impact performance.
  • NONE - Barcodes are not unique. This is the default.
generate_resource_sharing_temp_barcodeWhether the resource sharing library can use an automatically generated temporary barcode to receive and circulate a borrowed item. The barcode is based on the resource sharing request’s external identifier (see the External identifier field in the Request Attribute Field table in Creating a Borrowing Request).
getit_use_alphabetical_sortingSet to true to use alphabetical sorting only when sorting holdings in the Primo Get It page. When set to false, which is the default, other sort criteria will be included. See Configuring the Order of Locations in Primo Search Results.
hide_single_holding_getit_detailsWhen set to false (default), Get It displays a single holding's items with the holding's details expanded for a single holding. When set to true, the holding's details are initially collapsed. The holding's details are always collapsed if there are multiple holdings and one was explicitly opened. This parameter is only applied if the Primo View to Alma Libraries table is empty. See Filtering the Library List for Availability in Primo.
hold_shelf_additional_id_regex
This controls the format of the Additional ID, which is used in the following places:
  • Pick from shelf task list - The ID is hidden by default and can be added in the manage column display menu.
  • Pick from shelf slips
  • Hold shelf slips
  • Hold shelf email to the patron
  • Circulation desk hold shelf configuration
  • Active and Expired Hold Shelf task lists
The value is empty by default. When left empty, the Additional ID defaults to displaying with hyphens between every three digits, after truncating the last seven digits. To indicate a different display, enter a regular expression. The format is s/<regex>/<destination>. If an error is encountered in the value's format, the default format for Additional ID is used.
ignore_lender_due_dateSet to true to ignore a request's due date when loaning an item to a patron. The due date is instead calculated according to the Terms of Use defined in the fulfillment unit.
Additionally, this parameter controls the calculation of the expiration of items on the hold shelf. When set to true, the expiration date is calculated as the current date plus Maximum time on hold shelf (Days) from the circulation desk configuration. When set to false, the expiration date is calculated as the Due Date from the borrowing resource sharing request minus the Delivery Delay (days) from the Resource Sharing Partner record.
ill_item_creation_lib_codeThe default code of the library in which to create the temporary items for resource sharing.
When working with multicampus libraries, leave this value blank and assign a resource sharing library in the patron record.
Set to ALL to enable all configured resource sharing libraries to be enabled for all patrons. If a patron’s specific Terms of Use indicates that resource sharing libraries are not enabled, the patron’s Terms of Use overrides this setting.
ill_item_creation_loc_codeThe default code of the location in which to create the temporary items for resource sharing.
When working with multicampus libraries, leave this value blank and do the following:
include_transferred_finesfees_in_alma_limitsIf the bursar import is activated and this is set to true, fines and fees transferred to the bursar system are included when calculating the user cash limit and the amount for user option in the Fines/Fees Notification Profile. When set to false, which is the default, the transferred fees are not taken into account. See Managing User Fines and Fees.
instructor_role_expiration_monthsThe number of months until the automatically added instructor role expires
maximum_overdue_block_per_blockDetermines whether the Maximum Period for Overdue Block policy is applied to each block or to all the blocks in total. When the Block When Overdue policy is set to a cumulative option:
  • If this parameter is set to true, the Maximum Period for Overdue Block policy is checked against each block separately.
  • If this parameter is set to false, the Maximum Period for Overdue Block policy is checked against the total block period. If the maximum period is already blocked, then no new block will be created.
missing_item_requestableSet to true to enable requesting items marked as missing.
network_display_logic_distribution_members_behaviorControls deactivation or deletion of institution rules at distribution time. The values for this parameter are None, Remove, and Deactivate. The default is None, which does not change the institution rules. Remove removes all institution rules. Deactivate deactivates all institution rules.
network_display_logic_rules_precedenceWhether the Network or Institution level Display Logic Rules are executed first. The default is False, which sets the institution rule to taking precedence. True defines the Network Zone rule as having precedence.
network_ges_distribution_members_behaviorControls what is done with a member institution's general electronic services records when the Network Zone's records are distributed. Valid values are: Remove, Deactivate, and None. Remove removes all the local records. Deactivate retains the local records but deactivate them. None, which is the default, leaves all previously existing records exactly as they were before the distribution.
network_rota_assignment_rules_precedenceWhether the Network, Institution, or Library level rota assignment rules are executed first when running the Distribute central resource sharing configuration job.
network_sending_rules_precedenceWhether the Network, Institution, or Library level sending borrowing request rules are executed first when a new borrowing request is created.
When set to true the following rules are applied:
  • If Network Zone rules exist, they are used.
  • If not, then if library level rules exist, they are used (if no match is found, the default library level rule is applied). 
  • If neither Network Zone rules or library level rules exist, institution level rules are used (if no match is found, the default institution level rule is applied). 
When set to false the following rules are applied:
  • If library level rules exist, they are used. 
  • If not, institution level rules are used. 
on_locateWhether a citation's information is overridden by any conflicting repository information after Alma finds a match in the repository. After a match is found: when set to overlay, Alma overrides the information in the citation with information in the repository (if the information is missing in the repository, the information in the citation remains as is); when set to merge, Alma merges the information in the citation with the information in the repository (in other words, only missing citation information is filled in using information from the repository); when set to ignore, Alma ignores the information in the repository.
overdue_at_change_due_dateWhen set to true (the default), if a due date is changed on an already overdue loan, an overdue fine is created before the due date is updated (similar to the the renew process) to make sure that a potential overdue fine is not automatically dropped. To dismiss the charge in this case, set to false. See Adding an Overdue and Lost Profile and Changing Loan Due Dates in Bulk.
overdue_at_claim_return_loanSet to true if you want fines to stop accruing for items that were claimed to be returned (any fines already accrued get added to the user’s total). Otherwise, set to false to have the fines continue to accrue.
overdue_at_lost_loanThe value of this parameter determines:
  • Whether the overdue fine is applied to the user's balance when the loan is updated to lost.
  • Whether the overdue fine continues to accrue while the loan is lost.
An overdue fine continues to accrue until it is applied. Once it is applied, it stops accruing. If this parameter is set to true, the overdue fine is applied when the loan is marked as Lost and, therefore, stops accruing. If set to false, the overdue fine is not applied when the loan is marked as Lost and, therefore, continues to accrue. In this case, if the lost loan is returned, the accrued fine is applied.
overdue_lost_loan_profile_ignore_due_hourWhether the due hour is taken into consideration when calculating if the loan is overdue in overdue and lost loan profiles.
When set to false, which is the default, if the profile is set to match on 1 overdue day, then a loan that was due yesterday at 12:00 is considered overdue today at 12:01. If the due hour of the loan has not been reached when the job runs, the loan is not considered overdue until the following day.
If set to true, the loan is considered a match immediately on the next calendar day, ignoring the due hour. So when the job runs on that day the loan is not considered overdue regardless of the hour.
This parameter applies only to the Loans – Overdue and Lost Item job and not to overdue blocks.
overlay_no_typeThe overlay_no_type value gives added control on how existing secondary citation type is handled when a repository match is found.
patron_services_timeout_minutesThe number of minutes after which the Patron Services page closes.
You can configure a value between 1-30 minutes. The default value is 2 minutes.
personal_copy_fuThe fulfillment unit code for the virtual location of the instructor's personal copy. If empty, the location is created without a fulfillment unit.
personal_copy_libraryThe library code of the virtual library that contains the virtual locations required to identify resources belonging to library staff. Leave empty to disable allowing instructors to note a citation as a personal copy.
prefer_doc_delivery_from_e-resourcesSet to true if you prefer to do digitization from electronic resource rather than from print resource when both exist.
prefer_remote_storageSet to true to assign priority to remote storage items when viewing results in the Primo Get It tab, publishing to Primo, or the Primo Real-Time Availability (RTA).
primo_loan_list_sortingThe order in which loans are sorted in Primo My Account > Loans. By default, the loans are listed in descending order by due date. The valid values are ascending and descending.
Primo_VE_MANUAL_ALTERNATIVE_EMAIL_VE_RSSet to true to require entering an alternative e-mail to be added to the digital resource sharing request.
Primo_VE_photocopy_other_pickupSet to true to allow selecting a pickup location other than the resource sharing library on the Photocopy on Primo VE ILL form.
rapidill_extended_borrowing_integrationSet to true to activate the RapidILL integration options on the borrower side.
rapidill_extended_integrationSet to true to activate the RapidILL integration options on the lender side.
reading_list_auto_locate_citation_upon_creationWhen true, when a librarian creates a non-repository citation, Alma tries to match and link the citation to an inventory item. If Alma succeeds, the citation's status is Resource Located. Otherwise its status is Location Failed .
When false, the librarian still can attempt to match the citation to inventory manually.
reading_list_citation_sortingDetermines the sort order of the citations in a reading list. Enter TITLE, AUTHOR, CALLNUMBER, CREATEDATE., or INSTRUCTORORDER (Leganto only: this sets the order according to the ordering set by the instructor in Leganto). The default value is TITLE. See Managing Citations.
recall_during_loan_prefer_oldest_loanIf there are multiple copies of an item, and multiple requests on the item, when the last copy is checked out, if there are still requests on the item, this parameter determines which loan to recall. Set to true to recall the oldest loan instead of recalling the item which is currently being loaned. Set to false, which is the default behavior, to recall the current loan.
remember_last_loan_displaySet to true for the Patron Services page to display loans according to the last option selected by the operator (either all loans (All) or only those in the current session (This session)). When indicating false, only loans for the current session (This session) display.
renew_all_loan_thresholdWhen higher than 0, the maximum number of loans that may be renewed simultaneously when selecting Renew All from Primo My Account. If the user attempts to renew more loans than the threshold, Alma returns a new error code, 0037, and an error message.
0 (default) indicates no limit on the number of loans that can be renewed at once.
requester_note_auto_generateSet to true to automatically create a requester note when a purchase request is created from a reading list citation. The note is created with information about the course, instructor, number of copies, and number of participants.
resource_locate_by_typeDetermines the material types by which to locate resources. Possible values for this parameter are the material type codes defined in the Citation Material Type table.
resource_locate_modeDetermines the mode for locating a resource.  If you set the value of this field to OR, then Leganto will locate citations based on any of the fields in the Locate Citations By Fields mapping table. If you set the value of this field to AND, then Leganto will locate citations based on all the fields in the Locate Citations By Fields mapping table.
resource_locate_multiple_matchesDefault action for the Process and Enrich Citations in Bulk job when multiple matches are found. Values: manually (default), or first_by_inventory_type. See Process and Enrich Citations in Bulk and the parameter resource_locate_multiple_matches_priority​.
Note: If you are using Leganto, this also determines the behavior for auto-locating resources for citations added by instructors.
resource_locate_multiple_matches_priorityWhen you select first_by_inventory_type for resource_locate_multiple_matches​, set the priorities for matching using the values E (electronic), P (physical), and/or D (digital). in priority order, separated by commas. For example, E, P indicates first priority electronic, second priority physical, and not to consider digital matches. See Process and Enrich Citations in Bulk.
Note: If you are using Leganto, this parameter also determines the behavior for auto-locating resources for citations added by instructors.
resource_sharing_protocolThe value displayed to an NCIP peer-to-peer partner when a Lookup Agency action is invoked from the partner's system. For more information, see the NCIP peer-to-peer parameters list on the Resource Sharing Request page
results_best_location_enableSet to true to prioritize the results list according to your location when using Get It and RTA services. The default setting is false.
For physical items, setting the value to true causes the holdings locations in the discovery system search results to be displayed according to the proximity of available items to the patron. The default value of false causes the holdings locations to be displayed according to availability without regard to the patron’s physical location. Available items in temporary locations are displayed at the top, followed by those in permanent locations, and followed by those in remote locations.
Alma is able to display the list of holdings locations in the discovery system search results according to the proximity of the patron by comparing the IP address of the patron with the IP addresses of libraries with holdings for the searched item. In order to utilize this functionality, libraries must be configured with IP addresses (see Configuring IP Ranges for a Library).
return_lost_loan_from_self_checkIf false, and a check-in message is sent to Alma for an item that is currently declared lost, the return action is blocked and a message is displayed to the patron, directing him or her to a circulation desk. The default is true.
rl_auto_assignWhether to automatically assign a reading list to a user who works on it. Set to all to automatically assign all lists to the user who works on them. Set to unassigned to automatically assign only unassigned lists. Set to none to disabled auto-assignment. See Editing a Reading List.
rs_add_currency_to_mashup_formSet to false to suppress the currency on the Maximum Fee field label on the Primo resource sharing form.
Set to true to display the currency on the Maximum Fee field label on the Primo resource sharing form.
rs_allow_actions_on_scan_inAllows or prevents receiving and shipping from the Scan In Items page as well as shipping from Manage Items Returns and loaning from Manage Patron Services when the item has not been received. When set to false, an error message with an override option appears when a borrowing or lending request is scanned in from the Scan In Items page at a desk of a resource sharing library which is the owner of the request or when a loan is executed from the Manage Patron Services page but the item has not yet been received. An error message also appears on the Manage Items Returns page that does not include an override option. When set to true, executing these processes does not produce the error message. The default is true.
For more information, see Scanning Items.
rs_auto_request_lendingSet to true to enable automatically placing move/digitization requests for incoming lending requests that match an existing resource. A move request is placed if the resource is requested in physical format. A digitization request is placed if the resource is requested in digital format.
The digitization department and pickup location for the resource are specified in rs_default_digitization_department and rs_default_pickup_location​, respectively.
rs_auto_request_lending_with_serialsIf a lending request is created and is associated with at least one serial item, setting this parameter to false stops an associated move/digitization request from being automatically created. If set to true, the move/digitization request is still created. If set to general, the move/digitization request will be a general request, see steps 8-9 here for details about the processing of general requests
The default is true.
rs_auto_request_lending_with_volume_issueSet to false to prevent a move/digitization request from being automatically created for a lending request if the borrowing request sent to the lender contains a volume or issue because the move/digitization request may not identify the correct volume or issue. If set to general, the move/digitization request will be a general request, see steps 8-9 here for details about the processing of general requests
The default for this parameter is true, which corresponds to the existing functionality. This parameter has no effect on borrowing requests that do not contain a volume or issue.
rs_block_sending_requester_infoAllows patron information to be suppressed from a resource sharing request that is sent to another institution. The default is false. When set to true, the Send Requester Information check box on the ISO partner parameters is hidden.
rs_borrower_copyright_managementSet to true to apply a check of copyright approval on a resource sharing digital borrowing request. Setting this parameter to true also displays the Copyright Status page on the fulfillment configuration menu (see Configuring Resource Sharing Copyright Statuses).
rs_default_digitization_departmentThe name of the digitization department to which the resource that matches a lending request is to be moved.
rs_default_pickup_locationThe pickup location for the resource that matches the borrowing request, in the following format: <library code.location code>
rs_disable_borrowing_auto_assignSet to false to automatically assign borrowing requests to the logged in operator for requests created manually or saved in Alma. If you do not want borrowing request to be automatically assigned, set to true. This is the default value.
For more information, see Reassigning a Task.
rs_disable_lending_auto_assignSet to true to ensure that when editing a resource sharing lending request that is either unassigned or assigned to other users (that is, the request appears on the Unassigned or Assigned to Others tab on the Resource Sharing Lending Requests Task List page), the request is assigned to the editing user only when selecting Reassign for the request. When selecting any other editing option, the request remains either on the Unassigned or Assigned to Others tab.
Indicate false to ensure that selecting any editing option automatically assigns the request to the editing user (that is, the request moves to the Assigned to Me tab).
rs_display_items_not_requestableSet to true to display items that are not requestable in the physical services list in Manage Fulfillment Options of lending requests. This is the default value.
Set to false to suppress items that are not requestable.
rs_display_level_of_serviceSet to true to display the level of service on the Primo request form.
rs_enable_lending_ship_warn_popupSet to true to show a warning pop-up before automatically creating a lending request from a shipping item. Set to false to automatically create the request without the warning message. For more information, see Shipping Items.
rs_external_id_prefixThis sets the external identifier format. Possible values are code or id. If set to code, the external ID is created as {institution code + a generated number} (as it was previously). If set to id, the external ID is created as {customer Id + institution id + a generated number}.
rs_fail_locate_multiple_resultsDetermines how to handle a locate that returns multiple results from the lender. When set to false, the locate returns one matching result randomly. When set to true, the locate fails due to the multiple results. See Borrowing Locate Process
rs_failure_note_need_dismissDetermines the behavior of resource sharing requests that fail to send a message to the partner. When set to true, which is the default, the notes require manual dismissal. To eliminate the need to manually dismiss the notes, set the parameter to false.
rs_ignore_electronic_for_physical_requestSet to true to to have the locate process (borrower side) ignore the lender’s electronic inventory if the borrower requested format is physical or physical non-returnable. See Locating Items for Resource Sharing.
rs_keep_rejected_request_activeThis controls whether a resource sharing request stays active after it is rejected by the resource sharing partner. The valid values are None, Borrowing, Lending, and Both. When set to None, which is the default, the request is completed and is not visible in the active requests queue. For a rejected borrowing request, Alma also sends a cancelation message to the patron. When set to Borrowing, Lending, or Both, the request remains in the active requests queue of the appropriate task list so the staff librarian have the option to work on the request. For a rejected borrowing request, Alma does not send a cancelation message to the patron. For more information, see Rejecting a Borrowing Request or Rejecting a Lending Request.
rs_prefer_recall_methodSet to true to recall a shipped item first if a requested resource has copies that were shipped to a remote borrower and copies loaned to local patrons. For this function to work, the relevant workflow profile must also include the Recall item action.
Set to false to recall the locally loaned copy first.
rs_specific_edition_only_defaultSet to True (which is the default) to select the Specific Edition Only check box when opening the resource sharing request form in Primo.
rs_support_add_serviceSet to true for the Alternative address field to display on resource sharing request forms.
rs_uresolver_locateSet to true to indicate that the locate process for electronic resources should consider coverage information similar to how the Alma link resolver would find services. See Borrowing Locate Process.
rs_use_new_mashup_formSet to true to enable the Resource Sharing Form Customization page on the Fulfillment Configuration menu. The default setting of false hides the Resource Sharing Form Customization page from the menu.
For more information, see Customizing Primo Resource Sharing Forms.
rs_yearly_ill_limit_start_dateThe first day of the year for consideration of the annual limit on resource sharing requests by a patron. The date format is DDMM and defaults to 0101. For more information, see Adding Fulfillment Policies.
rs_z39_locate_replace_ampFor resource sharing borrowing requests, when locating a resource at a partner configured with Locate Profile of type ‘Z39.50’ you can define how the '&' sign is used in the title and author fields for the locate process. When set to NONE, which is the default, the '&' sign remains in place and is not removed. When set to AND, it is replaced with " AND ". When set to BLANK, it is replaced with a space. 
self_check_proxy_checkoutSet to true to enable automatic checkout to a sponsor at a self-check machine. If the user checking out is a proxy for a single sponsor and this is set to true, the item is checked out automatically to the sponsor. If the user is a proxy for more than one user, the existing behavior remains. The default setting of false retains the existing behavior.
send_courtesy_notices_and_handle_loan_renewals_last_runThe last run of the Notifications - Send Courtesy Notices and Handle Loan Renewals job. The parameter is automatically updated by the system after the job runs, and appears in the format YYYYMMDD_HHMMSS in UTC time.
For example, if the job ran at 29/03/2020 13:21 and 26 seconds UTC time then the parameter would be automatically updated as 20200329_112126.
If you want to manually update this parameter to a different date, use only the date. There is no need to also include the _HHMMSS. For example, if you change the parameter to 20201129, the job will run as if the last run date was on November 29, 2020.
send_courtesy_notices_behaviourControls the behavior of the Automatic Renewal job (Notifications - Send Courtesy Notices and Handle Loan Renewals).
The values are:
  • DD_WITHIN_RANGE_DAILY - For institutions that previously had the resend_courtesy_notices parameter set to true, this value is populated in the new parameter as the default. The job runs on loans with a due date from the last run date until today plus the value of auto_renew_loan_days. This means multiple courtesy notices are sent if the loan is not renewed. For example, if the days parameter is set to 7 and the loan cannot be renewed (i.e. it is requested) then a reminder to the patron is sent every day until the day the item is due. It allows the notification to be sent daily until the item is due. This value corresponds to the Handle loans value of Daily when due date is within range on the Fulfillment Jobs Configuration page.
  • DD_ON_EXACT_DEFINED_DAY - For all other institutions, this is the default value. The courtesy notice is sent only on the exact day based on the number of days before due date that the courtesy notice is set to send. The courtesy notice is not resent. This value corresponds to the Handle loans value of When due date exactly matches defined day on the Fulfillment Jobs Configuration page.
  • DD_WITHIN_RANGE_ONCE - The courtesy notice is sent only once on or after the days before due date as defined in the job. This value corresponds to the Handle loans value of Once when due date is within range on the Fulfillment Jobs Configuration page.
  • DD_WITHIN_RANGE_ONE_NOTICE - The courtesy notice is sent only once on or after the days before due date as defined in the job, although if the loan cannot be renewed, the job may run multiple times until the due date. This value corresponds to the Handle loans value of Daily within range without repeating notification on the Fulfillment Jobs Configuration page.
Changing the value updates the value of the Handle loans drop-down list on the Fulfillment Jobs Configuration page and vice versa.
send_query_to_patron_use_xslSet to true to replace the Patron Query Templates option on the Fulfillment Configuration menu with the Patron Query Types option (see Configuring Patron Query Types), where you configure the types of queries to select from when sending a query to patron. The queries are sent using the enhanced XSL-based Query to Patron Letter.
Set to false to enable the Patron Query Templates configuration option on the Fulfillment Configuration menu (see Configuring Patron Query Templates), where you configure the template to define the appearance of queries to be sent. False is deprecated.
short_loan_courtesy_reminderThe time, in minutes, before the due date time of a short loan to send a courtesy notice. The value must be less than 1440 minutes (24 hours). It is blank by default, which means no short loan courtesy notifications is sent.
short_loan_overdue_blockWhen set to true, an overdue letter results in an overdue block being applied to the patron's account. By default, this parameter is set to false.
short_loan_overdue_reminderThe time, in minutes, after the due date time of a short loan to send an overdue reminder notice. The value must be less than 1440 minutes (24 hours). It is blank by default, which means no short loan overdue notifications is sent.
shortened_due_date_notificationsThe possible values are NONE, MESSAGE, EMAIL, MESSAGE_EMAIL (in caps). The default is NONE meaning no notification is sent.
If set to MESSAGE or MESSAGE_EMAIL, an on-screen alert is displayed for staff on the Manage Patron Services page when loaning or renewing an item with a shortened due date. The possible messages are:
  • Please notice that the due date was shortened since the item is recalled
  • Please notice that the due date was shortened since the patron card is expired before the due date
  • Please notice that the due date was shortened since the loan conflicts with a booking request
When loaning an item from a self-check machine, a message is also displayed.
The message text is not configurable.
In addition, when set to EMAIL or MESSAGE_EMAIL, a notification is sent to the patron at the time of loan or renewal regarding the shortened due date. At renewal time, the letter is only triggered if the renewal is done by staff from the Manage Patron Services page. If the renewal is done by the patron in Primo, the shortened due date is displayed to the patron immediately.  The Shortened Due Date Letter can be sent either by email or SMS. For letter information, see Configuring Alma Letters.
should_anonymize_requests_immediately_when_completeWhen set to true, the requester ID is set to NULL when a request is completed, therefore hiding the requester ID from the request history. This is the default.
When set to false, the requester ID appears.
should_automatically_print_request_slipWhen set to true, print slips are generated automatically according to any Automatic Printing rules that have been configured.
When set to false, print slips are NOT generated automatically, regardless of any Automatic Printing rules that have been configured. Note that you can still print request slips manually by selecting Print Slip.
This is an institution-level parameter and, therefore, applies to all Automatic Printing rules in all circulation desks in all libraries.
should_report_active_requestsThis value is set in the Requests - Send Report section of the Configuring Fulfillment Jobs page. When it is set to true, the active requests section appears in the notification report.
should_report_in_process_requestsThis value is set in the Requests - Send Report section of the Configuring Fulfillment Jobs page. When it is set to true, the in process requests section appears in the notification report.
should_report_on_hold_shelf_requestsThis value is set in the Requests - Send Report section of the Configuring Fulfillment Jobs page. When it is set to true, the hold shelf requests section appears in the notification report.
SIP2_include_item_level_call_number
The SIP2 reads the barcode of the scanned book. Alma supplies a number that will be an input for the sorting process and to the destination for return. This number is calculated based on rules, and may be set up to use the item's call number for the calculations.
When using the item call number, this customer parameter controls the bin sorting:
  • When the parameter value is False, the SIP2 machine returns the temporary call number, and if not found – then the holdings call number.
  • When the parameter value is True, the SIP2 machine considers call numbers in this order:
    • If a temporary item-level call number exists - returns it.
    • If does not exist, returns an item-level call number. 
    • If does not exist, returns holdings-level call number
switch_to_overdue_and_lost_loan_new_jobSet to true to activate the option for aggregating overdue or lost item notifications so that the patron receives only one notification for each notification type. 
Set to false to send one notification for each overdue or lost item. When set to false, overdue blocks are not supported.
For more information on the overdue and lost item letters, see Loans – Overdue and Lost Item on the Viewing Scheduled Jobs page.
uresolver_display_cz_records_firstWhether to list Community Zone records first in each level in the list of online resources. For more information, see Configuring Online Services Order.
uresolver_enable_getit_holding_configurationSet to true to display the Holdings Display Labels and Holdings Display Customization pages in the Discovery Interface Display Logic configuration menu.
Additionally, when this parameter is set to true, the customer parameters display_additional_holding_fields_in_getit and d​isplay_alternative_call_number_in_getit​, become obsolete.
This field is set to false by default for existing customers prior to the May 2018 release. For customers who go live starting in the May 2018 release, it is set to true by default.
For more information on the mapping tables, see Configuring Holdings Display Labels and Configuring Primo Holdings Display.
For more information on configuring holdings information, see Displaying Additional Holdings Information.
uresolver_partial_digitization_default_valueSet to true to initialize the Partial check box to selected on the Digitization Request Form.
Set to false to initialize the Partial check box to deselected on the Digitization Request Form.
For more information on customizing the Digitization Request Form, see Customizing Primo Request Forms.
uresolver_Prefer_id_based_linking_servicesSet to true to sort the packages in UResolver by the preferred ID based link.
uresolver_remote_registerThis controls whether the other institution's holdings may be retrieved without creating a local linked patron record.
Set to Auto to automatically create a linked account. This is the default.
Set to None to disallow the option to create a linked account via the Get It. Only holdings information is shown.
Set to Manual to display a link to sign into the institution. Selecting the link opens the request form from the source of the linked account.
uresolver_use_source_to_target_orderingWhether to place the highest priority on services that match the source of the OpenURL. For more information, see Configuring Online Services Order.
use_time_format_with_time_zone_in_self_checkWhen false, the time zone is not included as part of the due date field in the self-check response message. When true (default), the due date is formatted according to the system_time_format parameter. For more information on the system_time_format parameter, see the mapping table in Configuring Other Settings.
Configuring Printers
To configure printers, you must have one of the following roles:
Alma is hosted in a SaaS environment. Due to security concerns and technical limitations, SaaS environments do not support direct connections of local or network printers. Instead, printing in Alma works using email or a printout queue. Printout queue is the preferred option though email printing is still supported (see Printouts Queue). Each library/institution must define the email addresses of its local printers in Alma, which route staff-oriented, Alma-originating e-mails (including request and transit slips) to the appropriate printer. The printing queue method is the preferred method when printing to a physical printer. 
You configure printers on the Printers page (Configuration Menu > Fulfillment > General > Printers).
Printers Page
Ensure that you are within the context of the institution/library whose printers you want to configure by selecting the required institution/library from the Configuring filter on the Configuration page.
To associate a printer with a circulation desk, you must configure the printer at the library level. Ensure that you have selected a library in the Configuring filter on the Configuration page.
Select the printer code or name headings to sort the list alphabetically—in ascending or descending order—by printer code or name.
The following actions can be performed on this page:
Adding a Printer
You can add a printer to the institution or a library. If you add a printer to the institution, it is available for all the libraries within the institution as well.
To associate a printer with a circulation desk, you must configure the printer at the library level. Ensure that you have selected a library in the Configuring filter on the Configuration page.
If you enter an email address for a printer, verify that it is configured in the Email Include List mapping table. For instructions, see Configuring Allowed Emails.
To add a printer:
  1. On the Printers page (Configuration Menu > Fulfillment > General > Printers), select Add Printer.
  2. In the Add Printer dialog box, enter a code and a name (both required). If you are not using the printouts queue or quick printing (see Printouts Queue), enter an email address for the printer. Optionally, add a description as well.
    Add Printer Dialog Box
  3. Select Add and Close to close the dialog box. The defined printer is added to the list of printers on the Printers page.
    Printers Page
    After defining a printer, you can specify which circulation desks and service units are served by the printer. For details, see Editing Printer Information.
Editing Printer Information
You can edit the details of any printer. The details include:
To edit printer information:
  1. On the Printers page (Configuration Menu > Fulfillment > General > Printers), in the Code column, select the printer code link, or select Edit from the row actions list for the specific printer record whose information you want to update. The Edit Printer page opens.
  2. Under Edit Printer, edit the general printer details as required. When you want print routed to a queue in addition to an email address, select the Printout Queue option. See Printouts Queue for more information. When the Printout Queue option is selected, an additional column appears (Online Queue) in the list of printers with a check mark to indicate that the Online Queue option is selected..
  3. In the Served Circulation Desks List section, select a circulation desk that is served by the printer, and select Attach Circulation Desk. The selected circulation desk is added to the list of circulation desks that are served by the printer
  4. This section displays only when you are configuring a library (that is, you have selected a library in the Configuring filter on the Configuration page.
  5. Repeat the previous step for all circulation desks that are served by the printer.
    To remove a circulation desk from the list of circulation desks that are served by the printer, select Remove to the right of the circulation desk.
  6. In the Served Service Units List section, select the service unit that is served by the printer, and select Attach Service Unit. The selected service unit is added to the list of service units that are served by the printer.
  7. Repeat the previous step for all service units that are served by the printer.
    To remove a service unit from the list of service units that are served by the printer, select Remove to the right of the service unit to be removed.
  8. Select Save to store your changes to the printer information.
Configuring Article and Book Form Mandatory Fields
To configure mandatory fields in Alma resource sharing requests for article and book forms, you must have one of the following roles:
You can designate specific fields as mandatory when configuring Alma resource sharing requests. You can also group several fields together so that at least one of the fields is required to be completed when submitting resource sharing requests.
Fields can be assigned as mandatory for requests made for an article and/or a book.
The configured mandatory fields also appear as mandatory in reading list citation forms, and when cataloging brief records.
You configure mandatory fields for Alma resource sharing request forms on the ArticleFormMandatoryFields Mapping Table and BookFormMandatoryFields Mapping Table pages (Configuration Menu > Fulfillment > General, select Article Form Mandatory Fields or Book Form Mandatory Fields):
Mapping Table Page – Mandatory Fields
Ensure that you are within the context of the institution whose resource sharing library form mandatory fields you want to configure by selecting the required institution from the Configuring filter on the Configuration page.
The following actions can be performed on this page:
To configure mandatory fields for resource sharing request forms:
  1. On the Mapping Table page for an article or a book (Configuration Menu > Fulfillment > General, select Article Form Mandatory Fields or Book Form Mandatory Fields), select Customize for the fields you want to be mandatory when configuring a resource sharing request.
  2. In the Restriction Type column, select Mandatory.
    To restore a field to its default value, select Restore.
  3. Select Save. The indicated fields display as mandatory on the relevant Resource Sharing Lending Request or Resource Sharing Borrowing Request page.
To configure a group in which one field is mandatory:
  1. On the Mapping Table page for an article or a book (Configuration Menu > Fulfillment > General, select Article Form Mandatory Fields or Book Form Mandatory Fields), select Customize for the fields you want to arrange into a group.
    Mapping Table Page – Configuring Groups
  2. In the Restriction Type column, select Group 1 (or another group). The indicated fields belong to the same group.
    To restore a field to its default value, select Restore.
  3. Select Save. At least one of the indicated fields must be configured on the relevant Resource Sharing Lending Request or Resource Sharing Borrowing Request page.
Fields in groups are not labeled with a red asterisk (as regular mandatory fields are), but if at least one of the fields in a group is not assigned a value, an error message appears.
Back to top
Discovery Interface Display Logic Configuring Copyright Management
Was this article helpful?
Term of UsePrivacy Policy
Cookie PreferencesContact Us
2021 Ex Libris. All rights reserved
Home Alma Product Documentation Alma Online Help (English) Fulfillment
Configuring Fulfillment JobsConfiguring AnonymizationConfiguring Other Settings (Fulfillment)Configuring PrintersAdding a PrinterEditing Printer InformationConfiguring Article and Book Form Mandatory Fields