Voyagerin kanssa käytettävä VoyagerRestful-ajuri tarjoaa joukon asetuksia, joista ylivoimaisesti suurin osa vaikuttaa siihen, miten varaukset toimivat Finnassa. Koska asetukset vaikuttavat kaikkiin näkymiin, pidetään tietokantakohtaisia asetustiedostoja yllä keskitetysti. Niihin ei siis kannata tehdä muutoksia paikallisesti. Tällä sivulla kuvataan kuitenkin saatavissa olevat asetukset, jotta kaikki tietäisivät, mihin on mahdollista vaikuttaa. Lisäksi VoyagerRestful-ajurin ohjelmakoodia on mahdollista muokata paikallisesti omassa näkymässä.
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| secondary_login_field | teksti | tyhjä | Voyagerin tietokannan kentän nimi ja otsikko kaksoispisteellä eroteltuna. Jos määritelty, tämä tieto vaaditaan normaalin käyttäjän viivakoodin lisäksi. Tällä hetkellä tuettuna on vain arvo: "LAST_NAME:Last Name" |
| login_password_blacklist[] | teksti | tyhjä | (käytettävissä 21.6.2016 alkaen) Lista arvoista, joita ei voi käyttää salasanana kirjautumisessa tai salasanan vaihdossa, esim. |
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| enableItemHolds | Kyllä/Ei | Kyllä | Onko nidekohtainen varaus ylipäänsä käytössä |
| enableRequestGroups | Kyllä/Ei | Ei | Ovatko request groupit käytössä |
| enableRecalls | Kyllä/Ei | Kyllä | Onko recall-toiminto käytössä |
| valid_hold_statuses | id-lista | tyhjä | Lista tiloista, joihin niteen tilan täytyy kuulua, jotta nidekohtainen varaus olisi sallittu |
| borrowable | id-lista | tyhjä | Lista tyypeistä (ITEM_TYPE-taulusta), joihin niteen tyypin tulee kuulua, jotta nidekohtainen varaus olisi sallittu (toteutus sprint 32, käytettävissä 13.3.2014 alkaen) |
| non_borrowable | id-lista | tyhjä | Lista tyypeistä (ITEM_TYPE-taulusta), joihin niteen tyyppi ei saa kuulua, jotta nidekohtainen varaus olisi sallittu |
| extraHoldFields | lista | comments: | Lista kentistä, jotka varauslomakkeella näytetään. Mahdolliset arvot ovat comments, requiredByDate ja pickUpLocation. |
| defaultRequiredDate | päivät, kuukaudet, vuodet | 1 kk | Nykyhetkestä eteenpäin laskettava päivämäärä varauksen voimassaololle |
| defaultPickUpLocation | Määrittelemätön, tyhjä tai location id | Määrittelemätön | Jos määrittelemätön, käyttäjän on aina valittava noutopiste itse. Jos tyhjä, oletuksena ensimmäinen noutopiste. Muuten oletuksena annettu noutopiste. |
| pickUpLocationOrder | id-lista | tyhjä | Noutopisteiden järjestys valintakentässä. Noutopisteet, joita tässä ei listata, näytetään aakkosjärjestyksessä. |
| defaultRequestGroup | Ei, tyhjä, tai group id | Ei | Jos Ei, käyttäjän on aina valittava request group itse. Jos tyhjä, oletuksena ensimmäinen request group. Muuten oletuksena annettu request group. |
| requestGroupOrder | id-lista | tyhjä | Request groupien järjestys valintakentässä. Groupit, joita tässä ei listata, näytetään aakkosjärjestyksessä. |
| pickupLocationsInRequestGroup | Kyllä/Ei | Ei | Tuleeko noutopisteen kuulua valittuun request groupiin |
| checkItemsExist | Kyllä/Ei | Ei | Tarkistetaanko, että (valitussa request groupissa, jos groupit käytössä) on niteitä |
| checkItemsAvailable | Kyllä/Ei | Ei | Tarkistetaanko, ettei (valitussa request groupissa, jos groupit käytössä) ole niteitä saatavissa |
| disableAvailabilityCheckForRequestGroups | id-lista | tyhjä | Lista request groupeista, joista saa varata, vaikka niteitä olisi saatavilla ja checkItemsAvailable-asetus on päällä |
| excludedItemLocations | id-lista | tyhjä | Lista niteen sijainneista, jotka jätetään huomiotta, kun tarkistetaan niteiden olemassaoloa (checkItemsExist) tai saatavuutta (checkItemsAvailable) |
| checkLoans | Kyllä/Ei/"same-item" | Ei | Tarkistetaanko, ettei asiakkaalla ole jo varattava teos lainassa. Jos arvona on "Kyllä" (true), mikä tahansa nide lainassa estää varauksen. Jos arvona on "same-item" (käytettävissä 21.3. alkaen), nidekohtainen varaus estetään vain, jos varattava nide on jo asiakkaalla lainassa. |
| allowCancelingAvailableRequests | Kyllä/Ei | Kyllä | Sallitaanko saapuneiden varausten poistaminen |
| helpText | teksti | tyhjä | Varausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[fi] | teksti | tyhjä | Suomenkielisessä varausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[sv] | teksti | tyhjä | Ruotsinkielisessä varausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[en-gb] | teksti | tyhjä | Englanninkielisessä varausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
Lisäksi on optionaalinen sektio pickUpLocations, johon voidaan listata noutopisteet, jos ne halutaan määritellä Voyagerin asetuksista riippumatta.
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| extraFields | lista | comments: | Lista kentistä, jotka varauslomakkeella näytetään. Mahdolliset arvot ovat comments, item-issue ja pickUpLocation (pickUpLocation toteutus sprint 32, käytettävissä 14.3.2014 alkaen) |
| valid_item_types | id-lista | tyhjä | Lista niteen tyypeistä, joihin tyypin täytyy sisältyä, jotta tilaus olisi sallittu |
| helpText | teksti | tyhjä | Tilausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[fi] | teksti | tyhjä | Suomenkielisessä tilausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[sv] | teksti | tyhjä | Ruotsinkielisessä tilausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[en-gb] | teksti | tyhjä | Englanninkielisessä tilausdialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| pickupByCallSlipGroup | Kyllä/Ei | Ei | Rajoitetaanko varastotilauksen noutopaikka CALL_SLIP_PRINT_GROUP:n mukaan. HUOM! Vaatii päällekytkemiseksi myös sen, että requestType on HMACKeys-asetuksessa. |
| display_statuses | id-lista | 1:2:3:5:8:9 | Lista CALL SLIP -statuksista, joiden perusteella CALL SLIP näytetään varastotilauslistassa. Koska Voyager poistaa varastotilauksen vasta kun siitä vastaava circjob ajetaan, voidaan tällä jättää näyttämättä esim. käsitelty tilaus, josta on jo muodostunut varaus. |
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| enabled | Kyllä/Ei | Ei | Onko UB-lainaus käytössä |
UBRequestSources VuFind 2: ILLRequestSources | tietokannan nimi = UB-ID | tyhjä | Sektio, jossa on listattu kaikki ne muut tietokannat, joiden käyttäjillä on oikeus tehdä UB-lainapyyntöjä tähän tietokantaan. |
| pickUpLocations | id-lista | tyhjä | Lista käyttäjän valittavissa olevista kirjaston noutopisteistä. Jos noutopiste(et) on määritelty, käyttäjä ei voi valita noutokirjastoa. Muussa tapauksessa kaikki noutokirjastot ja noutupisteet ovat valittavissa. |
| helpText | teksti | tyhjä | UB-dialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[fi] | teksti | tyhjä | Suomenkielisessä UB-dialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[sv] | teksti | tyhjä | Ruotsinkielisessä UB-dialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| helpText[en-gb] | teksti | tyhjä | Englanninkielisessä UB-dialogissa näytettävä ohjeteksti. Voi sisältää html-koodia. |
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| minLength | numero | 5 | Uuden PIN-koodin minimipituus |
| maxLength | numero | 12 | Uuden PIN-koodin maksimipituus |
| pattern | teksti | tyhjä | Rajoitus uuden PIN-koodin muodolle. Mahdolliset arvot: "numeric" - vain numerot "alphanumeric" - vain perusaakkoset (a-z) ja numerot regexp - säännöllinen lauseke |
| hint | teksti | pattern:n perusteella | Vihje (tai käännöskoodi) siitä, mitä salasana saa sisältää. Lähinnä tarpeen, kun käytetään regexp-rajoitusta. Vaihtoehdoille "numeric" ja "alphanumeric" on jo olemassa valmiit käännöstekstit. |
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| purchase_history | Kyllä/Ei/Jaettu | Kyllä | Näytetäänkö hankintahistoria muiden saatavuustietojen alla (kyllä), kunkin holdingsin kohdalla (jaettu) vai ei ollenkaan (ei) |
| notes | teksti | 506au:845a:852z | Huomautuksissa näytettävät kentät |
| summary | teksti | 863abiz:866az | Yhteenvedossa näytettävät kentät |
| supplements | teksti | 867az | Lisänumeroissa näytettävät kentät |
| indexes | teksti | 868az | Hakemistoissa näytettävät kentät |
| use_sort_groups | Kyllä/Ei | Kyllä | Käytetäänkö saatavuustietojen järjestämiseen Voyagerin holdings sort groupeja |
| order_statuses | teksti | Pending:Approved:Approved/Sent | Käyttäjille näytettävät hankinnan tilat |
| order_formats | teksti | (ei rajausta) | Käyttäjälle näytettävien hankinnan tilojen aineistotyyppirajaus (esim. am:jm). |
Valituille niteen statuksille voidaan määritellä normaalista poikkeava prioriteetti saatavuustietojen näyttämistä varten. Normaalisti niteen tilat järjestyvät status-tyypin numeron mukaisesti, mikä johtaa siihen, että jotkin statukset jäävät vähemmän tärkeiden statusten alle. Oletuksena käytössä ovat seuraavat poikkeukset (mitä pienempi numero, sitä tärkeämpi status):
Missing = 0
Recall Request = 99
Hold Request = 99
Käyttäjille voidaan sallia pääsy lisensioituihin aineistoihin Voyager-kirjautumisen perusteella.
Huom! Jotta tällä asetuksella olisi vaikutus, pitää VuFindin configin Authorization-sektion authentication_methods-listan sisältää ILS (hallintaliittymässä: Ulkoiset aineistot > Salli pääsy lisensioituihin aineistoihin kirjastokortilla kirjautuneille). Muuten auktorisointi kirjastokortin perusteella ei ole ollenkaan käytössä.
Tällä hetkellä käytettävissä on kaksi asetusta, jotka vaikuttavat auktorisointiin tietokantakohtaisesti:
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| enabled | Kyllä/Ei | Ei | Voiko käyttäjä saada käyttöoikeuden elektronisiin aineistoihin kirjautumalla Voyagerin kirjastokortilla |
| stat_codes | koodilista | tyhjä | Lista tilastointikoodeista, joihin kuuluvat asiakkaat saavat käyttöoikeuden. Oletuksena kaikki kirjautuvat käyttäjät saavat käyttöoikeuden, mutta tällä asetuksella voidaan rajata auktorisointi vain tietyille asiakasryhmille. |
Verkkomaksamisen asetukset sijoitetaan 'OnlinePayment' -osioon:
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| enabled | Kyllä/Ei | Ei | Voiko käyttäjä maksaa verkkomaksuja Voyager kirjastokortilla. |
| nonPayable | koodilista | tyhjä | Lista maksukoodeista, joita ei voi maksaa verkossa. Listalla olevan maksun esiintyminen estää asiakkaan kaikki verkkomaksut. |
| transactionFee | numero | Palvelumaksu (senteissä). | |
| minimumFee | numero | Pienin maksettavissa oleva summa (senteissä). | |
| errorEmail | teksti | Sähköpostiosoite, johon lähetetään ilmoitus epäonnistuneista maksuista. | |
| transactionMaxDuration | numero | Kuinka monta minuuttia odotetaan, että käyttäjä palaa maksupalvelusta takaisin Finnaan. | |
| currency | teksti | Valuutta. | |
| Kirjastojärjestelmän yhteysasetukset maksujen rekisteröintiä varten: | |||
| registrationMethod | teksti | SIP2 | Yhteysmenetelmä. |
| registrationParams['host'] | teksti | Osoite. | |
| registrationParams['port'] | teksti | Portti. | |
| registrationParams['userId'] | teksti | Käyttäjätunnus. | |
| registrationParams['password'] | teksti | Salasana. | |
| registrationParams['locationCode'] | teksti | Organisaation Voyagerin location koodi. | |
Maksupalvelun asetukset sijoitetaan tiedostoon datasources.ini | |||
| onlinePayment['handler'] | teksti | Maksupalvelu (tällä hetkellä aina 'Paytrail'). | |
| onlinePayment['url'] | teksti | Osoite. | |
| onlinePayment['merchantId'] | teksti | Kauppiastunnus. | |
| onlinePayment['secret'] | teksti | Salasana. | |
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| method | teksti | - | url = ohjaus ulkoiseen osoitteeseen email = Finnassa täytettävä lomake, jonka sisältö lähetetään sähköpostilla kirjastoon |
| url | teksti | - | url-metodia käytettäessä osoite, johon käyttäjä ohjataan |
| url[fi] url[sv] url[en-gb] | teksti | - | Vaihtoehtoiset kielikohtaiset osoitteet |
| emailAddress | teksti | - | Sähköpostiosoite, johon muutospyynnöt ohjataa email-metodilla |
| fields[] | lista | address1, zip, city, country, phone, email | Lista kentistä, joita osoitteenmuutospyyntölomakkeella näytetään |