Kohan kanssa käytettävä ajuri tarjoaa joukon asetuksia, joilla voidaan vaikuttaa erityisesti siihen, miten käyttäjän profiili, saatavuustiedot ja varaus käyttäytyvät. Alla on kuvattu olennaiset asetukset. Suurin osa asetuksista on yhteisiä Koha-Suomi- ja yhteisöversioille.
Huom! Ota yhteys finna-postiin asetusten muokkaamiseksi keskitetysti. Paikallisesti tehtävät muutokset näkyisivät vain kyseisessä näkymässä.
Sisällysluettelo
Varaukset
(Holds)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| defaultRequiredDate | päivät, kuukaudet, vuodet | 2 vuotta | Varauksen tekohetkestä eteenpäin laskettava päivämäärä varauksen oletusvoimassaoloajalle. Voidaan asettaa myös tyhjäksi, jolloin oletusarvoa ei ole (erityisen käyttökelpoinen extraHoldFields:n requiredByDateOptional-asetuksen kanssa). |
| 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 | aakkosjärjestys | Noutopisteiden järjestys valintakentässä. Noutopisteet, joita tässä ei listata, näytetään aakkosjärjestyksessä. |
| excludePickupLocations | id-lista | Määrittelemätön | Lista noutopisteistä, jotka jätetään pois noutopisteen valintalistasta. Ei yleensä tarvita, koska noutopisteet voi määrittää Kohan puolella. |
| extraHoldFields | lista | requiredByDate: | Lista kentistä, jotka varauslomakkeella näytetään. Mahdolliset arvot ovat comments, requiredByDate, requiredByDateOptional, pickUpLocation ja acceptTerms. requiredByDateOptional on vaihtoehtoinen kenttä requiredByDate:lle, ja antaa mahdollisuuden jättää päättymispäivä määrittelemättä. Oletusarvo tulee siinäkin defaultRequiredDate:n perusteella. |
| helpText[*] | teksti | tyhjä | Lomakkeella näytettävä oletus-ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| helpText[fi] | teksti | tyhjä | Suomenkielisellä lomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| helpText[sv] | teksti | tyhjä | Ruotsinkielisellä lomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| helpText[en-gb] | teksti | tyhjä | Englanninkielisellä lomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| updateHelpText[*] | teksti | tyhjä | Muokkauslomakkeella näytettävä oletus-ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| updateHelpText[fi] | teksti | tyhjä | Suomenkielisellä muokkauslomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| updateHelpText[sv] | teksti | tyhjä | Ruotsinkielisellä muokkauslomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| updateHelpText[en-gb] | teksti | tyhjä | Englanninkielisellä muokkauslomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| acceptTermsText | teksti | tyhjä | Lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
| acceptTermsText[fi] | teksti | tyhjä | Suomenkielisellä lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
| acceptTermsText[sv] | teksti | tyhjä | Ruotsinkielisellä lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
| acceptTermsText[en-gb] | teksti | tyhjä | Englanninkielisellä lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
| allowCancelInTransit | Kyllä/Ei | Ei | Sallitaanko kuljetuksessa olevien varausten peruminen. Käytettävissä Finnan versiosta 2.87.0 (21.2.2023) lähtien. |
Varastonoudot
(StorageRetrievalRequests)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| allow_checked_out | Kyllä/Ei | Ei | Sallitaanko varastonoutopyynnöt lainatulle aineistolle |
| extraFields | lista | item-issue: | Lista kentistä, jotka lomakkeella näytetään. Mahdolliset arvot ovat comments, pickUpLocation, item-issue ja acceptTerms. |
| excludePickupLocations | id-lista | Määrittelemätön | Lista noutopisteistä, jotka jätetään pois noutopisteen valintalistasta. Ei yleensä tarvita, koska noutopisteet voi määrittää Kohan puolella. |
| helpText[*] | teksti | tyhjä | Lomakkeella näytettävä oletus-ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| helpText[fi] | teksti | tyhjä | Suomenkielisellä lomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| helpText[sv] | teksti | tyhjä | Ruotsinkielisellä lomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| helpText[en-gb] | teksti | tyhjä | Englanninkielisellä lomakkeella näytettävä ohjeteksti. Voi sisältää html-koodia. Huolehdittava html-koodauksesta. |
| acceptTermsText | teksti | tyhjä | Lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
| acceptTermsText[fi] | teksti | tyhjä | Suomenkielisellä lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
| acceptTermsText[sv] | teksti | tyhjä | Ruotsinkielisellä lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
| acceptTermsText[en-gb] | teksti | tyhjä | Englanninkielisellä lomakkeella optionaalisesti näytettävän ehtojen hyväksyntäkentän teksti. Voi sisältää html-koodia. |
Lainat
(Loans)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| max_page_size | numero | 100 | Lainalistalla yhdellä kertaa näytettävien lainojen maksimimäärä |
| displayItemType (vain Koha-yhteisö) | Kyllä/Ei | Ei | Näytetäänkö item type (aineistolaji) lainalistalla. Koodit käännettävissä käännösavaimella material_type_ajuri_koodi, esim. material_type_3amk_YLEIS = "Laina-aika 28 vrk" |
Profiili
(Profile)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
phoneNumberField | teksti | Määrittelemätön | Kohan asiakastietokenttä, joka näytetään Finnassa puhelinnumerona |
| smsNumberField | teksti | smsalertnumber (Koha-Suomi) sms_number (Koha-yhteisö) | Kohan asiakastietokenttä, joka näytetään Finnassa tekstiviestinumerona |
Omien tietojen muutospyyntö
(updateAddress)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| method | teksti | driver | Omien tietojen muutospyynnössä käytettävä toimintatapa:
|
| fields | array | address,zipcode,city,country,othernames (Koha-Suomi) address,postal_code,city,country,other_name (Koha-yhteisö) | Yhteystietojen muutoslomakkeella näytettävät kentät driver-metodia käytettäessä. Kentän nimet vastaavat Kohan rajapinnan kenttiä. |
| url | teksti | tyhjä | Muutospyyntölomakkeen osoite url-metodia käytettäessä |
url[fi] url[sv] url[en-gb] | teksti | tyhjä | Kielikohtainen muutospyyntölomakkeen osoite url-metodia käytettäessä. Vaihtoehto kaikille kielille käytettävälle url-asetukselle. |
Tekstiviestinumeron muuttaminen
(updateSmsNumber)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| fields | lista | smsalertnumber,phone (Koha-Suomi) sms_number,phone (Koha-yhteisö) | Kentät, joihin tekstiviestinumero päivittyy Kohassa |
PIN-koodin vaihto
(changePassword)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| minLength | numero | 4 | Uuden PIN-koodin minimipituus |
| maxLength | numero | 4 | Uuden PIN-koodin maksimipituus |
| pattern | teksti | numeric | 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. |
Unohtuneen PIN-koodin palauttaminen
(PasswordRecovery)
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| enabled | Kyllä/Ei | Ei | Onko unohtuneen PIN-koodin palautustoiminto käytössä |
| userId (vain Koha-Suomi) | teksti | Kohan operaattoritunnus (lisätietoa ja tarvittavat käyttöoikeudet: ohje unohtuneen salasanan palautustoiminnon käyttöönottoon) | |
| userPassword (vain Koha-Suomi) | teksti | Kohan operaattoritunnuksen salasana |
Saatavuustiedot
(Holdings)
| Asetus | Tyyppi | Oletus | Kuvaus | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| display_item_hold_counts | Kyllä/Ei | Ei | Näytetäänkö niteiden varausten määrä | ||||||||||
| display_total_hold_count | Kyllä/Ei | Kyllä | Näytetäänkö varausten kokonaismäärä | ||||||||||
| display_total_item_count_in_results | Kyllä/Ei | Kyllä | Näytetäänkö niteiden kokonaismäärä hakutuloksissa | ||||||||||
| display_ccode | Kyllä/Ei | Kyllä | Näytetäänkö hyllysijainnissa Kohan ccode-kentän sisältö | ||||||||||
| display_full_call_number | Kyllä/Ei | Kyllä | Näytetään hyllysijainnissa täydellinen call number eikä ns. näyttöversiota (joka on Kohassa tällä hetkellä (18.10.2019) vähän rikki) | ||||||||||
| display_title_hold_in_results | Kyllä/Ei | Kyllä | Näytetäänkö varauslinkki hakutuloslistassa | ||||||||||
| display_location_per_item | lista | tyhjä | Pilkulla eroteltu lista kentistä, jotka näytetään nidekohtaisena sijaintina silloin, kun niteellä ei ole numerointitietoa. Kentät näytetään asetuksen mukaisessa järjestyksessä. Käytettävissä olevat kentät:
Esim. | ||||||||||
| use_holding_records | Kyllä/Ei | Ei | Käytetäänkö holdings-tietueita Kohassa | ||||||||||
| use_serial_subscriptions | Kyllä/Ei | Ei | Käytetäänkö saapumisvalvonnan tietoja (edellytys KD-4167 Kohassa) | ||||||||||
| 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 | ||||||||||
| links | teksti | 856uyz3 | Linkeissä näytettävät kentät | ||||||||||
| holdings_branch_order | lista | tyhjä | Oletuksena saatavuustiedot näytetään aakkosjärjestyksellä. Tällä asetuksella voi listata branchit, ja tarvittaessa locationit niiden alla, halutussa järjestyksessä, tai määritellä yksittäisille brancheille järjestysnumeron niiden tiputtamiseksi viimeisiksi. Listalla mainitsemattomat branchit saavat järjestysnumero 999. Esimerkkejä:
| ||||||||||
| holdings_location_order | lista | tyhjä | Oletuksena locationit branchien alla järjestetään aakkosjärjestykseen. Tällä asetuksella voi listata locationit halutussa järjestyksessä. Esim. "111:121:221" | ||||||||||
| use_home_branch (Koha-Suomi) useHomeLibrary (Koha-yhteisö) | Kyllä/Ei | Ei | Näytetäänkö aina kotikirjasto holding-kirjaston sijaan. Jos tämä asetus on päällä, eikä nide ole kotikirjastossa, näytetään niteelle "Saatavissa"-tilan sijaan "Ei saatavissa". |
Niteen tilojen mappaukset
(ItemStatusMappings)
ItemStatusMappings-sektiossa voi määritellä mappauksia niteen tiloista Finnan tiloihin. Ne eivät kuitenkaan sovellu kaikkiin tilanteisiin, koska joitakin statuksia mapataan lisätietojen perusteella, esim. Item::CheckedOut mapataan joko Charged tai Overdue riippuen eräpäivästä. Item::NotForLoan, ItemType::NotForLoan ja Item::Lost ovat erikoistapauksia, joihin lisätään status-koodi perään, eli on mapattava esim. Item::NotForLoan4, ja jos mappausta ei löydy, otetaan suoraan tilan selitysteksti.
Tiloja ovat ainakin seuraavat:
Item::CheckedOut
Item::Damaged
Item::Held
Item::Lost
Item::NotForLoan
Item::NotForLoanForcing
Item::Transfer
ItemType::NotForLoan
Niteen tilojen prioriteetit
(StatusRankings)
Finnan tiloihin mapattujen niteen tilojen keskinäistä järjestystä voi muuttaa määrittelemällä niiden prioriteetit (pienempi on tärkeämpi). Esimerkki:
[StatusRankings] Lost = 1 Charged = 2 Overdue = 2 On Hold = 3 In Transit = 4 In Transit On Hold = 4 Tilattu = 5 ; NotForLoan -1 Saapunut = 5 ; NotForLoan -2 Henkilökunnalla = 5 ; NotForLoan 2 Ei saatavana, ei varattavissa = 5 ; NotForLoan 4 Damaged = 6
Verkkomaksaminen
(onlinePayment)
Ks. ohje verkkomaksamisen käyttöönotosta.
| Asetus | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
| enabled | Kyllä/Ei | Ei | Voiko käyttäjä maksaa verkkomaksuja. |
| 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. | |
| selectFines | Kyllä/Ei | Ei | Voiko käyttäjä valita maksettavat maksut |
| nonPayableTypes[] | lista | tyhjä | Maksutyypit (Kohan koodit), joita ei voi maksaa verkossa (esim. LOST) (käytettävissä Finnan versiosta 2.91.0 eli 13.6.2023 alkaen) |
| nonPayableStatuses[] | lista | tyhjä | Maksujen tilat, jolloin maksua ei voi maksaa verkossa (esim. UNRETURNED) (käytettävissä Finnan versiosta 2.91.0 eli 13.6.2023 alkaen) |
| currency | teksti | Valuutta. | |
| userId (vain Koha-Suomi) | teksti | Kohan operaattoritunnus (lisätietoa ja tarvittavat käyttöoikeudet: ohje verkkomaksamisen käyttöönottoon) | |
| userPassword (vain Koha-Suomi) | teksti | Kohan operaattoritunnuksen salasana | |
Seuraavat maksupalvelun asetukset sijoitetaan tiedostoon datasources.ini | |||
| onlinePayment['handler'] | teksti | Maksupalvelu (Paytrail tai CPU). | |
| onlinePayment['url'] | teksti | Osoite. | |
| onlinePayment['merchantId'] | teksti | Kauppiastunnus. | |
| onlinePayment['secret'] | teksti | Salasana. |
