|
AndoLib Web-OPAC - technische Dokumentation - Abschnitt §3
Anpassung
3.1. Html-Templates
Das Layout wird über ein frei gestaltbares Html-Template festgelegt. Die zu präsentierenden Daten werden über Platzhalter eingebunden.
Für das Parsen der Templates wird Anandos Template Parser in der Version 4 benutzt.
3.2. eingebettete Funktionen und Variablen
3.2.1. Template-Funktionen und -Funktionsparameter
Liste der im HTTP-Request per Parameter ansprechbaren Funktionen
Name (sFkt=...) |
Parameter (sVal=...) |
Ergebnis |
Ziel |
Beschreibung |
ab Ver |
CrossSrch |
Liste von Suchbegriffen |
Ergebnisliste |
Grid3/E |
Kreuzregister-Suche |
2.0 |
Srch |
bis zu vier Suchbegriffeincl.Registerangabe |
Ergebnisliste |
Grid3/E |
verknüpfte Suche über Registereinträge |
2.0 |
Index |
Suchfeld-Index |
Indexliste |
Grid3/E |
|
2.0 |
display |
- |
Seite neu anzeigen |
- |
Die Seite wird ohne Datenänderungen neu angezeigt. Vorzugsweise dient sie zum Erhalt der Session, indem sie im refresh-Metatag verwendet wird.
|
2.19 |
Seite mit neuem Template anzeigen |
- |
Wird gleichzeitig der Parameter sATP_TplDir übergeben, wird zur Neuanzeige das durch dessen Wert definierte Template-Verzeichnis verwendet. |
4.05 |
fnResStart |
- |
|
|
Zum Anfang der Ergebnisliste springen |
2.0 |
fnResNext |
- |
|
|
zum nächsten Abschnittder Ergebnisliste |
2.0 |
fnResPrev |
- |
|
|
zum vorherigen Abschnittder Ergebnisliste |
2.0 |
fnResEnd |
- |
|
|
zum Ende der Ergebnisliste |
2.0 |
fnDetStart |
- |
|
|
Zur Detailanzeige des ersten Ergebnisses in der Liste |
2.0 |
fnDetNext |
- |
|
|
Zur Detailanzeige des nächsten Ergebnisses in der Liste |
2.0 |
fnDetPrev |
- |
|
|
Zur Detailanzeige des vorherigen Ergebnisses in der Liste |
2.0 |
fnDetEnd |
- |
|
|
Zur Detailanzeige des letzten Ergebnisses in der Liste |
2.0 |
fnMerken |
Satznummer Titel |
|
|
Eintrag aus der Ergebnisliste in Merklisteübernehmen |
2.0 |
fnRes2Details |
Satznummer, Titel |
|
Grid4 |
Vollanzeige des gewählten Satzes |
2.0 |
fnBtnRegNext |
- |
|
Grid3/R |
nächster Registerabschnitt |
2.0 |
fnBtnRegPrev |
- |
|
Grid3/R |
vorheriger Registerabschnitt |
2.0 |
fnRegShow |
Satznummernliste, Eintrag |
|
Grid3/E |
Alle über Registerzeile referenzierten Sätze in die Ergebnisliste übernehmen |
2.0 |
fnTransfer |
Registerzeile |
|
Grid2 |
Registereintrag in Suchfeld der Suche+ übernehmen |
2.0 |
fnRegRef |
Register-Verweisziel |
|
|
|
2.0 |
fnSort |
oRS=(resultset)
sSort=(sortierparameter)
sSortDir=(sortierrichtung) |
Resultset neu sortiert |
Grid3
Grid5 |
- oRS: oResList oder oRsMarkList
- sSort: Name einer gültigen Sortierparameterdatei (z.B. al4s-yop)
- sSortDir: up oder down,; default: Standard-Sortierrichtung der ausgewählten Sortierparameter laut al-opac.ini.php oder die zuletzt gewählte Sortierrichtung
Ergebnis:
- ATP-Variable sSortName passend zu sSort gesetzt
- Ergebnis neu sortiert
- $nLastResult=1 bei Erfolg, sonst =0
|
4.06 |
fnKarte |
Titel-ID |
Satzanzeige |
Grid4 |
Der Titel mit der übergebenen ID wird ermittelt und in der Detailanzeige angezeigt. Wurde nichts gefunden, wird Grid1 mit einer Fehlermeldung eingeblendet |
2.17 |
fnItem |
Exemplar-Barcode |
Satzanzeige |
Grid4 |
Der Titel zum Exemplar mit dem übergebenen Barcode wird ermittelt und in der Detailanzeige angezeigt. Wurde nichts gefunden, wird Grid1 mit einer Fehlermeldung eingeblendet |
3.04 |
fnRecord |
Record-Nummer |
interne Satzanzeige |
Grid4 |
Der Titel mit der übergebenen Record-Nummer wird ermittelt und in der Detailanzeige im internen Format angezeigt. Wurde nichts gefunden, wird Grid1 mit einer Fehlermeldung eingeblendet
Wenn sDisplayParameterIntern in der al-opac.ini.php nicht definiert ist, wird die normale Detailanzeige verwendet |
2.19 |
fnMarkStart |
- |
|
Grid5 |
Zum Beginn der Merkliste |
2.0 |
fnMarkNext |
- |
Merkliste |
Grid5 |
nächste Seite der Merkliste anzeigen |
2.0 |
fnMarkPrev |
- |
|
Grid5 |
vorherige Seite der merkliste anzeigen |
2.0 |
fnMarkEnd |
- |
|
Grid5 |
Zum Ende der Merkliste |
2.0 |
fnMark2Details |
Satznummer Titel |
|
Grid3 |
akt. Nr der Merkliste hinzugefügt |
2.0 |
fnMarkDelete |
Satznummer Titel |
|
Grid3 |
akt. Nr. aus Merlliste entfernt |
2.0 |
fnLogin |
Nutzer-ID, Passwort |
Konto-Liste |
Grid6
Grid7 |
aktuelle Kontoliste wird erzeugt, Grid6 angezeigt, aber nicht aktiviert
SONDERFALL: wenn Admin eingeloggt, wird Grid7 aktiviert mit Statistik- und Konfigurationsfunktionen |
2.04 |
fnLogout |
- |
- |
|
Benutzer wird abgemeldet |
2.04 |
fnAuth |
Nutzer-ID, Passwort |
(typisch XML-Response-File) |
- |
Diese Funktion bietet eine Möglichkeit für externe Dienste wie z.B. DiViBib, einen Lesercode mit zugehörigem Passwort prüfen zu lassen.
Im Referenzdesign wird die Template-Datei auth-dvb.xml für die DiViBib verwendet.
Beispiel:
(zur besseren Lesbarkeit auf mehrere Zeilen verteilt)
http://webopac.net/test/index.php?
tpl=auth-dvb.xml
&sFkt=fnAuth
&sPatron=123456
&sPassword=gast
|
3.00.11 |
fnRenew |
|
|
|
von Medieneintrag aus Konto oder aus Ergebnisliste oder aus Detailanzeige; wenn ausgewähltes Medium verlängerbar ist (nicht vorgemerkt), wird es verlängert |
2.04 |
fnRenewAll |
|
|
Grid6 |
Fenster mit Ergebnis-Mitteilung, Schaltfläche von Grid6 aus; alle verlängerbaren Medien werden verlängert |
2.04 |
fnReserve |
Satznummer Titel |
|
(uv) |
von Medieneintrag aus Konto oder aus Ergebnisliste oder aus Detailanzeige, wenn für Titel entleihbares, nichtentliehenes Medium vorhanden |
|
fnPrebook |
Satznummer Titel |
|
(uv) |
von Medieneintrag aus Konto oder aus Ergebnisliste oder aus Detailanzeige; wenn alle entleihbaren Medien entliehen oder kein Medium zum Titel vorhanden ist |
|
fnReserveCancel |
Satznummer Exemplar |
|
(uv) |
|
|
fnPrebookCancel |
Satznummer Vormerkung |
|
(uv) |
|
|
Liste der speziellen OPAC-ATP-Funktionen (im Template verwendbar)
Name |
Funktion/Parameter |
Beschreibung |
Version |
sRegister |
Nummer des Registers in Liste (Startwert) |
vervielfältigt <option>-Tag sooft, wie Werte im Array der verfügbaren Register (analog der ARR2-ATP-Funktion); Quelle der Werte ist der gleichnamige Eintrag in al-opac.ini.php |
bis 4.02 |
selRegister |
ab 4.03 |
selTyp |
Selectfeld mit Medientypauswahl generieren |
vervielfältigt <option>-Tag sooft, wie Werte im Array der aMedientypen vorhanden sind (analog der ARR2-ATP-Funktion); Quelle: sMedientypen in al-opac.ini.php oder per Funktion über den Ini-Parameter sTypSys aus Datenbank ermittelt |
ab 3.0 |
LogicOperators |
Nummer des Eintrags in Liste (Startwert) |
vervielfältigt <option>-Tag sooft, wie Werte im Array der logischen Operatoren vorhann sind (analog der ARR2-ATP-Funktion); Quelle der Werte ist sLogicOperators in al-opac.ini.php |
ab 2.0 |
RestrOperator |
Nummer des Eintrags in Liste (Startwert) |
vervielfältigt <option>-Tag sooft, wie Werte im Array der Restriktionsoperatoren vorhann sind (analog der ARR2-ATP-Funktion); Quelle der Werte ist sRestrOperators in al-opac.ini.php |
ab 2.0 |
Sortierung |
Select-Feld mit Sortiermöglichkeiten generieren |
vervielfältigt <option>-Tag sooft, wie Werte im Array der Sortierparameter vorhanden sind (analog der ARR2-ATP-Funktion); Quelle: sSortPar in al-opac.ini.php |
ab 2.0 |
RegisterClass |
für ATP SETCLASS |
Setzt den Klassennamen des eingeschlossenen Tags neu. mit Inhalt der Variable; Klasse sollte in css-Datei definiert sein; |
ab 2.0 |
SelBranch |
Select-Feld mit Zeigstellenauswahl generieren |
vervielfältigt <option>-Tag sooft, wie Werte im Array der Zweigstellen vorhanden sind (analog der ARR2-ATP-Funktion); Quelle: sBranches in al-opac.ini.php |
ab 3.0 |
3.2.2. Template-Formularvariablen und -funktionen, Input-Felder und Bedienelemente
Name |
Typ |
Beschreibung |
Version |
allgemeine Elemente
|
|
StateList |
ATP String |
vom Template gesetzt; enthält drei, durch Komma getrennte Bezeichner, über die der Client die passende Anzeigevariante wählen kann:
- für erfolgreichen Abschluus der Operation
- für nicht erfolgreichen Abschluss (z.B. Suchergebnis leer oder Anmeldung fehlgeschlagen)
- für Programmfehler (z.B. keine DB-Verbindung, irregulärer Zustand o.ä. )
|
|
State |
ATP String |
Wird vom Serverprozess im Ergebnis der letzten Operation als Auswahl aus der StateList gesetzt |
|
ActiveTab |
ATP String |
ID des aktiven Tabs |
|
AcriveSrch |
ATP String |
ID der aktiven Suchmaske (ab V2.20) |
|
sAppDir |
ATP String |
relativer Pfad zum Anwendungsverzeichnis (hier: AL-OPAC) |
|
sTplDir |
ATP String |
relativer Template-Pfad; um zwischen mehreren Templates umschalten zu können, muss der Inhalt dieser Variablen bei jedem Aufruf des Parsers mitgegeben werden.
Am einfachsten ist das über ein hidden-Feld innerhalb eines FORM-Tags zu bewerkstelligen.
Beispiel:
<input id="sTDir" type="hidden" name="sTDir" value="webtpl">
|
|
log |
ATP String |
Für Fehler-Ausgaben; auch für Debug-Trace-Werte, wenn nDebugLevel>0 in al-opac.ini.php |
|
sLanguage |
ATP String |
Sprachkürzel der aktiven Sprache |
|
aLanguages |
ATP ARR |
Array der Sprachkürzel |
|
OpacDescr |
ATP FKT |
liefert Beschreibungstext zum Katalog, der in der Datenbank in CFGopac-Satz, #9A$C, hinterlegt ist oder den unveränderten eingeschlossenen Text
Der Konfigurationssatz dazu wird über Register 11 SYScOPACxx (xx=Sprachcode) gesucht
Der Inhalt des Teilfeldes C muss UTF8-codiert vorliegen; Wenn im Text Umlaute enthalten sind, ist dessen Änderung nur über avdiag oder das Konfigurationsformular des OPACs möglich. |
|
IS_LOCAL |
ATP String |
gesetzt, wenn Client-IP im Bereich des lokalen Netzwerkes; s.a. #ulc und sLocalNetworks |
|
nLastResult |
ATP String |
enthält Status der zuletzt aufgerufenen Funktion (s. HTTP-Request-Parameter)
mögliche Werte:
-1 = ein Fehler ist aufgetreten (technischer Natur)
0 = die Funktion lieferte kein Ergebnis (z.B. leeres Suchergebnis ist kein Fehler)
1 = die Funktion lieferte ein Ergebnis
Variable nicht vorhanden = Funktion liefert keine Statusinformation
|
|
Einfache Suche (Tab1)
|
|
Srch1Instruction |
ATP String |
Hinweistext zur Suche |
|
fldSrch1 |
ATP String |
Eingabewert |
|
aMedientypen |
ATP ARR2 |
Array mit Werten für Medientypen-(<select>-Tag, definiert in al-opac.ini.php |
|
nNelTage |
ATP String |
Länge des Zeitraums in Tagen für das Erfassungsdatum von Titeln, auf die die Suche eingeschränkt wird |
|
Erweiterte Suche / Suche+ (Tab2)
|
|
SrchInstruction |
ATP String |
Hinweistext |
|
sSuchStr0 ... sSuchStrn |
ATP String |
Eingabewerte für die ausgewählten Suchfelder |
|
sRestrictValue |
ATP String |
Eingabewert für Restriktion; s.a. sRestrictions in al-opac.ini.php |
|
Grid2Focus |
ATP String |
ID des aktiven Suchfeldes (sSuchStr0 ... sSuchStrn) |
|
Index oder Ergebnisliste (Tab3)
|
|
ResultValid |
ATP Boolean |
=1, wenn Ergebnisliste für Anzeige verfügbar (nur für JavaScript-Funktion) |
|
RES_OK |
ATP Boolean |
=1, wenn Ergebnis (Liste oder Register) verfügbar (nur für Bedienelemente-Steuerung) |
|
ResListClass |
ATP String |
Klassenname für Registeranzeige; divResList und divResListHidden sollte in css-Datei definiert sein; |
|
RESLIST |
ATP ARR2 |
Ergebnisliste (Inhalte über ald-list.?pt) |
|
sResNotify |
ATP String |
Ergebnislisten-Überschrift (s.a. nächste vier Variablen) |
|
nVon |
ATP String |
Ergebnisliste: Nummer des ersten sichtbaren Eintrags |
|
nBis |
ATP String |
Ergebnisliste: Nummer des letzten sichtbaren Eintrags |
|
nRSet |
ATP String |
Ergebnisliste: Anzahl aller Einträge |
|
sRSCaption |
ATP String |
Ergebnisliste: Art der Liste |
|
RegisterClass |
ATP String |
Klassenname für Registeranzeige; divRegister und divRegisterHidden sollte in css-Datei definiert sein; |
|
REGLIST |
ATP ARR2 |
Registerliste |
|
sRegNotify |
ATP String |
Register-Überschrift |
|
visResStart |
ATP String |
zur Steuerung der Listen-Navigationselemente für Ergebnisliste
Beispiel:
<atp FKT="HIDDEN" PAR="visResStart">
<input id="idBtnResStart" class="BtnNav" type="button"
title="zum Anfang der Liste"
onmouseover="Hover(this);" onmouseout="Leave(this);"
value="|<-" onclick="DoS('fnResStart',' ')">
</atp>
|
|
visResPrev |
ATP String |
zur Steuerung der Listen-Navigationselemente für Ergebnis- und Registerliste |
|
visResNext |
ATP String |
zur Steuerung der Listen-Navigationselemente für Ergebnis- und Registerliste |
|
visResEnd |
ATP String |
zur Steuerung der Listen-Navigationselemente für Ergebnisliste |
|
Detailanzeige (Tab4)
|
|
sDetNotify |
ATP String |
Überschrift für Detailanzeige |
|
nDetNr |
ATP String |
Index im Record-Set (mit 1 beginnend!) |
|
fInML |
ATP Bool |
0 oder 1, wenn akt. Record in Merlkliste ist |
|
DetailSet |
ATP Boolean |
gesetzt, wenn Detail vorhanden |
|
sDetails |
ATP ARR3 |
Enthält mehrdimensionales Array der Satzdetails (Inhalte über ald-full.?pt) |
|
visDetStart |
ATP String |
zur Steuerung der Listen-Navigationselemente für Detailanzeige;
Beispiel:
<atp FKT="HIDDEN" PAR="visDetStart">
<input id="idBtnDetStart" class="BtnNav" title="zum ersten Datensatz" type="button"
onmouseover="Hover(this);" onmouseout="Leave(this);"
value="|<-" onclick="DoS('fnDetStart',' ')"
style="VISIBILITY: hidden;">
</atp>
|
|
visDetPrev |
ATP String |
zur Steuerung der Listen-Navigationselemente für Detailanzeige |
|
visDetNext |
ATP String |
zur Steuerung der Listen-Navigationselemente für Detailanzeige |
|
visDetEnd |
ATP String |
zur Steuerung der Listen-Navigationselemente für Detailanzeige |
|
Merkliste (Tab5)
|
|
MarkValid |
ATP Boolean |
=1, wenn Merkliste für Anzeige verfügbar, wenn nicht vorhanden und oRsMarkList besetzt, API-Funktion 'fnMarkRefresh' zur Aufbereitung der Merklisten-Anzeige aufrufen |
|
sMarkNotify |
ATP String |
Überschrift für Merklist (depricated ab V4.09) |
|
oRsMarkList |
ATP ARR2 |
Merkliste-Resultset (nicht zur Ausgabe geeignet, nur zur Verwendung mit SHOW oder HIDDEN |
|
MARKLIST |
ATP ARR2 |
Array der Datensätze der Merkliste im Anzeigeformat |
|
visMarkStart |
ATP String |
zur Steuerung der Listen-Navigationselemente für Merkliste |
|
visMarkPrev |
ATP String |
zur Steuerung der Listen-Navigationselemente für Merkliste |
|
visMarkNext |
ATP String |
visMarkEnd |
ATP String |
lstMarkLen |
ATP String |
zur Anzeige der Listenposition, ersetzt sMarkNotify |
ab 4.09 |
lstMarkVon |
ATP String |
lstMarkBis |
ATP String |
Leserkonto (Tab6)
|
|
sPatronInfo |
ATP String |
Mitteilungen an angemeldeten Leser, die während der Zeit des eingeloggten Zustandes erhalten bleibt |
|
sPDInfoText |
ATP String |
einmalige Mitteilung an Leser (z.B. als Reaktion/Quittung auf eine ausgelöste Aktion) |
|
bEnableUser |
ATP Boolean |
nicht vorhanden oder mit beliebigem Wert belegt: |
|
bDisableInfomails |
ATP Boolean |
wenn vorhanden, InfoMail-Txtfeld und Absenden-Schaltfläche ausblenden |
|
fExtAuth |
ATP Boolean |
wenn gesetzt, erfolgt externe Authentifizierung, z.B. über LDAP)
s.a. auth.php |
|
fPatronValid |
ATP Boolean |
=1, wenn Leser angemeldet/verifiziert (Tab6 wird angezeigt) |
|
fPatronEnabled |
ATP Boolean |
=1, wenn Leserkonto aktiv, also nicht gesperrt ist |
|
fContoDetView |
ATP String |
nicht gesetzt, wenn alle Einträge selektiert sind, ansonsten gleich Kürzel für Sicht:
M = nur Medien, B = nur Reservierungen, PB = nur Vormerkungen, F = nur Gebühren |
|
sPatron |
ATP String |
Leserkennung |
|
sPatronName |
ATP String |
Lesername |
|
PCONTO_OK |
ATP Boolean |
gesetzt, wenn Kontoeinträge vorhanden |
|
nPatronMedia |
ATP Integer |
Anzahl der entliehenen Medien oder nicht gesetzt |
|
fLendStopp |
ATP Boolean |
gesetzt, wenn Gebührensumme >= Limit (s.a. sSrcChargeLimit) |
|
sContoNotify |
ATP String |
Hinweis zur Kontoanzeige |
|
visContoStart |
ATP Boolean |
gesetzt, wenn Kontoanzeige nicht am Anfang |
|
visContoPrev |
ATP Bollean |
visContoNext |
ATP Boolean |
gesetzt, wenn Konto nicht am Ende |
|
visContoEnd |
ATP Boolean |
CONTOLIST |
ATP ARR2 |
enthält Einträge des Leserkontos:
NR |
Position in Liste |
MTYP |
Art des Eintrags |
ID |
Identifikator (Barcode o.ä.) |
WERT |
z.B. Höhe der Gebühr |
ZWST |
bei aktiver Zweigstellenverwaltung Bezeichnung der Zweigstelle |
PERSON |
bei Büchern Verfasser o.ä. |
TITEL |
Bezeichnung eines Buchtitels oder einer Gebühr |
EDAT |
Termin oder Fälligkeitsdatum |
|
|
3.2.3. feste class-Namen zur Verwendung in den Templates
Klassenname |
zur Verwendung in |
verwendet von |
Beschreibung |
spnWarn |
span, div |
srch.php (Suche+)
ATP-String SrchInstruction |
Fehlermeldungstext |
3.2.4. Das Standard-Template
In den Allegro-Exportparamertern verwendete Klassennamen:
Klassenname |
verwendet mit Tag |
verwendet von |
Beschreibung |
txtISBDLabel |
span |
ald--full.?pr |
ZT 37, für Überschrift der Karte geplant |
ISBDLink |
a |
ald--full.?pr |
URL in dem Metainformationen |
IK |
span |
ald--full.?pr |
Hervorhebung Interessenkreis |
spnTextlink |
span |
ald--full.?pr |
als javascript-Link aus der Kartenanzeige zum Sprung in verschiedene Register |
classification |
p |
ald--full.?pr |
Anzeige der Klassifikation |
TblDetails |
table |
ald--full.?pr |
Tabelle um Detailanzeige |
signatur |
p |
ald--full.?pr |
Anzeige der Signatur |
tblCoverV |
tbl |
ald-full.?pr |
Buchcoveranzeige im Detailbereich: Tabelle zur Positionierung |
tdCoverV |
td |
ald-full.?pr |
Buchcoveranzeige im Detailbereich: Element, das das Image enthält |
imgCoverV |
img |
ald-full.?pr |
Buchcoveranzeige im Detailbereich: Image-Attribute |
3.2.5. Mechanismen zu Template-Umschalting
Zusätzlich zu der in der Parser-Konfiguration festgelegten Einstellung für das Template-Verzeichnis als auch die Template-Datei können diese zur Laufzeit neu gesetzt werden:
- Umschaltung über API-Funktion 'display'
Mittels sFkt=display&sATP_TplDir=(neues Verzeichnis) kann bis zum Session-Ende ein neues default-Templateverzeichnis gesetzt werden.
- Über die Variable 'sStartPla' können in Abhängigkeit von der Plattform zu Beginn der Session sowohl Template-Verzeichnis als auch Template-Datei initial gesetzt werden.
3.3. Konfigurationsdateien
3.3.1. ATP-Konfiguration
Die Templates und Funktionen des AndoLib-WebOPAC werden über den Template-Parser ATP V3 ausgeführt. Dessen Konfiguration steht in einer Datei namens atp.conf.php und enthält im wesentlichen den Pfad zum Template- und Funktions-Unterverzeichnis.
Näheres kann in der Dokumentation des Template-Parsers nachgelesen werden.
3.3.2. AL-OPAC-Konfiguration
Die Konfigurationsdatei al-opac.ini.php enthält die Einstellungen zum WebOPAC und den Datenbanken.
Das Format entspricht dem einer Ini-Datei mit Abschnitten.
Mit ; eingeleitete Zeilen können Kommentare enthalten
Das allgemeine Format ist Variablenname=Inhalt. Enthält der Inhalt Leerzeichen, ist er in zu setzen.
Werte aus dem Bereich [Global] werden durch gleichlautende aus den Datenbank-Abschnitten (hier im Beispiel [katalog1]) überschrieben
al-opac.ini.php |
Ver |
Bereich |
Variable |
Beschreibung |
|
[Global] |
beliebig |
Selbstgewählte Variablen (auch im datenbankspezifischen Teil verwendbar)
können in den Templates in Marker-Tags und Pattern genutzt werden
; Beispiel im Template:
; ...
; oder
; |
|
Databases |
Liste der symbolischen Namen verfügbarer Datenbanken
Beispiel: Databases=katalog1,katalog2,katalog3 |
|
Database |
symbolischer Name der standardmäßig aktiven Datenbank wie in avanti.conf
eingetragen; muss in Databases enthalten sein
Bailspiel: Database=katalog1 |
|
sAvIp |
IP-Adresse des Avanti-Servers |
|
sAvPort |
Port, unter denm Avanti lauscht |
|
sAdminName |
default: Administrator; für Diagnose-Funktionen zum OPAC |
|
sAdminPassPhrase |
SHA256-Wert der Admin-Passwortes |
|
nSortMax |
max. Größe der Ergebnismenge, die noch sortiert wird. Standard: 1000
Ist der Server schnell und die Datenbankanbindung gut,; sind auch wesentlich größere Werte möglich |
|
nListLen |
max. Größe der Ergebnismengen-Teilliste (mit dem Layout abzustimmen) |
|
sErrorMail |
E-Mail-Adresse für Fehlermeldujgen |
|
sLogFile |
Logdatei mit vollen Pfad |
|
nDebugLevel |
= 0 - nur Fehlermeldungen
= 1 - zusätzlich Warnungen (Hinweise auf Fehlbedienungen)
= 2 - zusätzlich UP-Trace
= 3 - zusätzlich alle Jobs und interne Zwischenergebnisse |
|
sLocalNetworks |
IP4-Netzwerkmaskenliste für interne Netze
; Format: nnn.nnn.nnn.nnn/rr[,nnn.nnn.nnn.nnn/rr[,...]]
; Beispiel: 192.168.1.0/24 oder 192.168.0.* für Class-C-Netz |
|
sAcUserVars |
User-Variablen für formatierten Allegro-Export: (werden an Exportparameter übergeben)
Beispiel: sAcUserVars=#uOR=Bibliotheksort ; damit wird die User-Variable #uOR mit dem Wert Bibliotheksort besetzt
Mehrere Variablen können durch | getrennt angegeben werden |
|
Srch1Instruction |
Hinweistexte für das Standard-Template |
|
Srch1NothingFound |
[katalog1] |
katalog steht hier für den symbolischen Datenbanknamen |
|
sDbToken |
sollte dem symbolischen Datenbanknamen entsprechen |
|
sAvUserRo |
username für R/O-Zugriff auf die Datenbank |
|
sAvPassRo |
Passwort für R/O-Zugriff auf die Datenbank |
|
sAvUserWr |
username für R/W-Zugriff auf die Datenbank |
|
sAvPassWr |
Passwort für R/W-Zugriff auf die Datenbank |
|
sRegCross |
Liste für die einfache Suche (== Standardsuche) verwendeten Register (Trennung durch Komma) |
|
nSearchTokenLen_Min |
minimale Länge, die ein in der einfachen Suche zu berücksichtigendes Wort haben muss; default: 3 |
|
sSwl |
Name der Datei, die die Stoppwortliste enthält; diese muss im Datenbankverzeichnis stehen.
Beispiel: sSwl=swl1.opt |
|
bEnableUser |
wenn mit Wert belegt (beliebig, typisch =1), wird der Leserbereich freigeschaltet |
|
bDisableInfomails |
wenn gesetzt, werden das Textfeld und die Absende-Schaltfläche zum Versand von Mails an die Bibliothek ausgeblendet |
|
sAdmRC |
Leserklasse, deren Mitglieder Admin-Rechte haben (ab V4.02) |
|
sLoginMsg |
PopUp-Meldung bei erfolgreicher Anmeldung |
|
bPwCrypt |
wenn gesetzt, wird das Passwort zur Anmeldung mit der PHP-Funktion md5() verschlüsselt. Es ist dann nur noch über den OPAC verifizier- und setzbar. |
|
fPwDateRev |
Steuert das Format des Default-Passworts, das aus dem Geburtsdatum gebildet wird.
Wert |
Passwort-Format |
1 |
TTMMJJJJ |
2 |
TT.MM.JJJJ |
alle anderen oder nicht gesetzt |
JJJJMMTT |
Beispiel:
fPwDateRev=2 |
|
sSrcChargeLimit |
Teilfeldkennung im Leserklassensatz, aus dem die Gebührenschwelle für den Entleihstopp entnommen wird.Default: g |
|
sDefaultChargeLimit |
in EUR, falls sich keine Gebührenschwelle aus den Leserklassendaten ermitteln läßt
Defaulkt: 0 (d.h. es werden keine Leihfunktionen ausgeführt, wenn Gebühren offen sind) |
|
nBookGoodwillTime |
Zeit in Sekunden, nach der eine Reservierung noch ohne Kosten storniert werden kann (ab Version 4.01) |
|
bCL_Mail |
Flag; auf 1 setzen, wenn bei Vormerkungen auf ein Dauerleih-Medium eine Mail an die Bibliothek verschickt werden soll |
4.07 |
sTitle |
Text für Titel-Tag (Referenz-Template) |
|
Library |
Kennung / Kurznamme der Bibliothek; wird für Authentifizierungsantwort und Kalenderdatensätze verwendet |
|
sDisplayParameterList |
Exportparameter (Pfichtangabe!) Listenanzeige
z.B. sDisplayParameterListald--list |
|
sDisplayParameterFull |
Exportparameter Vollanzeige (Pflichtangabe!)
sDisplayParameterFull=ald--full |
|
sDisplayParameterIntern |
Exportparameter Vollanzeige im Internformat
sDisplayParameterIntern=ald--intern |
|
sPrintParameter |
für Listen im Textformat
Beispiel: sPrintParameter=ald--prn |
|
sStartPla |
plattformabhängige Starteinstellungen für Template-Verzeichnis und Template-Datei
Strulktur des Variableninhalts:
{pla}:{dir},{file}
Diese Elemente können mit "|" getrennt wiederholt werden, um eine endgeräteabhängige Umschaltung auf verschiedene Layouts zu realisieren.
Beispiel: pc:tpl,index.html|sma:sm,index.html|bot:tpl,info.html
pc:tpl,index.html - Endgerät ist ein PC, Standard-Layout
sma:sm,index.html - Endgerät ist ein Smartphone - Mobil-Layout
bot:tpl,info.html - "Endgerät" ist ein Bot oder eine Suchmaschine: Info-Seite anzeigen
|
4.07 |
sStartTab |
Startbild bei Neustart
Beispiel: sStartTab=Tab1 |
|
sStartSrch |
bei Start aktive Suchmaske (ab V2.20) |
|
sSortStandard |
Sortierparameter für Einfache Suche; Dateiname der Sortierparameter ohne Erweiterung
Beispiel: sSortStandard=als-yop #als-yop.?pr sortiert nach Jahr |
|
sSortKonto |
Sortierparameter für Kontoanzeige; Dateiname der Sortierparameter ohne Erweiterung
Beispiel: sSortKonto=al4s-kto |
|
sSortStandardDir |
Standard-Sortierrichtung
Default: up
Beispiel: sSortStandardDir=down |
|
sDelimiterStd |
Trennzeichen zur Wortseparierung für einfache Suche (RegEx-Ausdruck)
Default: /[\s,]+/
Beispiel: sDelimiterStd=/[\s\.,:\/<>=-]+/ |
|
sNeRegister |
Register für Neuerwerbungsdatum; In diesem Register müssen die Datumsangaben für Zugang oder Erfassung der Titelsätze in der Form YYYYMMDD recherchierbar sein
Beispiel: sNeRegister =|: §eTIT |
|
nNeTageMax |
Max. Tage zurück für Selektion der Neuerwerbungen; so anpassen, dass die zu erwartende Ergebnismenge nicht wesentlich über 1000 ... 2000 Medien liegt
Beispiel: nNeTageMax=365
Wenn nNeTageMax=0 gesetzt wird, werden die Neuererwerbungen auschließlich über den Inhalt von sNeRegister ermittelt. |
|
fDotted |
Datumsformat in sNeRegister; wenn fDotted gesetzt, wird Datum im Format YYYY.MM.DD erwartet, ansonsten im Fomat YYYYMMDD
Default: false
Beispiel: fDotted=true |
|
nNelTage |
Vorgabe für Neuerwerbungszeitraum; so wählen, dass eine sinnvolle Treffermenge entsteht
Beispiel: nNelTage=30 |
|
sMedientypen |
Inhalt der Liste für die Auswahl nach Medientyp
Jeder der durch | getrennten Einträge besteht aus dem Register-Suchwort und dem in der Liste anzuzeigendem Begriff.
'-' hat die Sonderbedeutung für 'keine Einschränkung'
Beispiel:
sMedientypen=-#alle|BUCH?#Buch|BUCH/SACH#Sachbuch|BUCH/SL#Belletristik
Für Allegro-OEB lassen sich die FILTER-Schlüssel im Register 9 verwenden, die WB-Version wird individuell konfiguriert |
|
sTypRegister |
Symbolischer Bezeichner für das Register, in dem die Medientyp-Suchworte zu finden sind
sTypRegister=TYP |
|
sTypSys |
Register, über das die im Katalog vorhandenen Medientypen ermittelt werden können (wenn nicht gesetzt, werden die Medientypen aus sMedientypen verwendet.
Format des Wertes:
Register#Prefix#Kat#PfAbbr#PfDes
Dabei bedeuten:
Register |
Registerbezeichnung ("|;" oder "GEH") |
Prefix |
Register-Prefix |
Kat |
Kategorie, in der die Daten stehen |
PfAbbr |
Telfeldkennung für das Kürzel |
PfDes |
Teilfeldkennung für die Klartextbezeichnung |
Beispiel:
sTypSys="|;#SYSE#9A0#C#B"
Zur Ermittlung der Medientypen aus der Datenbank wird die Parameterdatei al-typreg.@pr verwendet, die dazu im Datenbankverzeichnis vorhanden sein muss und die durch "|" getrennten Tupel MT-Code und MT-Bezeichnung liefert.
|
|
fCompreSrch |
Satzübergreifende Suche einschalten (sog. Schiller-Räuber-Suche)
Default: 0
Beispiel: fCompreSrch=1 |
|
fExpandRelations |
Satzübergreifende Suche: wenn aktiv, werden Einträge über die Suche+ auch über Verweisungen gefunden
Default: 0
Beispiel: fExpandRelations=1 |
|
sReferenceSign |
Zeichenkette, die einen Verweis in einem Register kennzeichnet
Besispiel: sReferenceSign=-> |
|
sRegExsCnt |
Registerabschnitte zur Zählung der Exemplare
Beispiel: sRegExsCnt="( |: EXEM? ) NOT ( |: ABG? )" |
3.05 |
sRegTitCnt |
; Registerabschnitte zur Zählung der Titelsätze
sRegTitCnt="|: eTIT?" |
3.05 |
sRegOnlCnt |
Registerabschnitte zur Zählung der elektronischen Medien
sRegOnlCnt="|9 FILTER/E-MEDIEN" |
4.10 |
sSrchFields |
Anzahl der Suchfelder für Standardsuche; muss mit der im Template verwendeten Anzahl übereinstimmen
Beispiel: sSrchFields=4 |
|
sRegister |
Vorgaben für Registerauswahl für die Suche+; nach dem # steht die symbolische Bezeichnung für das Register, in dem zu suchen ist.
Beispiel; Register=Stich- und Schlagworte#STW|Titelanfaenge#TIT|Personen/Koerperschaften#PER |
|
sSortPar |
Sortierparameter, die im Bereich Suche+ angeboten werden sollen
Jeder durch | getrennter Eintrag hat folgenden Inhalt: Name der Parameterdatei, anzuzeigender Begriff, Standard-Sortierrichtung
Beispiel: sSortPar=als-yop#Jahr#down|als-ver#Verfasser#up|als-t#Titel#up |
|
sBranches |
Liste der Zweigstellen; Listentrennung |, Elementetrennung #
Format: kürzel#Klartext[|kürzel#Klartext[|...]]
wenn leer bzw nicht vorhanden, werden die Zweigstellenfunktionen abgeschaltet
Wert wird auch in sAcUserVars[#uBR] gesetzt |
|
sLogicOperators |
Operatoren für logische Verknüpfung der Suchfelder
Jeder durch | getrennter Eintrag hat folgenden Inhalt: Operator für find-Befehl , anzuzeigender Begriff
Beispiel: sLogicOperators=AND#und|OR#oder|NOT#nicht |
|
sRegTrunc |
Zeichen, ab denen bei Übernahme eines Begriffs aus dem Register in ein Suchfeld abgeschnitten werden soll
sRegTrunc=[(: |
|
sRestrictions |
symbolische Bezeichnung der Restriktion (nur $a-Schema!) |
|
sRestrOperators |
Restrictions-Operatoren (nicht für Allegro-OEB-Datenbanken)
sRestrOperators=gt#>|eq#=|lt#< |
|
nRegisterLines |
Anzahl der Zeilen in Registeranzeige
Beispiel: nRegisterLines=15 |
|
sMailTo |
Adressat für ReservierungsMails. z.B. klarname |
|
sMailToBr |
ab V3.03 Array der zweigstellenspezifischen Mailadressen; Bedeutung wie sMailTo; Mails werden an die das betroffene Exemplar besitzende Bibliothek gesendet |
|
sMailToData |
Adressat für Daten-Mails. z.B. klarname
Ist diese Adresse nicht gesetzt, werden alle Mails an {sMailTo} gesendet |
|
sMailToDataBr |
ab V3.03: Array der zweigstellenspezifischen Mailadressen (Bedeutung wie sMailToData), damit die Mails an die Heimat-Bibliothek des Lesers gesendet werden können
Beispiel: sMailToDataBr=Stich- und Schlagworte#STW|Titelanfaenge#TIT|Personen/Koerperschaften#PER |
|
sMailFrom |
Absender für Mails. z.B. klarname |
|
sErrTimeFile |
Pfad und Name der Datei, in der der letzte Fehlermeldungsversand gespeichert ist
Default: /var/www/web0/phptmp/AL-OpacErr.tstmp
Das angegebene Verzeichnis muss in open_basedir enthalten sein! |
|
sErrLogFile |
wenn gesetzt, werden in dieser Datei alle Log-Meldungen abgelegt |
|
sMaintenanceMessage |
Meldunstext, fall DB nicht verfügbar
Satndard: Die Datenbank wird momentan gewartet |
|
nErrMsgDelay |
Verzögerung für das Versenden von Fehler-Mails in s; Es wird nur eine Mail verschickt, wenn der letzte Fehlerzustand mindestens die angegebene Zeit zurückligt
Default: 900s
Wenn diese Variable auf 0 gesetzt ist, werden keine Mails versandt |
|
sTypRegister |
symbolischer Name für Medientyp-Register |
|
sRegResName |
Bezeichner für Medientyp-Einschränkung (ermöglicht Mißbrauch ;-) |
|
3.3.3. #u-Variablen für die formatierte Ausgabe
Name |
Typ |
Beschreibung |
Quelle |
verwendet in |
#uIP |
String |
IP-Nummer des Web-Clients |
intern |
|
#ulc |
Boolean |
gesetzt, wenn Client-IP im Bereich eines lokalen Netzes (s. sLocalNetworks in Absch, 4.3.2 und IS_LOCAL im Abschn. 4.2.2.) |
intern |
|
#uPC |
String |
Lesercode, wenn angemeldet, sonst leer |
intern |
|
#uRC |
Char |
Leserklasse des Patrons |
intern |
|
#uAC |
Char |
Leserklasse mit Admin-Rechten (ab V4.02) |
al-opac.ini.php |
Export-Parameter |
#umR |
Integer |
max. Anzahl der Verlängerungen für den Leser insgesamt |
intern |
|
#umP |
Integer |
max. Anzahl der Vormerkungen für den Leser insgesamt |
intern |
|
#uLG |
String |
Sprachkürzel als drei Zeichen wie in allegro definiert: ger, eng usw.; wenn nicht besetzt wird Standardsprache angenommen |
intern |
|
#uAG |
Integer |
Alter des angemeldeten Lesers |
intern |
|
#uDB |
Boolean |
wenn gesetzt, werden Diagnosemeldungen in der Anzeige ausgegeben |
sAcUserVars |
ald--full.?pr |
#uCW |
Boolean |
wenn gesetzt, wird WorldCat-Suche eingeblendet |
sAcUserVars |
ald--full.?pr |
#udm |
String |
Medientypangabe für technische Exemplare |
sAcUserVars |
ald--full.?pr |
#uCL |
Boolean |
wenn auf 0 gesetzt, werden keine Vormerkungen auf Dauerleihen erlaubt |
sAcUserVars |
ald?-full.?pr |
#uco |
String |
enthält URL für Medien-Cover. Ist diese Variable vorhanden, wird ein Image in der Vollanzeige eingeblendet, dessen URL sich aus dem Inhalt der #uco und einem im Titelsatz hinterlegtem Dateinamen zusammensetzt.
Beispiel: aus
#uco http://server.tld/verzeichnis/
und
#94c image.jpg
wird
< img s r c ="http://server.tld/verzeichnis/image.jpg">
Die Verwendung der #94c wäre ein Beispiel für das A-Schema; es kann eine beliebige passende Kategorie verwendet werden. Die al4d-full.apr ist dann entsprechend anzupassen. |
sAcUserVars |
ald--full.?pr |
#uoG |
Flag |
Gebührenberechnung komplett unterdrücken |
sAcUserVars |
Renew-Jobs |
#uFn |
String |
Konfiguration der erlaubten Buchungsfunktionen in der Detailanzeige:
B:0 |
- |
Reservieren (Book) unterdrückt |
P:0 |
- |
Vormerken (Prebook) unterdrückt |
R:0 |
- |
Verlängern (Renew) unterdrückt |
R:1 |
- |
Verlängern auch, wenn schon gemahnt (ab V4.06) |
Beispiel - alle Buchungsfunktionen abschalten:
sAcUserVars=#uFn=P:0,B:0,R:0
Hinweis: Welche Funktionen in der Konto-Anzeige angeboten werden, wird über die Gestaltung des Templates bestimmt. |
sAcUserVars |
ald--full.?pr
Renew-Jobs |
#uBR |
String |
Heimatzweigstelle des Lesers (Kürzel) |
(intern) |
|
#ubr |
String |
Zweigstellenkürzel für Sucheinschränkung |
(intern) |
|
#uar |
Zahl |
Ausweis-Reichweite 0, 1 oder 2 (wie in alf-OEB verwendet) |
(intern) |
|
#ueu |
Boolean |
Inhalt bEnableUser oder nicht gesetzt |
(intern) |
ald--full.?pr |
#usd |
Boolean |
wenn gesetzt, werden Entleihdaten (z.B. entliehen bis und Zustand entliehen) angezeigt; wenn nicht gesetzt, wird nur die prinzipielle Entleihbarkeit angezeigt |
(intern) |
ald--full.?pr |
3.4. Allegro-Exportparameter
Die im Abschn. 4.3 aufgelisteten #u-Variablen werden an die Allegro-Exportfunktion übergeben, damit auf diese dann in den Exportparamern (*.apr bzw. *.opr-Dateien) zurückgegriffen werden kann.
3.4.1. Ergebnislisten-Parameter
Die Parameter für die Ergebnislisten werden in der Ergebnisanzeige, Merkliste und Kontoanzeige verwendet und werden mit Hilfe der OPAC-Parserfunktionen im Quelltext durch die zugehörigen Daten ersetzt.
Diese Allegro-Exportparameter stellen für jeden Datensatz eine mit [<CR>]<LF> abgeschlossene Textzeile in folgendem XML-Format zur Verfügung:
<SET><PAR .../><CONTENT><PERSON>... </PERSON><TITEL> ... </TITEL><SIGNATUR>...</SIGNATUR><MTYP>...</MTYP><JAHR>...</JAHR></CONTENT></SET>
Innerhalb des SET-Tags dürfen keine Zeilenumbrüche (Codes 0a oder 10 hex) enthalten sein.
reales Beispiel:
(todo - hier Quelltext ergänzen)
Eger, Anando Der erste Test-Titel R 11 Buch 2011
- <SET>...</SET> enthält das gesamte Listenelement
- <PAR .../> enthält Statusinformationen zum Listenelement
- <CONTENT>...</CONTENT> enthält die Inhalte der Tabellenfelder
Die Kind-Elemente von <CONTENT> können in Übereinstimmung mit dem verwendeten Template beliebig definiert werden.
Das <PAR />-Tag kann folgende Attribute besitzen:
Attribut |
Pflicht*) |
Bedeutung |
Beschreibung |
sTyp |
R |
VOR|EXS|TIT|GEB |
Typkürzel |
RECNO |
R |
{satznummer} |
Recordnummer |
sTitId |
R |
{Titel-ID} |
bei sTyp = EXS, TIT oder VOR |
sStatus |
R |
Exemplarsatz-Status oder V für Vormerkung |
bei sTyp = EXS oder VOR |
sLID |
B |
{Patron-Code} |
nur wenn sTyp = EXS und vorhanden oder VOR |
nAnzVerl |
B |
{Anzahl der Verlängerungen} |
nur wenn sTyp = EXS und entliehen |
nMaxVerl |
B |
max. Anz. der Verlängerungen des MT |
wenn kein Medientypsatz vorhanden, nicht besetzt |
sDatRueck |
|
{Rueckgabedatum als YYYYMMDD} |
nur wenn sTyp = EXS und entliehen |
sDatWart |
|
{Ablaufdatum einer Reservierung oder Vormerkung} |
nur wenn sTyp = EXS und reserviert oder VOR |
sID |
B |
Medienkennung |
entspr. Medien-ID (Barcode) |
sWert |
B |
Gebühr Währung |
nur für Gebührensätze |
sEDAT |
B |
Ablaufdatum |
für Anzeige (Ent/Vorm/Res gemeinsam) |
nFkt |
B |
Kennung für mögliche Leser-Funktion oder Anzeige |
selbst |
Status
#9DG$$ |
vorgem. |
überfäll. |
gemahnt |
Kennung (über nFkt angebotene Aktion) |
- |
0 |
0 |
- |
- |
1 = reservieren |
0 |
W |
0 |
1 |
- |
1 = reservieren |
0 |
W |
1 |
1 |
- |
2 = vormerken |
0 |
l |
? |
? |
? |
2 = vormerken |
1 |
W |
? |
? |
- |
3 = Reservierung stornieren |
1 |
W |
0 |
? |
- |
A = Reservierung erneuern |
1 |
l |
1 |
1 |
? |
B = Überfällig, vorgemerkt (Info) |
1 |
V |
- |
0 |
- |
4 = Vormerkung stornieren |
1 |
V |
- |
1 |
- |
9 = Vormerkung erneuern |
1 |
l |
0 |
? |
0 |
5 = selbst entliehen, verlängern |
1 |
l |
1 |
? |
? |
6 = selbst entliehen, nicht verlängerbar (Info) |
1 |
l |
0 |
1 |
0 |
7 = selbst entliehen, überfällig, verlängerbar |
1 |
l |
? |
? |
1 |
8 = selbst entliehen, überfällig, nicht verlängerbar (Info) |
- = kommt nicht vor, ? = nicht berücksichtigt
|
sFktName |
B |
Klartextbezeichnung der Funktion |
|
*) Plicht-Angabe: R = für Recherche- und Benutzer-Variante, B = nur für Benutzervariante
3.4.2. Vollanzeigen-Parameter
Die Allegro-Exportparameter für die Vollanzeige stellen den Datensatz als eine einzelne mit [] abgeschlossene Textzeile in folgendem XML-Format zur Verfügung:
<DETAIL>
<ISBD sTyp="{Satztyp}" sSetId="{#00}" recno="{Satznummer}"> ...
<EXS sExId="{barcode}"
sState="[0l123vgW]" <!-- Klartext für aufgeführte Codes! -->
sStTtl="Erläuterung"
sPatron="{lesercode}"
sEDAT="{Ablaufdatum}|{Rueckgabedatum}"
nFkt="{Funktionsnummer}"/>
<VOR
sTyp="TITV"
sTitId="{titelid}"
sVDate="{Verfallsdatum}"
sPatron="{lesercode}"
nFkt="{Funktionsnummer}"
/>
<VOR
sTyp="EXSV"
sExId="{exemplarid}"
sVDate="{Verfallsdatum}"
sPatron="{lesercode}"
sTStamp="{Vormerk-Zeitstempel}"
/>
</ISBD>
<ISBD ...>
...
</ISBD>
</DETAIL>
<EXS> und <VOR> können innerhalb <ISBD> mehrfach vorkommen.
In dieser Zeile dürfen keine Zeilenumbrüche enthalten sein - die Umbrüche und Einrückungen oben wurden nur zur besseren Lesbarkeit eingefügt..
reales Beispiel:
Signatur : O 613
Rath, Matthias:
Warum kennen Tiere keinen Herzinfakt ... aber wir Menschen : Natürliche Vorbeugung von Durchblutungsstörungen, Herzinfarkt, Schlaganfall, Gefäßleiden bei Diabetes, Bluthochdruck, Herzschwäche, Herzrhythmusstörungen und anderen Herz-Kreislauf-Problemen / Matthias Rath. - vollst. überarb. u. erw. Neusausg. der 3. Aufl.. - AW Almelo : MR Publishing Inc., 2003. - 336 S. : Ill. (farb.)
ISBN 90-76332-54-1
3.4.3. Kontolistenparameter
wie Ergebnislisten-Parameter
3.5. Allegro-Jobs
Funktionen wie Verlängerung, Reservierung usw. werden über Allegro-Flex-Jobs für Avanti realisiert.
Diese Jobs sind als *.flb-Dateien im Include-Verzeichnis (modpar) abgelegt.
Namenskonventionen: av_al_{Funktionsname).flb
Beispiel: Die Verlängerungsfunktion renew für die O-Konfiguration ist in der Datei renew-o.flb abgelegt.
Der Aufruf bzw. die Benutzung (es sind keine Unterprogramme) erfolgt: das Setzen der Parametervariablen und über include .Zurückgelifert wirde eine Zeichenkette.
Beginnt die Zeichenkette mit einem !, ist der Text ein Fehlertext. Im Fehlerfall ist gleichzeitig das globale Fehlerobjekt $oErr gesetzt.
Tabelle der über Jobdateien realisierten Funktionen |
Funktionsname |
Dateiname |
Bedeutung |
Parameter |
Beschreibung |
Ergebnis |
Renew |
av_al_Renew.flb |
ein Exemplar verlängern |
$RN |
Record-Nummer des Exemplarsatzes |
Mitteilung in Textform |
$BC |
Barcode des Exemplars; wird alternativ verwendet, wenn #uRN nicht besetzt ist und über Register |:E gesucht |
$PA |
Leserausweis-Nummer (Leserbarcode, Leser-ID) |
RenewAll |
av_al_RenewAll.flb |
alle Medien verlängern |
|
|
|
Book |
av_al_Book.flb |
Reservieren |
|
|
|
BookCancel |
av_al_BookCan.flb |
Reservierung stornieren |
|
|
|
BookRefresh |
av_al_BookRefresh.flb |
Reservierung verlängern |
|
|
|
PreBook |
av_al_PreBook.flb |
Vormerken |
|
|
|
PreBookCancel |
av_al_PreBookCancel.flb |
Vormerkung stornieren |
|
|
|
3.6. Stammdaten in der Datenbank
3.6.1. Anzeige der Medientypen in den Listen
Im OPAC wird als Medientyp in den Ergebnislisten immer das erste Wort der Bezeichnung aus dem Medientypstammsatz angezeigt. Diese Stammsätze lassen sich in der ÖB-Version der Allegro-Datenbank über die Einstellungen in der Benutzungsornung anpassen.
Wenn z.B. statt Digital DVD angezeigt werden soll, schreibt man als Bezeichnung des Medientyps (in Allegro-OEB: Medienart) statt Digital versatile Disc DVD oder statt elektronische Spiele Spiel elektronisch.
3.6.2. spezielle Felder in der Datenbank
Zur Darstellung von Cover- und Dateien mit Inhaltsangaben werden in den Beispiel-Templates folgende Felder verwendet:
Inhalt |
A-Schema |
O-Schema |
Cover-URL |
#94c |
#076 oder #655, wenn #652 = image/jpg |
URL des Inhaltsverzeichnisses |
#94d |
#077 |
Konfiguration der Anzeige |
|
#9A0 YBS (s. Dokumentation zum Brandenburger Menü, Abschn.4.4) |
3.6.3. Opac-Konfigurationssatz
Kat |
TF |
Inhalt |
Kodierung in DB |
ATP-Bezeichnung |
Register |
ab V |
9A[0] |
|
WB: cOPACxx (xx = Sprachkürzel)
ÖB: YcOPACxx (xx = Sprachkürzel) |
nativ |
-
(@todo: konfigurierbar) |
11 SYScOPACxx
11 SYSYcOPACxx |
4.03 |
N |
Name des OPAC (caption) |
nativ |
DbCap |
|
4.03 |
B |
Beschreibung des Datensatzes (für Anzeige im Allegro-Katalogisierungsmodul) |
nativ |
- |
|
4.03 |
C |
Beschreibung des OPACs (Text für OPAC-Startseite)
Dieser Feldinhalt wird bei der Ausgabe nicht umcodiert! |
UTF8 |
DbInf |
|
4.03 |
M |
Mailadresse(n) für Versand von Leserdaten aus OPAC; überschreibt Parameter sMailToData aus al-opac.ini.php |
nativ |
DbMail2D |
- |
4.11 |
m |
Mailadresse(n) für Versand von Reservierungsbenachtrichtigungen aus OPAC; überschreibt Parameter sMailTo aus al-opac.ini.php |
nativ |
DbMail |
- |
4.11 |
S |
Absender-Adresse; überschreibt Parameter sMailFrom aus al-opac.ini.php |
nativ |
OrigMail |
- |
4.11 |
I
|
Short-Links für vordefinierte suchabfragen; Struktur (wiederhoöbar):
Bezeichnung|Register-Suchbegriff|rel. adr. Hintergrundgrafik;
Beispiel:
Krimis - Bücher|( STW krimi ) AND ( TYP BUCH )|images/krimi.png; |
nativ |
IK-Links (ARR2) |
- |
4.11 |
c |
URLs für Coverabruf (VLB): Format:
https://api.vlb.de/api/v1/cover/@ISBN@/s?access_token=(token)|https://api.vlb.de/api/v1/cover/@ISBN@/m?access_token=(token)
|
|
|
|
5 |
l |
Cover-Backlinks (VLB):, Format:
https://www.buchhandel.de/buch/@ISBN@?MVB-Kennummer=(mvb-nummer)|Buchhandel.de
|
|
|
|
5 |
X |
Flags Coveranzeige:Format: (fehlender Ort: keine Anzeige)
Format: lS;vM;dM;
Ort: Größe
l - Liste S - klein
v - Vollanzeige M - mittelgroß
d - Druckliste L - Groß
|
|
|
|
5 |
V |
nStatus-Codes der nicht vormerkbaren Exemplare;
default: AvGt |
|
|
|
5 |
|
|
|
|
|
|
|
3.7 externe Authentifizierung
Sollen die Leser nicht über die Datenbank-Inhalte authentifiziert werden, lassen sich eigene Verfahren zur Anmeldung in der Datei auth.php implementieren.
Die auth.php enthält eine Funktion alo2_AuthExt($patron, $passwd), über die geregelt wird, ob die Anmeldung über die Allegro-Datenbank erfolgen soll oder über eine selbst zu schaffende Funktion über eine externe Authentifizierungsstelle (z.B. LADP)
3.8 Schema-spezifische Anpassungen
3.8.1 ÖB-Datenbanken (O-Schema)
Filter
Medienarten werden in OEB-Datenbanken (O-Schema) der Büchereizentrale Niedersachsen für Statistik-Zwecke über FILTER-Einträge im Register 9 unterschieden und/oder zusammengefasst. Die Registereinträge sind hier typisch in der Datei filter.opt definiert und dienen als Grundlage für die Auswahl der Medenarten (synonym: Medientypen). für die Sucheinschränkung im OPAC. Die Konfiguration dazu erfolgt in der Initialisierungsdatei al-opac.ini.php über die Variable sMedientypen.
Grundsätzlich können das Register und die Art der Einträge für jede Allegro-Datenbank individuell eingestellt werden. Für Allegro-OEB (Parametrierung Brandenburger Menü) sind folgende Filter im Register 9 definiert:
Nr. |
Eintrag im Register 9 |
Quelle |
Hinweise |
Begriff in Auswahlliste |
nur BBM |
1 |
FILTER/BUCH |
#574 oder #9DG$m beginnt mit BM oder BB oder BG |
|
Bücher |
|
2 |
FILTER/CD-ROM |
#574 oder #9DG$m beginnt mit CDR oder CD-R |
|
CD-ROM |
|
3 |
FILTER/HOERBUCH |
#574 oder #9DG$m beginnt mit HB |
|
Hörbuch |
|
4 |
FILTER/CDMC |
#574 oder #9DG$m beginnt mit CD oder MC |
|
MCs und CDs |
|
5 |
FILTER/BLU-RAY |
#574 oder #9DG$m beginnt mit BD |
|
Blu Ray |
X |
6 |
FILTER/DVD |
#574 oder #9DG$m beginnt mit DVD |
|
DVD |
|
7 |
FILTER/VIDEO |
#574 oder #9DG$m beginnt mit VI |
|
Videos (VHS) |
|
8 |
FILTER/FILM |
#574 oder #9DG$m beginnt mit FI |
s.a. NB/FILM |
Film (Spulen) |
X |
10 |
FILTER/ZEIT |
#574 oder #9DG$m beginnt mit ZTG oder ZSS |
|
Zeitungen/Zeitschriften |
|
11 |
FILTER/E-SPIELE |
#574 oder #9DG$m beginnt mit ESP |
|
elektronische Spiele |
|
12 |
FILTER/E-MEDIEN |
#574 oder #9DG$m beginnt mit ebook oder evideo oder eaudio oder epaper oder emusik |
|
elektronische Medien |
|
13 |
FILTER/AUFSATZ |
#574 oder #9DG$m beginnt mit VW |
|
enhaltene Werke/Artikel |
X |
14 |
FILTER/SONSTIGES |
nichts aus Nr. 1 - 13 |
|
sonstiges |
|
15 |
FILTER/NORMAL |
alles ausser FILTER/E-MEDIEN |
|
alle ohne E-Medien |
X |
16 |
FILTER/BUCH/SACH |
wie Nr. 1 und #060 beginnt nicht mit III oder II oder (I und 3. Stelle keine Zahl) und 2. Term nicht = R |
enthält auch Kinder-Sachliteratur |
Sachbuch |
|
17 |
FILTER/BUCH/KIND/SACH |
wie Nr. 1 und #060 beginnt mit III oder II oder (I und 3. Stelle keine Zahl) und 2. Term kein J |
|
Sachbuch Kinder |
X |
18 |
FILTER/BUCH/SL |
wie Nr. 1 und #060 beginnt nicht mit III oder II oder (I und 3. Stelle keine Zahl) und 2. Term = R |
enthält auch Kinder-Belletristik |
Belletristik |
|
19 |
FILTER/BUCH/KIND/SL |
wie Nr. 1 und #060 beginnt mit III oder II oder (I und 3. Stelle keine Zahl) und 2. Term = J |
|
Belletristik Kinder |
X |
20 |
FILTER/NB/MUSIK |
nicht Nr 1 und #060 beginnt mit TM |
auch e-Medien! |
Musik |
X |
21 |
FILTER/NB/SACH |
nicht Nr. 1 und #060 keine Kindersign. u. 2. Term nicht R |
|
Nichtbuchmedien/Wissen |
X |
22 |
FILTER/NB/SACH/KIND |
und #060 beginnt mit III oder II oder (I und 3. Stelle keine Zahl) und 2. Term kein J |
|
Nichtbuchmedien/Wissen/für Kinder |
X |
23 |
FILTER/NB/FILM |
nicht Nr. 1 und Medientyp =BD oder DVD oder VI oder FI und kein NB/SACH |
|
Film Unterhaltung (alle Arten) |
X |
24 |
FILTER/NB/SL |
nicht Nr. 1 und Signatur beginnt mit R |
|
Nichtbuchmedien/Unterhaltung |
X |
3.8.2 WB-Datenbanken ($A-Schema)
(wird noch ergänzt)
3.9 In der Katalog-Datenbank gespeicherte Einstellungen
siehe ModPar-Funktionen - Einstellungen zum AndoLib Web-OPAC
(Version 4.08)
Artikel zuletzt bearbeitet am: 21.12.2024 22:32
| |