Page History
...
Sijoita lomakkeiden asetukset tiedostoon /local/config/vufind/FeedbackForms.yaml. Voit katsoa mallia Finnan Finnan esimerkkitiedosta.
Lomakkeet sijaitsevat päätason 'forms' -listan sisällä.
...
Note |
---|
Hallintaliittymä tarkistaa tallennettavan tiedoston ja antaa virheilmoituksen, jos tiedosto ei ole YAML-formaatin mukainen. Yleinen virhe liittyy rivin sisennykseen, milloin jolloin virheilmoituksessa mainitaan, millä rivillä virhe esiintyy ("Indentation problem at line.."). |
...
Asetus | Selitys | Mahdolliset arvot | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
enabled | Onko lomake käytössä |
| ||||||||
useCaptcha | Käytetäänkö lomakkeella captcha-tarkistusta. Finnassa captcha-tarkistus on korvattu toisella, käyttäjälle näkymättömällä mekanismilla. Tämä asetus kannattaa jättää pois omista lomakemäärityksistä. |
| ||||||||
title | Lomakkeen otsikko | Käännösavain | ||||||||
onlyForLoggedUsers | Näytetäänkö lomake ainoastaan kirjautuneille käyttäjille |
| ||||||||
emailFrom(käytettävissä v2.71.0 eli 21.9.2021 alkaen) | Lomakkeen lähettäjän nimi ja sähköpostiosoite (vain, kun sendMethod on 'email') Huom! Yleensä email-asetus kannattaa jättää pois, koska viestin lähettäjän osoitteen vaihtaminen voi aiheuttaa sen, etteivät viestit mene perille tai ne päätyvät roskapostiin. |
| ||||||||
emailSubject | Lomakkeen tallennuksen yhteydessä lähetettävän sähköpostiviestin otsikko. api-lähetyksessä tieto siirtyy emailSubject-kentässä. Voit lisätä otsikkoon lomakekentän arvon. Esimerkiksi jos lomakkeella on alasvetovalikko (nimellä "toimipiste"), voit lisätä valikon arvon viestin otsikkoon näin: emailSubject: Hankintaehdotus - %%toimipiste%% Tietuekohtaisilla lomakkeilla (FeedbackRecord, RepositoryLibraryRequest) voi käyttää myös seuraavia paikanpitäjiä:
|
| ||||||||
recipient | Lomakkeen vastaanottajan nimi ja sähköpostiosoite (vain, kun sendMethod on 'email').
| recipient | Lomakkeen vastaanottajan nimi ja sähköpostiosoite (vain, kun sendMethod on 'email').
Mikäli 'recipient' ei ole määritely, käytetään näkymän yleistä palauteosoitetta (Yleiset asetukset > Näkymän ylläpidon sähköpostiosoite). Voit määritellä lomakkeelle useamman vastaaanottajan asettamalla recipientin listaksi:
| ks. esimerkit | ||||||
sendMethod | Lähetetäänkö lomakkeen vastaukset sähköpostilla (email) vai tallennetaanko vastaukset tietokantaan (database)? Oletuksena lomakkeen kautta kerätyt palautteet lähetetään määriteltyyn sähköpostiosoitteeseen (ks. 'recipient'). Mikäli palautteita ei tietoturvasyistä johtuen voida lähettää sähköpostin välityksellä, voidaan palautteet tallentaa tietokantaan tai lähettää organisaation itse ylläpitämään erilliseen järjestelmään JSON-muotoisena pakettina. Tämän rajapintatoiminnallisuuden käyttämisestä on erillinen ohjesivu. Tallennettujen palautteiden käsittely tapahtuu hallintaliittymän Lomakkeet-osiossa. Osiossa listataan tuotantonäkymien kautta lähetetyt palautteet. Tietokantaan tallennusta ei voi kokeilla testipalvelimella. |
| ||||||||
reminderEmail | Jos lomakkeen vastaukset tallennetaan tietokantaan (ks. 'sendMethod'), lähetetään käsittelemättömistä palautteista muistutus tähän sähköpostiosoitteeseen. Jos osoitetta ei ole määritelty, lähetetään muistutukset näkymän yleiseen palauteosoiteeseen (Yleiset asetukset > Näkymän ylläpidon sähköpostiosoite). | Sähköpostiosoite | ||||||||
hideSenderInfo | Kysytäänkö lomakkeella lähettäjän yhteystietoja (nimi ja sähköposti)? Oletuksena kysytään. |
| ||||||||
senderInfoRequired | Edellytetäänkö lomakkeen lähettäjän syöttävän yhteystietonsa? |
| ||||||||
senderInfoHelp | Lähettäjän yhteystietojen ohjeteksti. | Käännösavain | ||||||||
reportReferrer | Sisällytetäänkö palautesivulle viitannut sivu palautteeseen |
| ||||||||
reportUserAgent (käytettävissä v2.71.0 eli 21.9.2021 alkaen) | Sisällytetäänkö käyttäjän selaimen tunniste palautteeseen |
| ||||||||
includeBarcode | Sisällytetäänkö käyttäjän aktiivisen kirjastokortin tunnus palautteeseen. Käytettävissä vain, jos sendMethod on database tai api.Sisällytetäänkö käyttäjän selaimen tunniste palautteeseen |
| ||||||||
response | Lomakkeen lähetyksen jälkeen näytettävä viesti. | Käännösavain | ||||||||
includePatronId | Sisällytetäänkö käyttäjän yksilöivä tunniste kirjastojärjestelmässä palautteeseen. HUOM! Tätä asetusta ei saa käyttää, jos sendMethod on email, ja käyttäjien yksilöivällä tunnisteella on merkitys kirjastojärjestelmän ulkopuolella (esim. Almassa näin voi olla). |
| ||||||||
response | Lomakkeen lähetyksen jälkeen näytettävä viesti. | Käännösavain | ||||||||
help | Lomakkeen ohjetekstit, näytetään lomakkeen alussa ( | help | Lomakkeen ohjetekstit, näytetään lomakkeen alussa ('pre') ja/tai lopussa ('post). Käännös voi sisältää HTML-muotoiluja.
| Käännösavain | ||||||
fields | Lomakkeen kentät | Lista |
...
Asetus | Selitys | Mahdolliset arvot | ||||
---|---|---|---|---|---|---|
name | Kentän nimi . Huom! Seuraavat nimet on varattu mahdollisille tietueen tiedoille, eikä niitä tule käyttää omissa kentissä:
Finnan versiosta 2.74.0 (14.12.2021) lähtien on mahdollista määritellä lähettäjän tietokenttien paikat lomakkeella lisäämällä lomakkeeseen kentät nimellä name (lähettäjän nimi) ja/tai email (lähettäjän sähköpostiosoite). Oletuksena kentät tulevat lomakkeella viimeiseksi. |
| ||||
type | Kentän tyyppi. |
| type | Kentän tyyppi. |
| |
label | Kentän otsikko | Käännösavain | ||||
required | Onko kenttä pakollinen? Oletuksena ei ole. |
| ||||
help | Elementin ohjeteksti | Käännösavain | ||||
settings | Lista HTML-elementin arvoista. Esimerkki: listätään elementille omat CSS-luokat:
| Lista | ||||
options | Elementin valinnat (vain kun type on 'select', 'radio' tai 'checkbox').
tai listana
Ensimmäisessä vaihto options: - valinta-1 - valinta-2 - valinta-3 | Lista käännösavaimia. | ||||
optionGroups | Elementin valinnat eroteltuna omiin ryhmiinsä (vain kun type on 'select'). 'label' määrittää ryhmän otsikon (käännösavain).
| Lista. | ||||
recipient | Elementin arvo määrittää lomakkeen sähköpostin vastaanottajan (vain kun type on 'select'). Asetuksen avulla voi tehdä lomakkeen, jonka vastaanottaja määrittyy käyttäjän valinnan mukaan. Esimerkiksi hankintaehdotus voidaan ohjata suoraan käyttäjän valitsemaan kirjastoon. Vastaanottajien sähköpostiosoitteet määritellään 'options' tai 'optionGroups' -listaan käyttämällä jokaisessa valinnassa 'value' ja 'label' kenttiä. Näistä 'label' on käännösavain joka näytetään lomakkeella. 'value' kentän määrittämää vastaanottajan sähköpostiosoitetta ei näytetä käyttäjille. Esimerkki:
tai käyttäen 'optionGroups'-asetusta:
|
| ||||
placeholder | Select-valikon ensimmäinen elementti (vain kun type on 'select'). Jos 'placeholder' on määritelty ja elementti on pakollinen ('required = true'), lomakkeen voi lähettää vain jos on valinnut valikosta jonkin muun kuin oletuksena näytettävän ensimmäisen elementin. Esimerkki: select-valikko, jonka ensimmäinen elementti on "Valitse toimipiste" ja tämän jälkeen valittavissa olevat toimipisteet:
| Käännösavain | ||||
format | Päivämäärän muoto (vain, kun type on 'date') Palauteviestissä lähetettävän päivämäärän muoto. Ei vaikuta näytöllä näkyvään muotoon, joka määrittyy selaimen ja käyttäjän käyttöjärjestelmän asetusten perusteella. Päivämäärän muotoilussa käytetään PHP:n formaattia, esim. 'Y-m-d'. | |||||
minValue | Pienin sallittu päivämäärä (vain, kun type on 'date') Arvona voi käyttää englanninkielisiä päivämäärälauseita, joita PHP:n strtotime tulkitsee, esim. 'now'. | |||||
maxValue | Suurin sallittu päivämäärä (vain, kun type on 'date') Arvona voi käyttää englanninkielisiä päivämäärälauseita, joita PHP:n strtotime tulkitsee, esim. '+1 year' tai '+6 months'. |
...
Code Block |
---|
forms: AcquisitionRequest: title: Acquisition request enabled: true useCaptcha: false recipient: name: Your Library email: [email protected] onlyForLoggedUsers: false emailSubject: Hankintaehdotus (%%library%%) response: Thank you for your feedback. senderInfoRequired: false #senderInfoHelp: feedback_info #help: # pre: feedback_help_pre # post: feedback_help_post fields: - name: library type: select options: - 1/Vaski/1/ - 1/Vaski/5/ - 1/Vaski/6/ label: feedback_choose_library - name: author type: text label: Author required: true - name: title type: text label: Title required: true - name: format type: select options: - 0/Book/ - 0/Journal/ - 1/Sound/CD/ - 1/Video/DVD/ - 1/Other/Other/ label: Format - name: info type: textarea label: Additional Information required: false |
...
Esimerkki: Lisätään Varastokirjastotilaus-lomake
Tämä toiminnallisuus on käytettävissä v2.71.0 eli 21.9.2021 lähtien.
Warning |
---|
Huom! Lomakkeen nimen täytyy olla RepositoryLibraryRequest. |
Tilausnappula näytetään automaattisesti "Tämän aineiston tarjoaa" -palkissa:
Warning |
---|
Varastokirjatotilaus-lomakkeessa pitää käyttäjälle selkeästi kertoa henkilötietojen käsittelystä. Käytettäessä parametria includePatronID : true tulee lomakkeen loppuun automaattisesti seuraava huomatus: Käyttäjän yksilöivä tunniste lähetetään lomakkeen mukana. Muut tiedot henkiötietojen käsittelystä voi lisätä lomakkeelle kohtaan pre: feedback_help_pre (lomakkeen alkuun) tai post: feedback_help_post (lomakkeen loppuun). Mainitse ainakin, lähetetäänkö tiedot sähköpostitse vai käsitelläänkö niitä muulla tavoin. Voit myös linkittää organisaation tai yhteenliittymän tietosuojaselosteeseen. |
Tilausnappula
Tilausnappula näytetään automaattisesti "Tämän aineiston tarjoaa" -palkissa:
Finnan versiosta 2.74.0 (14.12.2021) lähtien on mahdollista määritellä, missä tilausnappula näytetään. Tähän on käytettävissä seuraavat näkymän /local/config/vufind/config.ini-tiedoston asetukset, joilla nappulan voi lisätä myös hakutuloksiin ja saatavuustietoihin tai poistaa "Tämän aineiston tarjoaa" -palkista:
Code Block |
---|
[Record]
; Whether to display repository library request in search results:
;repository_library_request_in_results = true
; Whether to display repository library request in holdings:
;repository_library_request_in_holdings = true
; Whether to display repository library request in organisation info box:
repository_library_request_in_organisation_info = true |
Saatavuustiedoissa:
Hakutuloksissa:
Esimerkki lomakkeen asetuksista
Code Block |
---|
forms:
RepositoryLibraryRequest:
enabled: true
title: repository_library_request
sendMethod: database
includeBarcode: true
includePatronId: true
onlyForLoggedUsers: true
recipient:
name: Tilaukset
email: tilaukset@joku
reminderEmail: [email protected]
emailSubject: "Varastokirjastotilaus (%%noutopaikka%%): %%record_id%% - %%record%%"
response: repository_library_request_response
senderInfoRequired: true
hideSenderInfo: true
hideRecipientInfo: true
help:
pre: repository_library_request_info_html
fields:
- name: noutopaikka
type: select
options:
- 1/Vaski/1/
- 1/Vaski/5/
- 1/Vaski/6/
label: preferred_pickup_location
- name: lastdate
type: date
label: hold_required_by
minValue: now
required: false
- name: name
type: text
label: feedback_name
required: true
- name: email
type: email
label: feedback_email
required: true
- name: message
type: textarea
label: feedback_message
settings:
- [placeholder, repository_library_request_message]
- [rows, 3]
|
Esimerkki: Lisätään Arkistoaineiston tilauslomake
Tilauslomakkeen lisäämiseksi omaan näkymään, muokataan alla mainittuja tiedostoja tiedostosijainnissa: /local/config/vufind/
Varausnappula
Varausnappula näytetään automaattisesti Saatavuustiedot-välilehdellä, jos se on asetuksista määritelty päälle ja/jos varattavien aineistojen tiedot sopivat asetuksista määriteltäviin lisäehtoihin.
Saatavuustiedot-välilehden voi laittaa näkyväksi RecordTabs.ini-tiedoston kautta, jossa se lisätään EAD3-aineiston määrittelyihin. (Eli kuten alla, kohdan "[Finna\RecordDriver\SolrEad3]" alle).
Code Block |
---|
[Finna\RecordDriver\SolrEad3]
tabs[Holdings] = HoldingsILS |
Aineistoihin liittyviä asetuksia voi muokata datasources.ini-tiedostosta. Asetukset lisätään tietolähteen alle. (Eli tiedostossa pitäisi lukea [] sisällä tietolähteen nimi, josta tuleville tietueille halutaan arkistotilauslomake lisätä. Tämän tietolähteen alle alla näkyvät asetukset laitetaan.)
Code Block |
---|
; Archive request form settings
allowArchiveRequest = true
archiveRequestAllowedRecordLevels = 'file:item'
archiveRequestRequireFilingUnit = true |
- allowArchiveRequest - Määrittelee yleisesti, onko lomake näkyvissä.
- archiveRequestAllowedRecordLevels - Määrittelee arkistotasot, joilla varausnappula näkyy. (Esimerkissä yllä vain file ja item tason aineistoilla näkyy varauspainike.) Jos arkistotasoja on useita, ne erotetaan ":":llä.
- archiveRequestRequireFilingUnit - Määrittelee vaaditaanko varattavilta aineistoilta säilytyspaikan tieto (jolla tarkoitetaan tietueen container arvoa). Eli jos tietueelta ei kyseistä arvoa löydy ja asetus on "true" → lomake ei näy kyseisellä tietueella.
Jos omassa näkymässä ei ole kyseistä tiedostoa, se pitää tehdä tiedoston lisäyksestä ja nimetä "datasources.ini":ksi. Sen jälkeen asetukset voi lisätä kuten yllä.
Lisätiedot lomakkeelle
Lomakkeelle on mahdollista lisätä ylä- sekä alaosaan lisäinfoa seuraavien käännösavainten avulla:
archive_request_{datasource}_info
archive_request_{datasource}_material_arrival_info_html
Jos käännöksiä ei aseteta, lomake näkyisi ilman tämän osion ylimpänä olevan lomakekuvan havainnollistavia käännösavaimia. Alempi teksti tulee aina näkyville siniseen info-laatikkoon.
Esimerkki lomakkeen asetuksista
Code Block |
---|
forms:
ArchiveRequest:
allowLocalOverride |
Code Block |
forms: RepositoryLibraryRequest: enabled: true title: repository_library_request useCaptcha: false sendMethod: database includeBarcode: true includePatronId: true onlyForLoggedUsers: true recipient: title: archive_request_reserve_material nameenabled: Tilauksettrue emailsendMethod: tilaukset@joku"email" reminderEmail onlyForLoggedUsers: [email protected]true emailSubject: "Varastokirjastotilaus (%%noutopaikka%%): %%record_id%% -Varauspyyntö: %%record%%" response: repository_libraryarchive_request_response senderInfoRequired: true hideSenderInfo: true hideRecipientInfo: truefalse help: pre: repository_library_request_infoarchive_request_pre_information_html post: archive_request_post_information_html fields: - name: name type: noutopaikkatext label: feedback_name type: select optionssettings: - 1/Vaski/1/readonly: true - - 1/Vaski/5/name: email - 1/Vaski/6/ type: email label: preferredfeedback_pickup_location email - name: lastdate typerequired: datetrue - labelname: hold_required_byphone minValue type: nowtext requiredlabel: falsePhone - name: namedesiredDateForOrder type: texttextarea label: feedback_name archive_request_request_info required: true - name: email type: email settings: label: feedback_email - [rows, 3] required: true - name: message type: textarea label: feedback_message settings: - [placeholder, repository_library_request_message] - [rows, 3] |
Lomakkeiden asetuksista enemmän tämän sivun alussa. (Sijoita lomakkeiden asetukset tiedostoon /local/config/vufind/FeedbackForms.yaml.)