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: RESTOAuth2ClientCredentials
  10               choices:
  11                   yes: Enable
  12                   no: "Disable"
  13             - "the OAuth2 client credentials grant for the REST API. Requires Net::OAuth2::AuthorizationServer installed. [EXPERIMENTAL]"
  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             - '.  Please, insert prefix without ending colon (":") char. The archiveID should respect OAI specification. See '
  26             - '<a href="http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm">Implementation guidelines</a>. '
  27             - 'Example: "oai:example-library.org"'
  28         -
  29             - Only return
  30             - pref: "OAI-PMH:MaxCount"
  31               class: integer
  32             - records at a time in response to a ListRecords or ListIdentifiers query.
  33         -
  34             - "YAML OAI Koha server configuration file:"
  35             - pref: "OAI-PMH:ConfFile"
  36               class: file
  37             - . 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.
  38         -
  39             - pref: "OAI-PMH:AutoUpdateSets"
  40               choices:
  41                   yes: Enable
  42                   no: Disable
  43             - automatic update of OAI-PMH sets when a bibliographic record is created or updated
  44         -
  45             - Koha's deletedbiblio table
  46             - pref: "OAI-PMH:DeletedRecord"
  47               choices:
  48                   persistent: will never be emptied or truncated (persistent)
  49                   transient: might be emptied or truncated at some point (transient)
  50                   no: will never have any data in it (no)
  51             - "."
  52     ILS-DI:
  53         -
  54             - pref: ILS-DI
  55               choices:
  56                 yes: Enable
  57                 no: Disable
  58             - "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
  59         -
  60             - Allow IP addresses
  61             - pref: ILS-DI:AuthorizedIPs
  62               class: Text
  63             - 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.
  64     Mana:
  65         -
  66             - pref: Mana
  67               choices:
  68                 yes: Enable
  69                 no: Disable
  70                 2: No, let me think about it
  71             - request to Mana Webservice. Mana centralize commun information between other Koha to facilitate the creation of new subscriptions, vendors, report queries etc... You can search, share, import and comment the content of Mana. The informations shared with Mana KB are shared under the CC-0 license. More infos about CC-0 license on https://creativecommons.org/choose/zero/
  72         -
  73              - "Security token used to authenticate on mana:"
  74              - pref: ManaToken
  75                class: Text
  76         -
  77             - 'Fields automatically shared with mana'
  78             - pref: AutoShareWithMana
  79               multiple:
  80                 subscription: Subscriptions
  81     Reporting:
  82         -
  83             - Only return
  84             - pref: SvcMaxReportRows
  85               class: integer
  86             - rows of a report requested via the reports web service.
  87     IdRef:
  88         -
  89             - pref: IdRef
  90               choices:
  91                 yes: Enable
  92                 no: Disable
  93             - the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.
  94             - Please note that this feature is available only for UNIMARC.