docs/modules/admin/pages/global_flags.adoc

   1 = Global Flags =
   2
   3 == Introduction ==
   4 indexterm:[Global Flags]
   5
   6 Evergreen uses Global Flags to set certain elements that are global across an Evergreen instance. Unlike Library Settings, Global Flags cannot hold different values for different libraries.
   7
   8 The Global Flags interface is found under *Administration -> Server Administration -> Global Flags*.
   9
  10 The table below is sorted in alphabetical order according to the _Name_ column. The _Other Information_ column contains links to a bug, release notes, commit message, or documentation, as applicable for that particular global flag.
  11
  12 == Global Flags Details ==
  13
  14 [options="header"]
  15 |===
  16 |Name|Label|Enabled (Default)|Value (Default)|Notes|Other Information
  17 |auth.block_expired_staff_login |Block the ability of expired user with
  18 the STAFF_LOGIN permission to log into Evergreen. |No | |If this flag is
  19 enabled, accounts that have the STAFF_LOGIN permission and whose
  20 expiration date is in the past are prevented from logging into any
  21 Evergreen interface, including the staff client, the public catalog, and
  22 SIP2. Regular non-staff patrons are allowed to log into the public
  23 catalog with expired accounts.
  24 |https://bugs.launchpad.net/evergreen/+bug/1474029[bug 1474029]
  25
  26 |cat.bib.use_id_for_tcn |Cat: Use Internal ID for TCN Value |Yes |
  27 |Matches the bibliographic record's TCN to its Evergreen database ID |
  28
  29 |cat.maintain_control_numbers |Cat: Maintain 001/003/035 according to
  30 the MARC21 specification |Yes | |
  31 |https://git.evergreen-ils.org/?p=Evergreen.git;a=commit;h=cf3c03004915f7ab8c73c3dff90c8ddc7375186d[Commit message]
  32
  33 |circ.desk_renewal.use_original_circ_lib |Circ: Use original circulation
  34 library on desk renewal instead of the workstation library |No | |Left
  35 disabled, the workstation library's circulation/renewal policy will be
  36 used, rather than the user's home/original library circulation/renewal
  37 policy during a staff client (desk) renewal. By default, a desk renewal
  38 looks at the policies of the workstation library performing the renewal.
  39 |
  40
  41 |circ.holds.empty_issuance_ok |Holds: Allow holds on empty issuances
  42 |Yes | |holds on predicted but not-yet received items |
  43
  44 |circ.holds.retarget_interval |Holds Retarget Interval |Yes |24h |
  45 |https://bugs.launchpad.net/evergreen/+bug/1596595[bug 1596595]
  46
  47 |circ.holds.usr_not_requestor |Holds: When testing hold matrix
  48 matchpoints, use the profile group of the receiving user instead of that
  49 of the requestor (affects staff-placed holds) |Yes | |
  50 |https://bugs.launchpad.net/evergreen/+bug/1473576[bug 1473576]
  51
  52 |circ.opac_renewal.use_original_circ_lib |Circ: Use original circulation
  53 library on opac renewal instead of user home library |No | |Left
  54 disabled, the user's home library circulation/renewal policy will be
  55 used, rather than the original circulation library's circulation/renewal
  56 policy during an OPAC renewal. By default, an OPAC renewal looks at the
  57 policies of the user's home library. |
  58
  59 |history.circ.retention_age |Historical Circulation Retention Age |Yes |
  60 |Determines the timeframe for aging circulations based on transaction
  61 age. If you want your users to be able to retain their circulation
  62 history and view it in the OPAC, then click True, and set a global
  63 maximum. The maximum is a length of time entered in double quotes, such
  64 as "1 year". Beginning the day that you set it and each day for a year
  65 forward in time, the circs will be saved. This setting is the default
  66 for your entire network. If you don’t want patrons to be able to retain
  67 their circulation history, then set this to false. If value is not set,
  68 it will default to forever - Note: if you scope in the value of aged
  69 circulations they still exist just anonymized. There isn't a feature to
  70 delete circs at any point, you'd have to go in and do it with a custom
  71 script. |xref:admin:aged_circs.adoc#_global_flags[Aging Circulations]
  72
  73 |history.circ.retention_age_is_min |Historical Circulations are kept for
  74 global retention age at a minimum, regardless of user preferences. |No |
  75 |This flag is no longer useful, since user circ history no longer needs
  76 to prevent circs from being aged to be complete. |xref:admin:aged_circs.adoc#_global_flags[Aging Circulations]
  77
  78 |history.circ.retention_count |Historical Circulations per Copy |Yes |
  79 |This flag is about aging circs to anonymize them. |xref:admin:aged_circs.adoc#_global_flags[Aging Circulations]
  80
  81 |history.circ.retention_uses_last_finished |Historical Circulations use
  82 most recent xact_finish date instead of last circ's. |No | |This flag is
  83 about aging circs to anonymize them. |xref:admin:aged_circs.adoc#_global_flags[Aging Circulations]
  84
  85 |history.hold.retention_age |Historical Hold Retention Age |Yes |
  86 |Determines the timeframe to retain holds information. Purged holds are
  87 moved to the action.aged_hold_request table with patron identifying
  88 information scrubbed, much like circulations are moved to
  89 action.aged_circulation. The settings allow for a default retention age
  90 as well as distinct retention ages for holds filled, holds canceled, and
  91 holds canceled by specific cancel causes. The most specific one wins
  92 unless a patron is retaining their hold history. In the latter case the
  93 patron’s holds are retained either way. Note that the function still
  94 needs to be called, which could be set up as a cron job or done more
  95 manually, say after statistics collection. Script, purge_holds.srfsh,
  96 can be used to purge holds from cron. |https://docs.evergreen-ils.org/2.5/_administration.html[Release Notes] - located under "Purge Holds"
  97
  98 |history.hold.retention_age_canceled |Historical Hold Retention Age -
  99 Canceled (Default) |No | | |
 100
 101 |history.hold.retention_age_canceled_1 |Historical Hold Retention Age -
 102 Canceled (Untarged expiration) |No | | |
 103
 104 |history.hold.retention_age_canceled_2 |Historical Hold Retention Age -
 105 Canceled (Hold Shelf expiration) |No | | |
 106
 107 |history.hold.retention_age_canceled_3 |Historical Hold Retention Age -
 108 Canceled (Patron via phone) |Yes | | |
 109
 110 |history.hold.retention_age_canceled_4 |Historical Hold Retention Age -
 111 Canceled (Patron in person) |Yes | | |
 112
 113 |history.hold.retention_age_canceled_5 |Historical Hold Retention Age -
 114 Canceled (Staff forced) |Yes | | |
 115
 116 |history.hold.retention_age_canceled_6 |Historical Hold Retention Age -
 117 Canceled (Patron via OPAC) |No | | |
 118
 119 |history.hold.retention_age_fulfilled |Historical Hold Retention Age -
 120 Fulfilled |No | | |
 121
 122 |history.money.age_with_circs |Age billings and payments when
 123 circulations are aged. |No | | |
 124
 125 |history.money.retention_age |Age billings and payments whose
 126 transactions were completed this long ago. For circulation transactions,
 127 this setting is superseded by the "history.money.age_with_circs" setting
 128 |No | | |
 129
 130 |ingest.disable_authority_auto_update |Authority Automation: Disable
 131 automatic authority updating (requires link tracking) |No | |If enabled,
 132 Evergreen will link authorities, but will not automatically propagate
 133 changes |
 134
 135 |ingest.disable_authority_auto_update_bib_meta |Authority Automation:
 136 Disable automatic authority updates from modifying bib record editor and
 137 edit_date |No | | |
 138
 139 |ingest.disable_authority_linking |Authority Automation: Disable
 140 bib-authority link tracking |No | |If enabled, Evergreen won't link
 141 authorities and won't propagate changes |
 142
 143 |opac.browse.holdings_visibility_test_limit |Don't look for more than
 144 this number of records with holdings when displaying browse headings
 145 with visible record counts. |Yes |100 | |
 146
 147 |opac.browse.warnable_regexp_per_class |Map of search classes to regular
 148 expressions to warn user about leading articles. |No | {"title":
 149 "^(a\|the\|an)\\s"} |Warns users when they are entering a browse term that
 150 begins with an article |xref:opac:catalog_browse.adoc[Catalog Browse]
 151
 152 |opac.cover_upload_compression |Cover image uploads are converted to PNG
 153 files with this compression, on a scale of 0 (no compression) to 9
 154 (maximum compression), or -1 for the zlib default. |Yes |0 |Accepts a
 155 numeric value from 0 (no compression) to 9 (most compression). The
 156 default is 0. All uploaded files are converted to png and use this flag.
 157 |xref:cataloging:cover_image_upload.adoc[Cover Image Uploader]
 158
 159 |opac.default_sort |OPAC Default Sort (titlesort, authorsort, pubdate,
 160 popularity, poprel, or empty) |Yes | |This flag tells Evergreen how to
 161 sort the results of an OPAC search. You can enter one of the sort
 162 options that you see listed here, or you can leave the field empty, and
 163 Evergreen will sort on relevance. |xref:admin:popularity_badges_web_client.adoc#_new_global_flags[Statistical Popularity Badges]
 164
 165 |opac.format_selector.attr |OPAC Format Selector Attribute |Yes
 166 |search_format |Defines which record attribute definition will be used
 167 to populate the OPAC Format dropdown filter located in both the Basic
 168 Search and Search Results pages. |
 169
 170 |opac.icon_attr |OPAC Format Icons Attribute |Yes |icon_format |Allows
 171 administrators to set which record attribute definition will be used as
 172 the icon format configuration. (Associated with the Record Attribute
 173 Definition and meta record development) |
 174
 175 |opac.located_uri.act_as_copy |When enabled, Located URIs will provide
 176 visibility behavior identical to copies. |No | | |xref:cataloging:cataloging_electronic_resources.adoc[Cataloging Electronic Resources]
 177
 178 |opac.metarecord.holds.format_attr |OPAC Metarecord Hold Formats
 179 Attribute |Yes |mr_hold_format |Allows user to utilize the metarecord
 180 level hold feature. |xref:opac:tpac_meta_record_holds.adoc[TPAC Metarecord Search and Metarecord Level Holds]
 181
 182 |opac.org_unit.non_inherited_visibility |Org Units Do Not Inherit
 183 Visibility |No | |
 184 |https://bugs.launchpad.net/evergreen/+bug/954310[bug 954310]
 185
 186 |opac.show_related_headings_in_browse |Display related headings
 187 (see-also) in browse |Yes | | |
 188
 189 |opac.use_autosuggest |OPAC: Show auto-completing suggestions dialog
 190 under basic search box (put 'opac_visible' into the value field to limit
 191 suggestions to OPAC-visible items, or blank the field for a possible
 192 performance improvement) |No |opac_visible |If enabled, ten suggestions
 193 are the default (number of suggestions is configurable at the database
 194 level) |xref:admin:auto_suggest_search.adoc[Auto Suggest in Catalog Search]
 195
 196 |opac.use_geolocation |Offer use of geographic location services in the
 197 public catalog |No | |The sort by geographic proximity feature allows
 198 library patrons to sort holdings within a bibliographic record by
 199 geographic distance. This feature requires a 3rd party geographic
 200 location service in order to function. If you are using your own
 201 geographic location service, then this flag must be enabled in order for
 202 proximity sort to work. The Value box does not need an entry and in fact
 203 any entry in that box will be ignored. |xref:admin_initial_setup:geosort_admin.adoc#_global_flag[Sort by Geographic Proximity]
 204
 205 |search.max_facets_per_field |Search: maximum number of facet values to
 206 retrieve for each facet field |Yes |1000 |
 207 |https://bugs.launchpad.net/evergreen/+bug/1505286[bug 1505286]
 208
 209 |search.max_popularity_importance_multiplier |Maximum popularity
 210 importance multiplier for popularity-adjusted relevance searches
 211 (decimal value between 1.0 and 2.0) |Yes |1.1 | |xref:admin:popularity_badges_web_client.adoc#_new_global_flags[Statistical Popularity Badges]
 212 |===