Additional Settings

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

To configure other settings, you must have one of the following roles:

User Administrator
General System Administrator

For Alma users, the additional settings are common between Esploro and Alma, and can be edited in either product. This means that changes to the additional settings will be reflected in Alma, and the converse (from Alma to Esploro).

The following sections describe additional user settings and additional general settings in Esploro. For a list of general settings throughout Esploro see here. For more information about mapping tables, see Mapping Tables.

Additional User Settings

You can configure various user management parameters on the mapping table at Configuration Menu > General > Users > Additional Settings.

User Management Parameters Mapping Table

User Management Configuration Parameters
Parameter Key	Description
address_lineX_regex (lines 1-5)	The valid format of lines 1-5 in the user's street address. See Adding User Contact Information.
block_user_creation_multi_thread	Block the ability to use multi threading for user creation via API. When true, the REST API to create User is working on serial mode.
centralized_user_management_run_task_chain_validation	Validates constraints for creation of new users such as the uniqueness of identifiers, whether mandatory fields were filled, etc.
check_for_expired_account	Set to true to prevent requests from expired users. The request will be blocked. The parameter is set to false by default, which allows requests from expired users.
disable_from_address	Set to true to disable the From: address field when you have configured a value for from_address (see below). This prevents users from entering their own email address in place of the one you have set in from_address. See Editing Users.
distribute_user_management_changes_last_run	Last run time of the user management distribution job.
email_regex	The valid e-mail format. See Adding User Contact Information.
email_regex_display	The message appearing when entering an email address, if email_regex is defined.
external_users_with_internal_auth	For institutions whose Student Information System (SIS) does not offer authentication services, it is now possible to create users as external in Esploro/Alma, but assign passwords for them directly in Alma. In this case, all the user information, such as name, ID, etc, is managed from the SIS, but the passwords are stored in Esploro/Alma and managed by the Ex Libris Identity Service. When this behavior is enabled, changing a user from external to internal (and vice versa) does not reset the user password; the existing password the user used as an external user is retained. See Registering Patrons and Mapping User Accounts to Other Systems.
from_address	The value used as a default in the From: address for the General Message you can send while editing a user. See Editing Users. See also disable_from_address, above.
fulfillment_network_search_by_all	Whether to enable walk-in services in a fulfillment network for patrons that don't happen to have an ID available. The parameter must be enabled at the institution where the patron is already registered. Valid search criteria include first name, last name, or email address. The search must be an exact match. If the search yields more than one result, an error is returned.
jwt_signature_secret	A secret text used for signing a JWT token.
network_user_profiles_and_assignment_rules_distribution_members_behavior	Controls what is done with the members' user profiles and assignment rules when the Network Zone's records are distributed. Valid values are: Remove and None. Remove removes all the local records. When set to None (the default), all previously existing records are left exactly as they were before the distribution.
network_users_unique_identifiers	Whether a fulfillment network uses unique user identifiers: FULL - Identifiers are unique across all members of the fulfillment network and are not duplicated. In Manage Patron Services a Find user in all network institutions check box will cause the system to search for the ID first in the local institution and if not found then in all other participating institutions. The system will automatically find the user record at any of the network institutions and pull its information from its institution. When selecting this option, the Find user in all network institutions check box should only be selected with searching for a unique patron ID across the entire network. NONE – Identifiers are not unique. This is the default.
phone_regex	The valid phone number format. See Adding User Contact Information.
phone_regex_display	The message displayed when entering a phone number, if phone_regex is defined.
photo_identifier_type	The type of user identifier from which to take the name of the photo (together with photo_server_url). The options are: USERNAME (the primary identifier) or a user identifier code; see Viewing Additional User Identifier Types . See Managing User Pictures.
photo_server_url	The URL directory for user photos to display in the User Details page. See Managing User Pictures. The URL may use HTTP or HTTPS. To use HTTPS, the certificate must not be self-signed: it must be signed by a known certificate authority (the list of supported certificates can be found here). The directory name must end with a forward slash (/) . To view the photos in the User Details page, the user accessing the page must also have access to this URL.
photo_suffix	The file extension (such as .jpg or .gif) for user photos. This value is appended to photo URLs – if this value is not defined, the photo may not appear properly. See Managing User Pictures.
pin_number_method	To enable the PIN number generation functionality, enter the value fourDigit (the only possible value) here. See the PIN number field in Adding Users.
postal_code_regex	The valid format for the postal code. See Adding User Contact Information. By default, the postal code must be between 0 to 16 characters and must include only digits, capital letters, hyphens, and spaces. If you want to include periods as well, add \. following the hyphen, as follows: [A-Z0-9\-\. ]{0,16}
postal_code_regex_display	The message displayed when entering a postal code, if postal_code_regex is defined.
preferred_identifier	Enter an identifier code to be used when displaying only one identifier and when scanning items that are on the hold shelf according to user. The identifier codes are listed in the User Identifier Types page. For more information, see Viewing Additional User Identifier Types .
primary_identifier_regex	The valid format of the primary identifier. Alphanumeric characters in primary identifiers are supported.
staff_login_ip_address_retention	The retention period for the public IP address of users that logged into the system. The default period is 90 days, you can state any number, including 0 to prevent retention. For details, see Staff Login Report.
url_regex	The valid format of the URL. It must have a leading protocol, a valid domain name (two or three letter TLD and no invalid characters), and a valid file path.
use_pincode_for_selfcheck_machine	Indicates if pincode is used for selfcheck machine.
user_audit_retention_period	Entering a whole number indicates a length of time, in days, that user audit trail records will be retained. The default value of spaces means that all records are retained. See User Audit History.

Other General Settings

You can configure a number of general parameters on the mapping table at Configuration Menu > General > Other Settings.

Additional Settings for Esploro.

General Parameters Mapping Table Page

General Configuration Parameters
Parameter Key	Parameter Value
campus	Not for use.
code_and_mapping_table_log_retention_period	Specify the number of days per which changes made to the Code or mapping tables are stored in the system. 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, The system 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.
detailed_creator_and_modifier_for_api_changes	When true, add Api Key Name To Modifier And Creator.
disable_ideas_link	Enable (true) or disable (false) the Suggest an Idea link in the persistent menu. See The Persistent Menu.
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.
email_contact	Not in use.
email_contact_us	The email addresses (in a format such as mailto: helpdesk@university.edu) 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: helpdesk@university.edu) or URL (http://...) to which the My Account link is directed. For more information, see Configuring Letter Labels.
email_sender	Not in use.
font_for_special_characters	This customer parameter is used for customers with special characters in their languages. We changed the font from Roboto to Calibri to support it.
include_recipient _name_in_email_address	If set to true, includes the receiver's name in the email address in emails sent from Esploro. This may decrease the chances of having the email count as spam when it enters the recipients inbox.
page_size	The number of records to show in all of the lists in the system. Maximum is 20.
standard_sandbox_override_link	Full path (including Protocol) of an override link for the Standard Sandbox of an institution.
system_time_format	Set the time format (without dates) for time displays throughout the 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)
temp_enable_feedback_tool	Enable the new UX feedback tool.