Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Configuring Institution Settings

    To configure Esploro, you must have the Configuration Manager role.

    This page describes how to configure institution settings in Esploro. For information on configuring the various parts of the research information hub see here.

    Multi-Lingual Data Elements

    You can set the default language and additional languages that will be used in Esploro. To configure these values, open the Multi-Lingual Data Elements page (Configuration Menu > General > Institution Settings > Multi-Lingual Data Elements).

    Multi lingual data elements.

    Multi-Lingual Data Elements

    Select the default language from the drop-down list. Then select additional languages from the multi-select list.

    For information on adding information in multiple languages on the portal see here. For information on configuring institution languages in Esploro see here. For a video showing how to add abstracts and keywords in multiple languages see here.

    Configuring Default Researcher Settings

    You can configure the default values for researcher notifications for all new researchers. For details see here.

    Research Jobs Configuration

    You can activate and deactivate Esploro scheduled jobs. You do this from the Research Jobs Configuration page (Configuration > General > Institution Settings > Research Jobs Configuration):


    Research Jobs Configuration

    To activate or deactivate a job, select the appropriate radio button for a job and select Save. To run the job immediately, select Run Now.

    Users with both the Configuration Manager and Media Mentions Manager roles can configure the Media Mentions loader job. Currently, the loader runs only for the Retriever format with a RSS URL. You can define the run time in the Schedule field, the status of all incoming records in the Load all records as field, and enter the feed URL in the URL of the feed for the loader field. The options in the Load all records as field are Approved for display in portal and profiles, which is the default, Approved only for display in portalApproved only for display in profiles, and Pending approval. Although some of the statuses indicate that approved records will display in the portal and/or profiles, the media mentions do not currently display in the portal or profile. If these options are selected when the records are loaded, they will appear in the correct pages when display of media mentions begin on the portal and profile.

    Once activated, the Media Mentions Loader job is active in the scheduled jobs on the Monitor Jobs page. 

    Monitor Jobs - Research Jobs.png

    Monitor Jobs with the Research Filter Applied


    Configuring Citation Sources

    Esploro supports recording citation counts for research outputs from several sources. Before you can import citation counts for research outputs, you must verify that you have a license for the data for each source. This is configured on the Citations Sources page (Configuration > General > Institution Settings > Citation Sources):


    Citation Sources

    To configure a source, select the More Actions button, select Customize, and change the parameter to true. Select Save.

    The source you set to true is now available to be selected from the Load Citation Metrics page (Repository > Load Citation Metrics). For more information, see Loading Citation Metrics.

    Configuring Other Institution Settings

    The following figure shows the Esploro customer parameters that you can configure (Configuration Menu > General > Institution Settings > Institution Settings).

    Institution Settings_Other Settings.png

    Configuring Institution Settings Customer Parameters

    The following list describes the settings that you can configure in the Institution Other Settings:

    Parameter Key Parameter Value
    esploro_add_asset_affiliation true/false – Controls whether the affiliations of affiliated researchers matched with a creator/contributor on an asset are automatically added to the asset's affiliations when importing assets using the CDI Import Profile or Smart or Smart Harvesting.
    esploro_date_format Sets the date format displayed on the research portal.

    Controls whether researchers can make their own deposits. When set to true, researchers can make their own deposits. When set to false, researchers cannot make their own deposits.


    Controls the population of dates when receiving a deposit from ETD Administrator. The following options are available:

    • No date – no date is added by Esploro.
    • Publication Date –  if the Publication Date of the deposit is empty, Esploro adds the Deposit Date as the Publication Date.
    • Date Available –  if the Date Available of the deposit is empty, Esploro adds the Deposit Date as the Date Available.

    Controls the status assigned to deposits when receiving a deposit from ETD Administrator:

    • Approved Asset – the deposit is assigned Approved status.
    • Deposit – the deposit is assigned Submitted status.
    esploro_ip_list_to_exclude_usage Stores IPs to exclude from being recorded in usage.

    Controls the default display of the researcher profiles when they have no assets to show:

    • true - A researcher with an active profile set will have the profile shown only if the researcher has approved assets to show. An option to dispaly even without assets will be added to the active profile flag on the researcher to allow overriding this behavior for individual researchers as needed.
    • false -  A researcher with an active profile set will have the profile shown regardless of whether the researcher has approved assets to show.


    The following list describes the settings that you can configure in the General Other Settings:

    Customer Parameters (General)
    Parameter Key Parameter Value
    campus Not for use.

    Specify the number of days per which changes made to the Code or mapping tables are stored in Esploro. This helps you know what configuration changes were made, and by whom, for audit purposes.

    The default is 0 (data is not stored), and you can change it to any number of days. When the value is higher than 0, then when changes are made to the Code or Mapping tables, Esploro stores these changes as events. Events include the user that made the change, the table where the change was made, and the action (new row, row update, row deletion). Full details of the change are not stored. You can then run a report of these events via Esploro Analytics. 

    default_language The default language of the user.
    The default value should not be edited.
    disable_ideas_link Enable (true) or disable (false) the Suggest an Idea link in the persistent menu. See The Persistent Menu.
    display_additional_holding_fields_in_getit If set to true, displays additional holdings information on the Get It tab in Primo. For more information, see Displaying Additional Holdings Information.

    If set to true, displays the alternative call number information on the Get It tab in Primo.

    Alternative call number = item call number

    display_consortia_urls_link If set to true, the Change Institutions drop-down list appears when viewing/choosing your current location, allowing you to switch institutions in a collaborative network. See Switching Between Institutions.
    display_full_user_name_in_more_info  If set to true, the full user name is displayed for the operator information displayed in information pop-up windows. When set to false (default), the primary ID is shown.
    display_getit_target_in_new_window If set to true, displays the Get It target in a new dialog box.
    display_isbn_13_in_predefined_result If set to true, displays the 13 digit ISBN number on the PO line description and PO line list. If set to false, the standard 10 digit ISBN number is displayed in all places. See Manually Creating a PO Line.
    display_viewit_target_in_new_window If set to true, displays the View It target in a new dialog box.
    email_contact Not in use.
    email_contact_us The email addresses (in a format such as mailto: or URL (http://...) to which the Contact Us link is directed. For more information, see Configuring Letter Labels.
    email_deposit_contact Not in use.
    email_deposit_sender Not in use.
    email_my_account The email addresses (in a format such as mailto: or URL (http://...) to which the My Account link is directed. For more information, see Configuring Letter Labels.
    email_sender Not in use.
    enable_new_walk_me See GuideMe Frequently Asked Questions (FAQ).
    force_location_selection_on_login If set to true, the system will open a dialog box during logon, requiring staff users to specify their physical location. Otherwise, the system will automatically set the physical location to the user’s last specified location.
    multi_campus_inventory_management If set to true, displays the Inventory Network Groups link in the configuration menu; see Configuring Distributed Access to Electronic Resources. Before implementing this feature, consult with Ex Libris.
    open_consortia_link_options Controls what happens when switching institutions (see Switching Between Institutions):
    • tab - The Esploro home page of the other institution opens in a new tab.
    • window - The Esploro home page of the other institution opens in a new window.
    • If left empty, the Esploro home page of the other institution opens in the current tab.
    page_size The number of records to show in all of the lists in the system. Maximum is 20.
    primo_patron_info_updatable If set to true, allows users to update their patron information from Primo.
    primo_pds_url The URL that Esploro uses to get bor-info from PDS when getting a View It/Get It request from Primo. It must be the same URL as the one Primo uses to call PDS (or Primo's authentication gateway). For more information, see Identify Patrons to Provide Relevant Services.
    primo_service_page_url Determines the base URL that is used to receive a service page direct link to the title when using the Esploro Service Page APIs. For more information on this service, see
    primo_test_pds_url Enables Alma to work with two different PDS systems. If the Primo View It/Get It template is configured to env_type=test, Alma uses the test PDS. For more information, see Delivery Subsystem.
    publishing_base_url For information on this parameter, see the Retrieve Bib Record API documentation on the Developer Network. This parameter should be in the following format:
    http://<primo server host: port>/openurl/<primo_institution_code>/<primo_view_code>?
    retrieve_services_from_NZ (For members of a collaborative network implementing a Network Zone) If set to true, any OpenURL request to the Alma Link Resolver consults the Network Zone to resolve electronic services for resources that are managed in the Network Zone and available for the institution. See Resolving Electronic Resources in the Network Zone.
    rss_discovery_url The URL of the discovery system (such as Primo), set at the institution level. For details, see RSS Publishing.
    smsDateFormat Not in use.
    standard_sandbox_override_link Configure the URL of your Standard Alma Sandbox instance. To configure, enter the full path (including Protocol) of an override link for the Standard Sandbox of your institution. 
    Note: This is not required, and will not work, for customers with Premium Sandbox.
    system_time_format Set the time format (without dates) for time displays throughout the Esploro user interface. Use the following characters, separated by blanks, commas, hyphens or colons:
    • a – text representing AM or PM—for example, PM
    • H – a number from 0-23 representing the hour in the day—for example, 0
    • k – a number from 1-24 representing the hour in the day—for example, 24
    • K – a number in the AM/PM format from 0-11 representing the hour in the day—for example, 0
    • h – a number in the AM/PM format from 1-12 representing the hour in the day—for example, 12
    • m – a number representing the minute in the hour—for example, 30
    • s – a number representing the second in the minute—for example, 55
    • z – the general time zone—for example, Pacific Standard Time; PST; GMT-08:00
    • Z – the RFC 822 time zone—for example, -0800
    For example:
    • h:mm a indicates a time such as 12:08 PM
    • K:mm a, z indicates a time such as 0:08 PM, PDT
    • kk:mm:ss indicates a time such as 23:30:55 (that is, 11:30 PM and 55 seconds)


    Enter one or more three-letter currency codes for the currencies that should not appear with a decimal point/decimal point value. For example, if you do not want decimal points/decimal point values to appear for the Japanese Yen or Korean Won, enter the following:


    With this parameter configured, the following cases do not display decimal points/decimal point values:

    • Alma monetary data that is communicated to a vendor, public users, or partners via letters, mail, SMS, and so forth
    The following out-of-the-box letters check for the truncate-decimal_fraction_amount configuration:
    • Full Fines\Fees Notification Letter
    • User Deletion Notification Letter
    • Resource Sharing Receive Slip Letter
    • Order List Letter
    • Notify Upon Renewal Letter
    • Full User Borrowing Activity Letter
    • Full Overdue And Lost Loan Notification Letter
    • Full Overdue And Lost Loan Letter
    • Full Lost Refund Fee Loan Letter
    • Full Lost Loan Notification Letter
    • Full Lost Loan Letter
    • Full Fines Fees Notification Letter
    • Fine Fee Payment Receipt Letter
    • Full Return Receipt Letter
    • Full Short Loan Letter
    Note that if you have manually edited any of these files to include additional price, fine, and/or cost information, you can either restore the letters; or you can manually modify these letters to not display decimal points/decimal point values. This can be achieved by adding syntax such as the following:
    <xsl:value-of select="substring-before(fee, '.')">
    • Self-check machine messages and responses related to a user's fines and fees
    • User fine and fee information that appears in Primo VE
    There is a known issue where fine and fee information appears on the Overview tab for My Library Card when this customer parameter is configured. This will be fixed in a future release.
    • User fine and fee information that appears in Primo DLF services

    The following areas continue to display decimal points/decimal point values even when you customize the truncate_decimal_fraction_amount customer parameter:

    • Alma user interface
    • Alma diagrams, charts, and dashboards
    • Analytics
    Note that Analytics provides an option to hide decimal point values by using the Column Properties setting.
    • Exported Excel lists
    Note that Excel provides an option to hide decimal point values by using the Format Cells setting.
    • EDI messages
    • General Alma APIs
    view_historical_loans_in_primo Enables historical loan information to be sent to Primo. For more information, see Displaying Historical Loans in Primo.
    • Was this article helpful?