Polecenia funkcji 'external'
...
Nazwa | Params | Opis | |||||
---|---|---|---|---|---|---|---|
BLO | f | wykonuje jedną z funkcji operacji na plikach binarnych (zob. dalej) | |||||
CLEARDB | Kasuje całą bazę poza tabelami tbl_users, tbl_params, tbl_params_templates, tbl_kinds, tbl_versions BEZZWROTNIE... I ustawia wewnętrzne liczniki indeksów, na podstawie zawartości wyczyszczonej bazy. | ||||||
CZT | data|agenda|rejestr|liczba | do zmiany wpisu w tabeli czytelni dla podanej daty, agendy i kodu (jeśli liczba = 0, wiersz zostanie wykasowany), próba aktualizacji nie istniejącego wiersza, będzie ignorowana i nie zwróci błędu | |||||
DELETE | idt | Usunięcie rekordu o przesłanym idt (rec_type + rec_id) | |||||
HELLO | Zwraca łańcuch znaków, za pomocą którego klient SOWY przedstawił się w serwerze (poleceniem hello) | ||||||
DEF | pole | zwraca kind rekordu, np: DEFU245T (rekord U, pole 245T) zwróci XTY, gdzie X - oznacza, że pole jest indeksowane.
| |||||
EGZ | od|do | Kasuje wszystkie egzemplarze z przesłanego zakresu (od - do). Operacja kasowania wykonywana jest wyłącznie na tabelach wypożyczalni (obroty, egzemplarze, ubytki, itd). External nie ma wpływu na tabelę z opisem rekordów (tbl_items_idx i tbl_items_full). Format przesłanych sn jest bez znaczenia (mogą być z kreskami, lub bez). Jeśli chcemy wykasować tylko jeden sn, wówczas podajemy go w obu parametrach, aczkolwiek, z punktu widzenia wydajności kasowanie zakresu jest dużo lepszym rozwiązaniem. | |||||
INDEXES | zwraca listę identyfikatorów indeksu "orders" aktywnych dla zalogowanego profilu (rezultat jest stringiem, w którym poszczególne identyfikatory są oddzielone pionową kreską) | ||||||
IPUB | f | Wykonuje jedną z funkcji IPUB (zob. dalej) | |||||
ISBN | isbn | Kontrola poprawności ISBNu, jeśli kod jest poprany, zwraca pusty string, w przeciwnym wypadku komunikat błędu, | |||||
LICENCJA | Zwraca wartość linia_1|linia_2 - gdzie linie oznaczają wartości dla dwóch linii drukowanych na nalepkach | ||||||
MAIL S | smtp|mail|tytuł|treść | Wysyła maila przez konfigurację SMTP o symbolu smtp (pusta wartość to konfiguracja domyślna, pozostałe wartości są zdefiniowane w CFG_MAIL_SENDERS), na adres odbiorcy mail o podanych tytule i treści. | |||||
MAIL X | smtp|mail|tytuł|mime_type|kind| czyt_id|set_time|treść | Jak MAIL S, ale wymaga podania dodatkowych wartości
| |||||
NEW | dpola | Tworzy nowy dokument typu d - pola to lista pole=wartość, rozdzielane znakiem o kodzie #13 (\r) | |||||
OBRZ | data|where | Ustawia datę zwrotu data w tabeli obrotów gdzie spełniony jest SQLowy warunek where. | |||||
PROFILE | Nazwa profilu bieżącego użytkownika | ||||||
RANGE | od|do|kind | Polecenie zwraca listę rekordów (oddzielonych pionową kreską) dla których zostanie wykonane następujące zapytanie SQL:
czyli zostanie zwrócona lista rekordów, których wartość pola fld_str_field znajduje się w zakresie wartości od - do | |||||
REPLACE | typ_rekordu|sql_where| stary|nowy | Wyszukuje POLA należące do rekordów typu typ_rekordu, zgodne z SQLowym warunkiem sql_where, następnie w tak znalezionych polach, jest zamieniany ciąg znaków stary na nowy. Nie są wykonywane skrypty otwarcia, zamknięcia czy propagacji, tabela items_idx_full jest automatycznie aktualizowana o przeprowadzone zmiany. External jest dostępny wyłącznie dla użytkownika sokrates, z maszyny lokalnej (jeśli mamy lokalną wersję serwera), lub zalogowanego zdalnie z naszego IP. | |||||
RIGHT | r | wartość atrybutu przypisanego do uprawnienia o nazwie r dla bieżącego użytkownika. Jeżeli użytkownik nie ma uprawnienia r to wynikiem jest '*' (gwiazdka) | |||||
SEARCH | identyfikator | Na podstawie identyfikatora zwraca nazwę indeksu "orders" (np.: dla identyfikatora TY, zwróci "tytuł") | |||||
SET | param wartość | Ustawia nową wartość parametru Sowy o nazwie param | |||||
SKO | f | Wykonuje jedno z poleceń skontrum (zob. dalej) | |||||
SKR_SETDONT_CHECK | Wywołanie tego externala, spowoduje, że program wykonywany na kolekcji NIE zostanie przerwany, jeśli podczas obróbki któregoś z rekordów wystąpi błąd. | ||||||
SQL | f | Wykonuje jedno z poleceń SQL (zob. dalej) | |||||
STA | rekord|operacja|rekord nadrzędny | Dodaje wpis do tabeli statystycznej dla rekordu rekord, z informacją o rodzaju operacji operacja (P - propagacja, A - dodanie, U - aktualizacja, D - usunięcie). Jeśli operacją jest propagacja, wówczas wymagany jest jeszcze trzeci parametr rekord nadrzędny, który zawiera identyfikator rekordu propagowanego. | |||||
USER | nazwa bieżącego zalogowanego użytkownika | ||||||
USERS | USERS? USERS#user,profil,prawa | Składnia praw dla komendy USERS# jest identyczna jak dla komendy user klienta administracyjnego. External USERS? zwróci listę wszystkich użytkowników systemu, w formacie identycznym jak komenda users export klienta administracyjnego, z tą różnicą iż zamiast podziału na linie, poszczególne wpisy są oddzielone pionowa kreską (|). Komenda USERS#, przyjmuje argumenty w identycznym formacie, można przy jej pomocy zmieniać prawa i profil już istniejącego użytkownika, bądź dodać nowego (zostanie utworzony z hasłem: 1). Komenda USERS# ma dwa dodatkowe znaczniki. Jeśli przed nazwą użytkownika wstawimy:
| |||||
WYP | f | wykonuje jedną z funkcji wypożyczalni (zob. dalej) |
...
Nazwa | Params | Opis | |
---|---|---|---|
A | t|lista | wprowadź nowy rekord typu t Lista to kolejne pola nowego rekordu rozdzielone znakiem o kodzie #13 (\r), np. 159Z.1.1.1.1=aaa | |
B | i|s | wydruk naklejki o identyfikatorze i oraz sygnaturze s | |
CV | adres|typ|ix|klucz | Przeglądanie CKHW, np. CV$CFG_CKHW_A$|A|HH | |
DE | |napis | okno dialogowe z opisem błędu | |
DF | |pole | wybór czcionki | |
DL | |lista | wybór z listy - gdzie lista jest zdefiniowana jako ciąg par <kod>#1<opis>#1 - wynikiem jest wybrany z z okna <kod>. | |
DM | |napis | okno dialogowe z informacją | |
DO | |file|opis|ext | dialog pobrania nazwy pliku (odczyt) | |
DP | |fld|before|after|lines | uaktywnienie menu tekstów dla wskazanego pola | |
DQ | |napis | okno dialogowe z zapytaniem tak/nie | |
DS | |file|opis|ext | dialog pobrania nazwy pliku (zapis) | |
DT | |lista | wybór z listy prezentowanej w formie drzewa - elementy drzewa to krotki <poziom>|<kod>|<opis> rozdzielane znakiem #13 | |
DW | |napis | okno dialogowe z ostrzeżeniem | |
ELZb | kod|pole | znajdź ostatni wpis w bazie - ELZb<kod>|949Z | |
FO | |file | pobranie zawartości pliku | |
FS | |file|contents | zapisanie pliku | |
FT | |file | pobranie pliku tekstowego bez sygnalizacji braku | |
FW | ścieżka do katalogu roboczego | ||
F | file|opis|ext | wyszukanie pliku | |
HO | lista rekordów otwieranych | ||
HZ | lista rekordów zapisywanych | ||
I | f|x|h | wywołanie formatowania KHW (<format>|<ix>|<hardkey>) | |
J | file | wyszukanie pliku | |
L | ix | wartość ostatniego wpisu w indeksie ix opcjonalnie można podać prefix w L<ix>|<prefix> | |
MC | id | pozaekranowa edycja rekordu - anuluj edycję rekordu | |
MO | id | pozaekranowa edycja rekordu - otwórz rekord bez formularza | |
MS | id|data | pozaekranowa edycja rekordu - zapisz rekord bez formularza | |
N | d|pola | Dodaje bez edycji nowy rekord typu d i ustawia pola (pole=wartość) | |
O | rekord | Otwiera rekord do edycji | |
PO | edycja helpów - pobierz plik pomocy | ||
PS | edycja helpów - zapisz plik pomocy | ||
R | d | dialog wyszukiwania rekordu danego typu (np. RU) (szukania referencji dokumentu) | |
UN | Nazwa bieżącego użytkownika | ||
UP | Profil bieżącego użytkownika | ||
UR | Prawa bieżącego użytkownika | ||
V | id | wynik skryptu referencja dla rekordu id | |
V | id|name | wynik skryptu o podanej nazwie name dla rekordu id | |
W | f|id | znajdź opis dokumentu <format>|<idt> | |
X | x|l | dialog wyszukiwania KHW w indeksie x dla pola l (np. XXa|pole) | |
Y | ix|klucz | wybiera z KHW wartość pola 'full' | |
! | file | Uruchom program skojarzony z file | |
? | zwraca położenie kursora | ||
*ELZb |
External WYP
Grupa poleceń do obsługi wypożyczalni. Wywołanie: external('WYP<cmd><params>'):
cmd | params | Wynik funkcji | |||||
---|---|---|---|---|---|---|---|
A | sn|rekord|agenda | Udostępnij egzemplarz sn rekordu rekord w agendzie agenda. W razie błędu zwracany jest komunikat o owym. | |||||
a | czytelnik|rekord|dni | Prolongata zamówionego przez czytelnika rekordu o podaną ilość dni. | |||||
B | sn|rekord|agenda|powod|agenda_d | Zgłoś do wycofania egzemplarz sn rekordu rekord z agendy agenda z powodu powod. Gdy agenda ubytkowania jest inna niż udostępniania, podać należy agenda_d. W razie błędu zwracany jest komunikat. | |||||
Cop | rekord|agenda|op_params | Zmiana danych czytelnika. Drugi znak komendy precyzuje operację (i dereminuje też op_params, które zawierają kolejne parametry). Dostepne wartości op: K - kod kreskowy. Rejestruje nowy kod kreskowy dla czytelnika i wizytę czytelnika w agendzie. op_params zawierać winno nowy kod kreskowy. jeśli zostanie podany pusty - unieważnia bieżący kod kreskowy czytelnika. L - limit wypożyczeń. op_params zawiera nowy limit wypożyczeń. W - data ważności. op_params zawiera nową datę ważności konta B - blokada. op_params zawiera treść blokady konta Z - korekta daty zapisu. op_params zawiera nową datę zapisu czytelnika | |||||
D | rekord | Usunięcie danych czytelnika. W razie błędu zwracany jest komunikat. | |||||
F | rekord|f | Pobiera pole f rekordu czytelnika o identyfikatorze rekord. Np. WYPFO123|Z.1 pobiera pierwsze wystąpienie pola Z rekordu O123 Tym samym eksternalem można pobierać pola rekordu bazy podstawowej. (zob. eksternal WYPP). | |||||
G | rekord | Informacja o globalnym stanie konta czytelnika (we wszystkich agendach). Zwraca: <wyp>|<rez>|<zam>|<kary>|<prz> <wyp> - liczba wypożyczonych pozycji | |||||
K | sn | Zwraca kwotę kary za przetrzymanie egzemplarza o identyfikatorze sn. Dotyczy przetwarzania rekordu czytelnika. | |||||
I | rekord|agenda | Informacja o stanie konta czytelnika w agendzie. Zwraca: <wyp>|<rez>|<zam>|<kary>|<kaucje>|<wizyta>|<prz> <wyp> - liczba wypożyczonych pozycji UWAGA1: jeśli parametr wyp.penalty.default.settlements zawiera A to działa jak wyżej, inaczej zwraca wartości globalne (nie w agendzie). UWAGA2: jeśli parametr wyp.penalty.default.settlements zawiera C to kwota niezapłaconych kar zwracana jest globalnie, inaczej zwraca wartości w agendzie. | |||||
J | barkod | Sprawdza czy podany barkod jest wolny. Jeśli jest to barkod egzemplarza, wraca <rekord>|<sn>, jeśli jest to barkod czytelnika zwraca <rekord>|<czy_ważny>, a jeśli jest wolny to zwraca pustą wartość. | |||||
N | n lub prefix|n | Znajduje wolny kod kreskowy n-znakowy. Jeśli podano prefix, znajduje wolny kod zaczynający się od podanego prefiksu. | |||||
Oop | rekord|op_params | Informacja o zawartości konta czytelnika. Drugi znak komendy precyzuje operację i determinuje op_params. W przypadku zwracania listy - kolejne wiersze rozdzielane są znakiem o kodzie #13 (\r). Dostępne wartości op: A - informacja o agendzie zapisu (zwraca numer agendy) W - bieżący stan wypożyczeń. Zwraca listę wartości <sn>|<agenda>|<data_wyp>|<data_zwr> H - historia wypożyczeń. Zwraca listę wartości <sn>|<agenda>|<data_wyp>|<data_zwr> R - bieżący stan rezerwacji. Zwraca listę wartości <sn>|<agenda>|<status>|<data_rez>|<czas_rez> Z - bieżący stan zamówień. Zwraca listę wartości <rekord>|<agenda>|<data_zam>|<czas_zam>|<data_max> K - kary do zapłacenia. Zwraca listę wartości <agenda>|<data_nal>|<flag>|<sn>|<wartość> P - wpłaty/wypłaty. Zwraca listę wartości <agenda_w>|<data_wpl>|<rodzaj>|<kwit>|<wartość> O - odwiedziny. Jako op_params można podać numer agendy, jeśli się nie poda, zwraca listę dla wszystkich agend. Zwraca listę: <data>|<agenda> o - Jako op_params należy podać <data>| lub <data>|<agenda> - Jeśli data odwiedzin wskazanej agendy jest większa lub równa podanej, zwracana jest ta data. W przypadku nie podania agendy, sprawdzane są wszystkie agendy. w - Jako op_paramsnależy podać <data>| lub <data>|<agenda> - Jeśli data wypożyczenia we wskazanej agendzie jest większa lub równa podanej, zwracana jest ta data. W przypadku nie podania agendy, sprawdzane są wszystkie agendy. M - czyt|sn - zwraca liczbę wygenerowanych monitów | |||||
R | sn | Informacja o rezerwacji egzemplarza o identyfikatorze sn. Zwaca: <czytelnik>|<agenda>|<status>|<data_rez>|<czas_rez> Od wersji zwraca dodawkowo |<odbior>|<timeout> | |||||
S | sn | Sprawdza status dostępności i agendę dla egzemplarza o identyfikatorze sn. Zwraca łańcuch postaci <dostępność>|<agenda> - gdzie <dostępność> wyrażona jest kodem: D - dostępne, Nx - niedostępne z powodu x (Z - zarezerwowane, W - wypożyczone). Np. NZ|0 - egzemplarz należy do agendy o numerze "0", nie jest dostępny gdyż jest zarezerwowany. W przypadku pozycji ubytkowanej dodatkowo zwracane jest <agenda>|<data>|<dokument>|<pozycja>|<nr_kol> W przypadku pozycji zgłoszonej do ubytkowania (dostępność Nx gdzie x <> W i Z): <ubytek>|<data_wp><agenda>, zaś jeśli <ubytek>=P, dodatkowo <dokument>|<pozycja> | |||||
W | sn | Informacja o wypożyczeniu egzemplarza o identyfikatorze sn. Zwraca: <czytelnik>|<kas>|<data_wyp>|<data_zwr> | |||||
X | sn | Informacja o wypożyczeniu egzemplarza o identyfikatorze sn. Zwraca: <czytelnik>|<kas>|<data_wyp>|<data_zwr>|<prolongaty_automatyczne> | |||||
Z | rekord|agenda | Czy wydanie było zamawiane. Nie podanie agendy sprawdza wszystkie agendy. Zwraca liczbę zamówień. | |||||
Z? | rekord|agenda | Zwraca identyfikatory rekordów czytelników, którzy zamawiali wydanie. Nie podanie agendy sprawdza wszystkie agendy. Rekordy separowane są znakiem |, np. O123|O345| | |||||
# | sn|rekord | Przenieś egzemplarz sn do innego rekordu rekord. W razie błędu zwracany jest komunikat o owym. | |||||
> | sn|nsn | Zmiana identyfikatora egzemplarza z sn na nsn w bazach wypożyczalni. | |||||
& | parametry | Wykonuje polecenie zgodne z protokołem samoobsługowego zamawiania i rezerwowania. | |||||
-op | op_params | Usuwanie pozycji. Drugi znak precyzuje operację i determinuje op_params (niżej podane zaraz za kodem operacji). DOstępne wartości op: Z - rekord_ks|rekord_czt - Usunięcie zamówienia na rekord_ks dla czytelnika rekord_czt R - sn - Usunięcie rezerwacji bez obsługi zamówienia A - sn - Realizacja zamówienia na egzemplarz | |||||
* | url | Jako rezultat zwraca wynik operacji HTTP GET na przesłanym URL. | |||||
: | agenda | Zamienia ustawienia prawa wypożyczanie (&W) oraz inne (&I) dla aktualnie zalogowanego użytkownika. Ustawia przesłaną agendę jako nową agendę główną dla prawa wypożyczanie, jednocześnie przenosząc agendę z tego prawa, do prawa inne.
Zwraca komunikat błędu, lub pusty string. |
...
cmd | params | Wynik funkcji |
---|---|---|
Q? | sn | Zwróci 'S' jeśli egzemplarz o podanym sn jest brakiem stałym, '+' jeśli jest oznaczony jako "na półce" lub pusty string, jeśli status jest nie określony. |
Q+ | sn | Oznacza egzemplarz o podanym sn jako znajdujący się na półce, zwraca '+' |
Q- | sn | Oznacza egzemplarz o podanym sn jako nie znajdujący się na półce, zwraca '-' |
Q* | sn | Jeśli egzemplarz o podanym sn jest "na półce" ściąga go i zwraca '-', jeśli go nie ma dodaje go i zwraca '+' |
S | sn | Status egzemplarza. Zawsze zwraca co najmniej: <dostęp><powód>|<agenda>. Jeśli <dostęp>=U dodatkowo zwraca informację o pozycji ubytkowanej, tj: <data>|<dokument>|<pozycja>|<nr_kol> Jeśli <dostęp>=N zaś <powód> nie jest W lub Z dodatkowo zwraca informację o pozycji zgłoszonej do ubytkowania, tj: <ubytek>|<data_wp>, a jeśli <ubytek>=P to jeszcze <dokument>|<pozycja>
|
U | sn | Czy jest stały ubytek. Jeśli nie, zwracany jest pusty łańcuch. |
- | rekord|lista sn | Aktualizuje bazę skontrum na podstawie przesłanej listy snów i identyfikatora rekord. Porównuje listę egzemplarzy należących do rekordu i tych które znajdują się w tabeli skontrum. Jeśli w tabeli skontrum znajduje się egzemplarz, który nie został przesłany na liście sn, wówczas jest on kasowany z tabeli skontrum. |
...
Note |
---|
Każdy z externali STN zwraca: |rezultat - jeśli wszystko jest ok komunikat błędu| gdy wystąpi błąd |
...
cmd | params | Wynik funkcji |
---|---|---|
EXECUTE | <query_id> | komunikat błędu, lub pusty string jeśli OK |
FROM | <query_id>|<nazwa_tabeli> | komunikat błędu, lub pusty string jeśli OK |
FULL | <query_id>|<lista_pól>|<nazwa_tabeli>|<warunek_zapytania>|<kolejność_sortowania>|<oczekiwana_ilość_rekordów> | komunikat błędu, lub pusty string jeśli OK |
GET | <query_id> |
|
LIMIT | <query_id>|<oczekiwana_ilość_rekordów> | komunikat błędu, lub pusty string jeśli OK |
ORDERBY | <query_id>|<kolejność_sortowania> | komunikat błędu, lub pusty string jeśli OK |
PREPARE | brak | QUERY_ID |
SELECT | <query_id>|<lista_pól> | komunikat błędu, lub pusty string jeśli OK |
UNPREPARE | <query_id> | komunikat błędu, lub pusty string jeśli OK |
WHERE | <query_id>|<warunek_zapytania> | komunikat błędu, lub pusty string jeśli OK |
...
Info |
---|
Szczegółowe informacje na temat externali SQL są dostępne tutaj |