koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/web_services.pref

   1 Web services:
   2     REST API:
   3         -
   4             - "Set the default number of results returned by the REST API endpoints to"
   5             - pref: "RESTdefaultPageSize"
   6               class: integer
   7             - "per page"
   8         -
   9             - pref: AllowPatronsManageAPIKeysInOPAC
  10               choices:
  11                   yes: Allow
  12                   no: "Don't allow"
  13             - "patrons to manage their own API keys in the OPAC."
  14     OAI-PMH:
  15         -
  16             - pref: OAI-PMH
  17               choices:
  18                   yes: Enable
  19                   no: Disable
  20             - "Koha's"
  21             - '<a href="http://www.openarchives.org/pmh/">OAI-PMH</a> server.'
  22         -
  23             - Identify records at this site with the prefix
  24             - pref: "OAI-PMH:archiveID"
  25             - ": ."
  26         -
  27             - Only return
  28             - pref: "OAI-PMH:MaxCount"
  29               class: integer
  30             - records at a time in response to a ListRecords or ListIdentifiers query.
  31         -
  32             - "YAML OAI Koha server configuration file:"
  33             - pref: "OAI-PMH:ConfFile"
  34               class: file
  35             - . If empty, Koha OAI Server operates in normal mode, otherwise it operates in extended mode. In extended mode, it's possible to parameter other formats than marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML configuration file which list available metadata formats and XSL file used to create them from marcxml records.
  36         -
  37             - pref: "OAI-PMH:AutoUpdateSets"
  38               choices:
  39                   yes: Enable
  40                   no: Disable
  41             - automatic update of OAI-PMH sets when a bibliographic record is created or updated
  42         -
  43             - Koha's deletedbiblio table
  44             - pref: "OAI-PMH:DeletedRecord"
  45               choices:
  46                   persistent: will never be emptied or truncated (persistent)
  47                   transient: might be emptied or truncated at some point (transient)
  48                   no: will never have any data in it (no)
  49             - "."
  50     ILS-DI:
  51         -
  52             - pref: ILS-DI
  53               choices:
  54                 yes: Enable
  55                 no: Disable
  56             - "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
  57         -
  58             - Allow IP addresses
  59             - pref: ILS-DI:AuthorizedIPs
  60               class: Text
  61             - to use the ILS-DI services (when enabled). Separate the IP addresses with commas and without spaces. Leave the field blank to allow any IP address.
  62     Reporting:
  63         -
  64             - Only return
  65             - pref: SvcMaxReportRows
  66               class: integer
  67             - rows of a report requested via the reports web service.
  68     IdRef:
  69         -
  70             - pref: IdRef
  71               choices:
  72                 yes: Enable
  73                 no: Disable
  74             - the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.
  75             - Please note that this feature is available only for UNIMARC.