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

    General Configuration Wizard

    The General Configuration Wizard enables on-premises customers to configure advanced operations in the Back Office. You can use it to edit subsystem settings, including the name and logo that appears on all pages within the subsystem.
    General Configuration parameters can only be configured at the installation level. For hosted environments, contact Ex Libris Support for assistance.

    Accessing and Using the General Configuration Wizard

    To access the General Configuration wizard:
    1. On the Back Office's home page, click Advanced Configuration.
      The Advanced Configuration page opens.
      Advanced Configuration Page
    2. Click General Configuration Wizard.
      The General Configuration page opens.
      General Configuration Page
    3. Select a subsystem on the Sub System drop-down list.
      The subsystem's fields appear in the Sub System area.
    4. Edit the fields according to the following subsystems:
      Subsystem Field Descriptions
      If the selected subsystem is Refer to the following table for a list of fields:
      Alerts
      Back Office
      Client IP
      Delivery
      Email and SMS Configuration
      Installation
      Primo UI
      Publishing
      Remote Search
      RTA
      Security Security Parameters
      Statistics
      Thresholds
      To edit the details of another subsystem, select that subsystem in the Sub System drop-down list.
    5. Click Save & Continue to update the subsystem details.

    Alerts Parameters

    The following table describes the fields for the Alerts subsystem:
    Alerts
    Field name Description Format
    E-Mailing Frequency (in days)
    Determines how often users will receive an email. An email will be sent only if a sufficient number of days has passed.
    Beginning with the April 2015 release, you can disable alert emails by specifying a 0 in this field.
    number
    Number of items included in alert
    Indicates the maximum number of records (not to exceed 50) to include in alerts. The default is 25 records.
    number
    Schedule Days
    The days on which the system will check to see if there are new records for the alert queries. The valid values are SUN, MON, TUE, WED, THU, FRI, and SAT.
    The first three letters of the name of the day. To specify a more than one day, separate the days with a comma.
    For example: MON,TUE,WED
    Schedule Hour
    The hour at which the system will check to see if there are new records for the alert queries. The valid values are 0 to 23.
    number (such as 0, 1, and so forth)
    SMTP_AUTH
    Allows alert e-mails to be sent if SMTP authentication does not require a login and password.
    If SMTP does not use a login and password for authentication, set this field to false to allow alert e-mails to be sent without authentication.
    Changes to this field require the FE server to be restarted.
    true or false

    Back Office Parameters

    The following table describes the fields for the Back Office subsystem:
    Back Office
    Field name Description Example
    Filter by Institution
    This field indicates whether the system will filter areas of the Back Office user interface.
    If this field is set to true, the system will filter the following pages in the Back Office user interface for all staff users that are associated with a specific institution:
    • Data Sources – Display only data sources that belong to the current user's institution. When creating a new data source, staff users can add it only to the their institution.
    • Pipes List – opens only pipes that belong to the user's institution. When defining new pipes, the staff users can associate only data sources that belong to the their institution.
    • Views Wizard – opens only views that belong to the current user's institution.
      Staff users who are required to work with all institutions should be assigned All institutions in the Institution field. Filtering applies to all staff roles except for the Superadmin role.
    true
    Display BO A-Z List
    This field indicates whether to display the A-Z list filters above the lists on the Data Sources Configuration and Pipe Monitoring pages. To display the A-Z filters, specify true.
    false

    Client IP Parameters

    The following table describes the fields for the Client IP subsystem. It allows you to specify an IP from a specific header in the request.
    If any of the Delimiter, Header Number, and Index In IP Group fields are not specified or incorrect, the system will use the remote address of the request. If the IP found is not valid, Primo will use the remote address IP of the request.
    Client IP
    Field name Description Example
    Client IP Proxy Header
    The IP header name.
    x-forwarded-for
    Delimiter
    If the request contains several IPs, this field allows you to specify the delimiter (such as a comma) used to separate each IP.
    Header Number
    If the request contains multiple headers, this parameter allows you specify the position number of the header in the request. The valid values are 1 to n, where n is any whole number greater than 1.
    For example, if you want to use the first header in the request, enter 1.
    2
    Index In IP Group
    If the request contains multiple IP addresses, this parameter allows you specify the position number of the IP address in the list. The valid values are 1 to n, where n is any whole number greater than 1.
    For example, if you want to use the first IP address in the list, enter 1.
    1

    Delivery Parameters

    The following table describes the fields for the Delivery subsystem:
    Delivery
    Field name Description Example
    Always check if also Physical Item
    This field indicates whether the system will always check to see if an item has a physical resource and provide GetIt links for both online and physical resources if both exist. The following values are valid:
    • N – this option indicates that only a single delivery category is defined, giving preference to online resources.
    • Y – this option indicates that even if the delivery category is an online resource, the system should check if the PNX also represents physical items.
    The default value is Y.
    Y
    INSTITUTION_
    AVAILABILITY
    For institution-specific searches, this parameter indicates whether the availability of the library should be based on the institution, not the user's institution. The following values are valid:
    • Y – Indicates that availability for institution-specific searches is based on the institution.
    • N – Indicates that availability is always based on the user's institution.
    The default value is Y.
    The system determines if a search scope is institution-specific by checking all of the individual search scope values within the search scope and checking that their type is defined on the Primo Home > Ongoing Configuration Wizards > Pipe Configuration Wizard > Scope Values Configuration path/page. An institution-specific search scope is one in which only one institution type search scope value has been defined.
    This means that only scopes that represent real institutions should be assigned the institution type. An institution that represents a “central” institution which was created, for example, for shared online resources should be assigned the other type.
    Y
    LIBRARY_
    AVAILABILITY
    For library-specific searches, this parameter indicates whether the availability of the library should be based on the library, not the user's institution. The following values are valid:
    • Y – Indicates that availability for library-specific searches is based on the library.
    • N – Indicates that availability is always based on the user's institution.
    The default value is Y.
    The system determines if a search scope is library-specific by checking all of the individual search scope values within the search scope and checking that their type is defined on the Pipe Configuration Wizard > Scope Values Configuration path/page. A library-specific search scope is one in which only one library type search scope value has been defined.
    This means that only scopes that represent physical libraries should be assigned the library type. Libraries that include only online resources should be assigned the other type.
    Y
    Shared User Database & Resource sharing
    For OPAC via Primo configurations, this field indicates whether institutions in a multi-institution site share a database and resources. The following values are valid:
    • N – None of the institutions share a database or resources.
    • Y – All of the institutions share a database or resources.
    • P – Some of the institutions share a database or resources. For these institutions, select the Institution is part of the shared user database/Resource sharing check box on the Edit Institution page (Primo Home > Ongoing Configuration Wizards > Institution Wizard).
    For more information on setting this parameter, see the section on configuring OPAC via Primo in the Primo Interoperability Guide.
    N
    Use SFX RSI
    This parameter indicates whether the system should use the SFX Rapid Service Indicator (RSI) API instead of the Journal Subscription Information (JSI) API to check if remote search records have full-text or not. Enter Y to use RSI. The default value is N.
    RSI is much more accurate than JSI, because it can use additional identifiers (in addition to ISSN/ISBN) to solve scenarios where the SFX JSI returned no full text when in fact there was full text. However, some discrepancies still remain because RSI does not support a check based on the title.
    Because this parameter applies to all Primo institutions, you must upgrade all instances of SFX to RSI. RSI is available with the April 2009 SFX revision and later releases.
    Y

    Email and SMS Configuration Parameters

    The following table describes the fields for the E-mail and SMS Configuration subsystem:
    E-mail and SMS Configuration
    Field name Description Example
    Activate Captcha [Y/N]
    Set this field to Y to activate the Google CAPTCHA method to secure e-mail in Primo. The valid values are Y and N.
    In addition, you must configure the Private Captcha Key and Public Captcha Key fields.
    Y
    Contact Person E-Mail
    The Back Office administrator's e-mail address.
    If a process (such as a pipe, slice, or search agent) fails, an e-mail message is sent to this e-mail address.
    This parameter is overridden by the settings in the E-Mail Addresses mapping table at both the installation and institution levels (Primo Home > Advanced Configuration > All Mapping Tables).
    Country Code for SMS
    Indicates the country code used for SMS.
    Leave this field blank if your site works with many countries. In this case, the user must specify a country code.
    972
    E-Mail Sender
    This field allows you to define the sender for Watchdog e-mails. This field defaults to the following:
    Primo@exlibris.co.il
    Maximum SMS per message
    Indicates the maximum number of messages that can be sent in a session. The default is 2.
    2
    Private Captcha Key
    Enter the CAPTCHA private and public keys to provide secure e-mail in Primo.
    To request the keys, log on to your Google account at the following URL:
     
    Public Captcha Key
    Enter the CAPTCHA private and public keys to provide secure e-mail in Primo.
    To request the keys, log on to your Google account at the following URL:
     
    SMS Default Institution
    Indicates the default institution used for SMS.
    Y
    SMTP_HOST
    The IP address or the host name of the server that provides the SMTP service.
    Local host
    SMTP_PASSWORD
    The password used if the SMTP server requires a user login.
    Password
    SMTP_USERNAME
    The user name used if the SMTP server requires a user login.
    User

     

    Installation Parameters

    The following table describes the fields for the Installation subsystem:
    Installation
    Field name Description Example
    Cleanup_Max_Process_Age
    The number of days after which cleanup is performed.
    50
    Console Status Url
    The servlet status URL.
    It is used in case the JMX information for the current threads is not available.
    http://localhost:1701/status?XML=true
    Display Initial
    Indicates whether the Initial Configuration option is displayed in the main menu.
    On/ Off
    Display Ongoing
    Indicates whether the Ongoing Configuration option is displayed in the main menu.
    On/ Off
    Help Base URL
    The base URL of the FE help pages.
    [Currently not active.]
    http://primo03.com:1601/primo_publishing/admin/help/
    IGNORE_SSL_
    CERTIFICATE
    This parameter enables the application to connect to servers using the SSL protocol even when those servers do not have a valid certificate. This may be useful for scenarios (such as testing) in which a certificate is not required.
    A change to this parameter will take effect only after restarting the FE server.
    true
    Installation Logo
    The installation logo.
    Primo Back Office
    Installation Name
    The name of the Installation.
    Primo
    Installation Type
    The type of installation.
    Test
    MFE_CONFIG
    The type of multiple FE configuration used. The following values are valid:
    • none
    • many_to_one
    • many_to_many
    many_to_many
    For more information on multiple FE configurations, see the Primo System Administration Guide.
    MFE_FRONTENDS
    A comma-separated list of the FE servers that are used in a multiple FE configuration, including the master FE. Use the following format:
    <server_name>:<port> [, ...]</port></server_name>
    primo01.exlibrisgroup.com:1701, primo02.exlibrisgroup.com:1701, primo03.exlibrisgroup.com:1701
    When performing A/B testing, the first FE in the list is considered the test FE.
    MFE_MASTER
    The fully-qualified name and port of the FE server acting as the master server in a multiple FE configuration. Use the following format:
    <server_name>:<port/></server_name>
    primo01.exlibrisgroup.com:1701
    Parallel Processing of Pipes Mode
    Indicates the mode used to run pipes in parallel. The following modes are valid:
    • Harvesting Only
    • Harvesting, NEP
    • Harvesting, NEP, Dedup-FRBR
    For more information, see Parallel Processing of Pipes.
    Harvesting, NEP
    PPS SERVER
    Contains a comma-separated list of host names of the Primo Provisioning System, which is used to automatically create a Primo environment for new customers. It is not relevant to customers already working with Primo.
    myprimo.hosted.exlibrisgroup.com,il-qtlab01
    Primo Central Adaptor Version
    The Primo Central adapter version.
    1
    Primo Service Pack
    The service pack used with the Primo system.
    0
    Primo Version Number
    The version number of the Primo system.
    0.02
    primo_admin_base
     
    http://primo03.com:1601/primo_publishing/admin/
    primo_base
     
    http://primo03.com:1701/primo_library/libweb/
    primo.process.ParallelProcessing.NumThreads
    Used to determine the number of pipes (number of threads / 4) Primo allows to run in parallel. Out of the box, this parameter is set to 8 (two pipes).
    If you have the resources and want to raise this value, we suggest doing it in phases. For example, raise the value to 12 to make sure the pipes perform well. If pipes perform well, continue incrementing the value by 4 to determine the maximum number of pipes your environment can run in parallel.
    The more pipes running in parallel does not only affect the BO machine’s load, it also causes more load on the DB machine. Make sure that you also consider the performance of the DB machine when increasing the number of threads.
    12
    A change to this parameter requires you to restart the Back Office.
    Process_Run_Indexing_After_Pipe
    Indicates whether the process should automatically run indexing after running a pipe.
    True/ False
    Process_Run_Indexing_and_Didumean_After_Pipe
    Indicates whether the process should automatically run indexing and did-u-mean after running a pipe.
    True/ False
    Proxy_Server
    Requests sent to third-party providers (such as Amazon, Google, and Syndetics) to retrieve thumbnails is sent through a proxy server. In case there are several thumbnail links for a record, the following templates are given precedence:
    1) syndetics_thumb
    2) syndetics_thumb_exl (new template)
    3) Google templates
    4) Other providers

    Note: Amazon thumbnail requests will no longer be sent for customers who use the out-of-the-box template code.
    https://
    Redirect View
    Indicates whether the system should change views without first terminating the session.
    false
    Reporting Base URL
    The URL of the reporting base.
    http://primo03.com:1601/birt/frameset?_report=Report
    reporting_base
    The Base URL of the reporting tool.
    http://primo03.com:1601/birt/
    Reports URL
    The URL of the reports list.
    http://primo03.com:1601/birt/run?__report=Report\ReportsList.rptdesign
    Request Thread Pool Name
    The locate thread pool object name.
    jboss.web:name=http-0.0.0.0-1701,type=ThreadPool
    Search Statistics Report URL
    The URL of the list of search statistics reports displayed in the monitoring area of the site.
    /birt/run?__report=Report/PrimoSearchStatisticsMainMenu.rptdesign
    Spare Requests Threads Threshold
    The minimum spare threads threshold from the maximum thread pool.
    If the maximum number of threads is set to 360, Primo will start blocking requests at 310.
    50
    Start Monitoring Threads Threshold
    Interval from the maximum threads threshold to start monitoring.
    Defines the threshold for monitoring requests and verifies whether there are equal requests from the same IP.
    50
    Starvation Mode
    Indicates how indexing and the execution of the Dedup_Frbr pipe is handled during parallel processing of pipes. The following options are valid: By Schedule (default) and Force.
    It is not necessary to perform a deploy or restart the Back Office after changing this parameter.
    For more information, see Starvation Mode.
    Force
    System Last Stage
    The last stage of the system's Publishing Platform Process.
     
    Use local fields 30-39 as lateral links
    Indicates whether the local search fields are used for lateral links in the detailed display. The default value is Y.
    If you do not want local search fields to be linkable, you must set this field to N.
    If you make any changes to this field, you must restart the FE server.
    For more information on configuring lateral links, refer to the Primo Technical Guide.
    N

     

    Primo UI Parameters

    The following table describes the fields for the Primo UI subsystem:
    Primo UI
    Field name Description Values
    CJK IE6 ENCODING
    For CJK customers who want to enable CJK encoding for Internet Explorer 6 (IE6), set this field to ON. Otherwise, set this field to OFF.
    ON/OFF
    Client IP Proxy Header
    This parameter is intended for sites that have an SSO via proxy configuration in which the IP of the client (such as the user) is always transformed to an on-campus IP by the proxy. As a result, IPs of off-campus guests that are not signed in are changed to an on-campus IP, giving these users access to restricted resources.
    This flag should contain the HTTP Header parameter that contains the user's original IP so that Primo can use the original IP for authorization.
     
    Default View
    This is the default view that the system displays in the Front End if the view ID in the URL is missing or invalid. You can specify any view code that is defined in the Views wizard. By default, this field is set to UnknownView, which displays an error message that is defined with the following code in the View Labels code table:
    default.unknown.view.Requested_Page_Was_Not_Found
    If you have a single view or a main view, it is recommended to change the default value to the view’s code.
    UnknownView
    Display_Reviews
    Indicates whether the Reviews function should be active in the Primo User Interface.
    Y/N
    Display_Tags
    Indicates whether the Tags function should be active in the Primo User Interface.
    Y/N
    Is Multilingual Interface
    This field indicates whether filters are activated in the full record display to support a multilingual thesaurus in Primo.
    The Multilingual Interface feature allows you to filter out the following display and facet fields in the full record display if the language code of the subject/facet match the language of the interface:
    • Facets – Topic, Genre, Format, Creator-Contributor, and Local Field 1
    • Display – Title, Subject, Description, Format, Creator, Contributor, Local Field 1, and Local Field 20
    To implement this feature, the above display and facet fields must contain a $$8 code and language code (ISO 639 three letter code) in the PNX record, as follows:
    display/subject Urban ecology$$$8eng
    display/subject Ecologie urbane$$$8fre
    display/subject Ekologie urbanische$$$8ger
    facets/topic Urban ecology$$$8eng
    facets/topic Ecologie urbane$$$8fre
    facets/topic Ekologie urbanische$$$8ger
    For example, if the interface language of the Front End user interface is French, the following subject will display in the full record display and the facets section:
    Ecologie urbane
    To disable this feature, set this field to false.
    true
    MetaLib Connection Timeout
    Indicates the maximum time in seconds that Primo will wait for the resetting of MetaLib access authorizations.
    For additional information, see Synchronizing MetaLib Access Information.
    60
    Always Prefer Online Resources in Multi-Institution Records
    This field indicates whether preference is given to online resources when deduped records have multiple resource types. The default value is Y.
    If this field is set Y, Primo will give preference to the “Online Resources” delivery category if the user has access to the online resource based on the defined restricted delivery scopes. If the user does not have access to the online resource, Primo will use the delivery category of the records that belong to the user's institution.
    If this field is set N, Primo will always use the delivery category of the records that belong to the user's institution.
    If restricted delivery scopes are not defined in Primo, you may want to set this flag to N. Otherwise, Primo will consider all online resource as not restricted even if users do not have access to the online resource.
    Y/N
    Replace full width characters
    Latin characters have two representations in Unicode: half- and full-width. Half-width characters are used most often. This option allows you to normalize full-width characters (which may be in use in Japan and other countries) to half-width characters (which is required by Primo).
    If you modify this parameter, it is necessary to update the pipe and then re-index the relevant data sources.
    If set to Y, it enables the system to convert UTF-8 full-width characters to half-width characters in the PNX so that the search engine can perform searches.
    The default value is N.
    N
    Session Timeout
    The time in minutes in which a session will time out due to inactivity. The valid values are 15 - 60 minutes. The default value is 30 minutes.
    30
    Session Timeout URL
    This field specifies the page to which the user will be redirected after a session times out.
    To configure the Session Timeout URL to be any file:
    1. Enter the URL of the file, using the following format:
      http://<server:port>/primo_ library/libweb/static_htmls/<file>
    2. Enter the following commands to access the static_htmls directory:
      fe_web
      cd static_htmls
    3. Place the file in the static_htmls directory.
    The system defaults to search.do.
    Tags_As_List_Or_
    Cloud
    Indicates whether Primo's front end defaults to the cloud or list view for tags.
    L/C
    Use_SSL
    Indicates whether to use SSL.
    Y/N

     

    Publishing Parameters

    The following table describes the fields for the Publishing subsystem:
    Publishing
    Field name Description Example
    Encode Resumption Token
    This item is relevant to OAI-PMH harvesting. It indicates whether to encode the resumption token (such as characters like @) within the OAI protocol. The valid values are true and false. The default value is false.
    true
    OAI.harvester.
    default.timeout
    Defines the OAI harvesting timeout in milliseconds. The default value is 60 seconds.
    60000
    OAI.harvester.
    default.maxRetries
    Defines the number of times a publishing pipe will retry an OAI server after a failed request, such as if there is a connection error to the OAI server or the OAI server returned a 503 (service unavailable) response. The default value is 3.
    3
    primo.dedup.CDLArticlesMatching
    Profile
    This field defines the file that is used by the dedup algorithm for articles matching.
    CDLArticles
    MatchingProfile.xml
    primo.dedup.CDLMatchingProfile
    This field defines the file that is used by the dedup algorithm for non-serials matching.
    CDLMatchingProfile.xml
    primo.dedup.CDLSeMatchingProfile
    This field defines the file that is used by the dedup algorithm for serials matching.
    CDLSeMatchingProfile.xml
    primo.process.MaxUncompressedFileSize
    This field defines the maximum size of an uncompressed file that is harvested.
    To disable the limitation and accept any file size, change this parameter to -1, and then deploy the System Configuration option on the Deploy All page. Note that if you are using custom file-splitters that write the entire file to memory, the Back Office server may fail due to lack of memory if the files are too large.
    314572800
    publish.process.
    MaxAllowedFailedBulks
    This field defines the maximum number of failed blocks that are allowed by the system.
    The default value is 2.
    2
    publish.process.
    PhysicallyDelete
    Record
    This field indicates whether the system will automatically remove records that have been marked for deletion in the P_PNX table.
    Records that have been marked for deletion cannot be removed from the P_PNX table until the indexes in the search engine (SE) have been removed and the hotswapping process has been run. The physical_delete_records pipe has been created to delete PNX records that were updated between the last SE index run and the previous delete pipe run.
    By default, the physical_delete_records pipe is enabled. To disable the pipe, set this field to false.
    Note that Primo executes this pipe only after the execution of the following processes:
    • Indexing_Hotswapping
    • Indexing_Didumean_Hotswapping
    • Hotswapping
    false

    Remote Search Parameters

    The following table describes the fields for the Remote Search subsystem:
    Remote Search
    Field name Description Example
    Maximum_Number_Of_Local_Results
    This parameter defines the maximum number of local results to retrieve in mixed search (local and remote). There is no limit on the maximum number.
    60
    MetaLib_Version
    Indicates the MetaLib version being used.
    4.0
    Remote_Search_
    Timeout
    The length of time (in seconds) to perform a remote search. If the limit is exceeded, Primo returns the results that have already been retrieved. Further results can be displayed by clicking the Display more results link.
    30

    RTA Parameters

    The following table describes the fields for the RTA subsystem:
    RTA
    Field name Description Example
    RTA method for mapping data
    This field indicates which RTA method to use for mapping data. The following methods are valid:
    • normalization_rules – This method uses the rules specified in the normalization rules to match the institution, library, and sub-location.
    • mapping_table – This method uses the mapping tables to match the institution, library, and sub-location.
    If the normalization rules for your source system modify the location information in the display/availlibrary field, you should use the normalization_rules method.
    For more information on RTA, see the Primo Interoperability Guide.
    normalization_rules
    RTA Timeout
    This field indicates how long Primo will wait to get the RTA information. The maximum supported value is 20 seconds, which is the default.
    If an RTA request aborts because of a timeout, Primo displays the availability information that is stored in the PNX record.
    20

    Security Parameters

    The following table describes the fields for the Security subsystem. Changes to these fields require you to deploy the System Configuration option on the Primo Home > Deploy All page.
    Security
    Field name Description Example
    Access Limit Long Time Period
    The maximum duration in seconds that is allowed for the long term limit. The default value is 86400 seconds.
    75
    Access Limit Short Time Period
    The maximum duration in seconds that is allowed for the short term limit. The default value is 60 seconds.
    10
    Active clickjack filter
    Indicates whether the Open Web Application Security Project (OWASP) recommended clickjacking filter has been enabled. It is used for adding an X-FRAME-OPTIONS HTTP response header to tell IE8 (and any other browsers) not to display content in a frame that is not from the same origin. The valid values are Y or N. The default value is N.
    When the clickjacking filter is enabled, it prevents the use of embedded searches if using iframes.
     
    Blocked List expiration Time
    The amount of time in hours that an IP will be blocked. Note that the IP is unblocked when the FE is restarted. The default value is 24 hours.
    12
    IP DoS Filter-Enabled
    Indicates whether the automatic IP-based DoS filter is enabled. The following values are valid:
    • false - Disabled
    • print_only (default) - Logs requests that exceed the maximum number of requests, but the system will not block IP addresses. To view these logs, use the following command: cat library_server.log | grep ‘Attacking request(info):’
    • true - Enabled. To view these logs, use the following command: cat library_server.log | grep ‘Blocked request;’
    When this filter is enabled, the system automatically counts requests from IPs (which do not belong to a session). If the number of requests (mainly search attempts) exceeds the value specified for the IP DoS Filter-Max Allowed Requests parameter in the interval specified by the IP DoS Filter-Interval parameter, the IP will be blocked.
    Because this filter does not identify a single user and campuses often use a single external IP (NAT), thresholds should be much higher.
    Blocked users will not receive an informative error by design.
    false
    IP DoS Filter-Interval
    Indicates the interval at which requests are counted for the IP-based filters: IPs to block and IP DoS Filter-Enabled.
    5
    IP DoS Filter-Max Allowed Requests
    Indicates the maximum number of requests permitted during the interval specified in the IP DoS Filter-Interval parameter.
    40
    IPs to block
    Indicates whether the manual IP-based DoS filter is enabled. You can specify a list of IP addresses and IP ranges to monitor by separating each address with a semicolon. For example: 80.191.69.241;80.192.69;80.193;81
    Blocked users will not receive an informative error by design.
     
    Long Term Access Limit
    The maximum number of calls per IP (via API or browser) before IP is blocked to prevent Distributed Denial-of-Service (DDoS) attacks. The default value is 85000.
    The long term limit is used to catch IPs that are consistently just below the access short term limit.
    5000
    Session DoS Filter-Enabled
    Indicates whether the automatic session-based DoS filter is enabled. The following values are valid:
    • false - Disabled
    • print_only (default) - Logs requests that exceed the maximum number of requests, but the system will not block sessions. To view these logs, use the following command: cat library_server.log | grep ‘Attacking request(info):’
    • true - Enabled. To view these logs, use the following command: cat library_server.log | grep ‘Blocked request;’
    When this filter is enabled, the system automatically counts requests that have a session ID. If the number of requests (mainly search attempts) exceeds the value specified for the Session DoS Filter-Max Allowed Requests parameter in the interval specified by the Session DoS Filter-Interval parameter, the IP will be blocked.
    Blocked users will not receive an informative error by design.
    true
    Session DoS Filter-Interval
    Indicates the interval at which requests are counted for the session-based filter.
    10
    Session DoS Filter-Max Allowed Requests
    Indicates the maximum number of requests permitted during the interval specified in the Session DoS Filter-Interval parameter.
    10
    Short Term Access Limit
    The maximum number of calls per IP (via API or browser) before IP is blocked to prevent Distributed Denial-of-Service (DDoS) attacks. The default value is 5000.
    500

     

    Statistics Parameters

    The following table describes the fields for the Statistics subsystem:
    Statistics
    Field name Description Example
    Statistics_Batch_
    Duration
    The length of time used while creating statistical reports.
    3600
    Statistics_Batch_
    Size
    The size of the batch used for creating statistical reports.
    1000

    Thesholds Parameters

    The following table describes the fields for the Thresholds subsystem:
    Thresholds
    Field name Description Example
    High CPU Load
    The maximum amount of loads allowed on the CPU.
    6
    High Used File System Space
    The maximum percentage allowed of used file system space.
    90
    Low Free Table Space
    The minimum percentage of free database space required.
    10
    REDIRECT DOS MAX CALL TIMES
    Stops loops if Primo determines that the same request is received too many times for an application.
    75