Техническая документация WEB ИРБИС64 и WEB ИРБИС32 Техническая документация WEB ИРБИС64 и WEB ИРБИС32 ______________ 1 Основные термины и понятия __________________________________________ 2 Файловый состав дистрибутива ________________________________________ 3 Установка WEB ИРБИС и расположение его компонентов ________________ 4 Общий обзор работы шлюза WEB ИРБИС ________________________________ 7 Предпроцессинг WEB ИРБИС ___________________________________________ 7 Скрипт-защита _________________________________________________________________ 7 Авторизация пользователя _______________________________________________________ 7 Команды WEB ИРБИС _________________________________________________ 7 Принципы выполнения команд WEB ИРБИС _______________________________________ 7 Команда вывода HTML страницы - “показ”(F) ______________________________________ 8 Команда поиска - “поиск”(S) ______________________________________________________ 8 Команда показа терминов словаря - “словарь”(T) ___________________________________ 9 Команда предварительного заказа - “заказ”(Z) ______________________________________ 9 Команда изменения записей- “запись” (R) __________________________________________ 9 Команда выгрузки записей - “экспорт” (E) ________________________________________ 10 Команда заимствования записи - “скачать” (4) ____________________________________ 10 Команда чтения внешнего файла - “файл”(2) ______________________________________ 11 Команда чтения внутреннего двоичного объекта из библиографической записи – «интегрированный файл»(3) ______________________________________________________ 11 Команда получения количества найденных документов в удалённой базе – «количество найденных»(G) __________________________________________________________________ 11 Обработка фреймов __________________________________________________ 12 Правила объединения фреймов ___________________________________________________ 12 Директивы фреймов ____________________________________________________________ 12 Директивы вставки системных значений __________________________________________ 12 Директивы вставки файла _______________________________________________________ 12 Директивы вставки формата _____________________________________________________ 13 Директивы вызова внешнего скрипта _____________________________________________ 14 Директива вставки результата выполнения текущей команды _________________________ 14 Директивы отмены раскраски найденных терминов _________________________________ 14 Учебный анализ режимов WEB ИРБИС _________________________________ 15 Базовые фреймы ________________________________________________________________ 15 Фреймы стандартного вида поиска _______________________________________________ 15 Фреймы режима поиска по словрю _______________________________________________ 16 Фреймы режима поиска по навигатору ГРНТИ ____________________________________ 16 Приложение 1. Параметры запроса WEB ИРБИС ________________________ 23 Таблица 1. Базовые параметры ___________________________________________________ 23 Таблица 2. Параметры команд ___________________________________________________ 24 Приложение 2. Параметры INI файла WEB ИРБИС ______________________ 31 Структурирование параметров ___________________________________________________ 31 Секция библиографической БД __________________________________________________ 31 Секция MAIN __________________________________________________________________ 33 Секция WEB ___________________________________________________________________ 35 Секция PARAMETRS ___________________________________________________________ 37 Секция PHP ____________________________________________________________________ 38 Секция IRBISSERVER __________________________________________________________ 38 Секция FULLTEXT _____________________________________________________________ 38 Приложение 3. Специфические для WEB ИРБИС функции UNIFOR ________ 39 Приложение 4. Отличия WEB ИРБИС 32 и WEB ИРБИС 64 _______________ 39 Приложение 5. Дополнения в составе WEB ИРБИС ______________________ 39 Приложение 6. Включение учёта статистики посещенийError! Bookmark not defined. Введение _____________________________________________________________________ 17 Включение режима ведения статистики ___________________________________________ 17 Подключение краткой формы статистики __________________________________________ 18 Подключение полной формы статистики __________________________________________ 18 Приложение 7. Распределённый поиск и заимствование(корпоративные функции) ____ 18 Схема работы веб-шлюзов Ирбис в режиме распределённого поиска ___________________ 18 Настройка WEB ИРБИС ________________________________ Error! Bookmark not defined. Настройка АРМа Каталогизатор __________________________________________________ 19 Основные термины и понятия WE B И РБИ С C GI – это программа cgiirbis_32.exe(для ИРБИС 32) или cgiirbis_64.exe(для ИРБИС 64), которая в ответ на запросы пользователей, генерирует web-страницы на основе сведений из баз данных и фреймов. WE B шл ю з, W E B И РБ И С – 1) То же, что и CGI 2) Модуль WEB ИРБИС в целом IN I фа йл W E B И Р БИ С – файл irbis_server.ini(для ИРБИС 64) или irbis32.ini(для ИРБИС 32), который содержит основные настройки шлюза. По умолчанию он находится в директории шлюза, но может так же находиться в папке Windows. Полнотекстовый поиск – ранжированный по релевантности поиск с использованием произвольного набора слов. В WEB ИРБИС выполняется по словарю ключевых слов. В полнотекстовом WEB ИРБИС для этого вида поиска применяется специальная база с индексом полнотекстовых документов. Функция доступна только в WEB ИРБИС 64. Поименованные параметры – системные параметры WEB ИРБИС, названия которых жестко определены и не могут быть изменены пользователем. Например: C21COM, I21DBN. П сев до ни м ба зы – условный идентификатор секции INI файла WEB ИРБИС, определяющий режим работы с базой. Обычно псевдоним формируется из реального имени базы, знака подчёркивания и суффикса обозначающего режим. Например, псевдоним IBIS_EX соответствует режиму Расширенного поиска. Ра н жир о ва н ие по р ел е ва нт но ст и(р а нж ир о в а ни е) – такая сортировка найденных записей, когда записи в наибольшей степени соответствующие запросу помещаются в начале списка результатов поиска, а записи соответствующие ему в меньшей степени – в конце. Функция доступна только в WEB ИРБИС 64. Се к ция ба зы да н ны х ( с ек ци я БД) – это раздел INI файла WEB ИРБИС, название которого соответствует псевдониму базы данных. В этом разделе определяется набор фреймов для каждой команды, база данных с которой должна происходить работа и дополнительные параметры. Ф о р м а т – программа на языке ИРБИС, которая определяет способ представления библиографической записи или выполняет служебные функции. Как правило форматы располагаются в самостоятельных файлах с расширением PFT, но они так же могут быть включены в фреймы. Фрейм – текстовый файл c расширением FRM, который обычно представляет собой HTML и включает специальные директивы WEB ИРБИС. Из набора фреймов шлюз составляет ответ на запрос. Технологические ресурсные файлы – файлы со стандартными расширениями, принятыми в системе ИРБИС, которые используются только WEB ИРБИС и не входят в базовый дистрибутив ИРБИС. Это форматы(*.PFT), справочники(*.MNU), файлы сортировки (*.SRW). Файловый состав дистрибутива WEB ИРБИС – это приложение использующее прямой доступ к файлам баз данных. В связи с этим оправдано размещение WEB ИРБИС и баз данных на одном компьютере. Для ИРБИС 64 это должен быть компьютер, где установлен ИРБИС -сервер. Дистрибутив включает несколько файлов: 1. wsetup.exe, borlandmm.dll, unzip32.dll – компоненты программы установки; 2. Webirbis.ini – файл настройки путей установки; 3. webirbis.zip – архив основных файлов системы 4. webirbis_z39.zip – архив Z39 компонентов(присутствует только в полной версии) Благодаря изменению файла Webirbis.ini оказывается возможной установк а компонентов WEB ИРБИС в директории с произвольными именами. По умолчанию установка происходит в директории, имеющие в качестве суффикса индекс поколения и номер версии. Например: irbis64r_01. [MAIN] HtdocsPath=irbis64r_01 — путь по умолчанию к статичным ресурсам WEB ИРБИС(рисункам, Java Script файлам и инструкциям) относительно указанной при установке папки HTDOCS. CgiPath=irbis64r_01 путь к CGI WEB ИРБИС относительно указанной при установке папки CGIBIN. FramesPath=frames — путь по умолчанию к фреймам WEB ИРБИС относительно директории, заданной параметром CgiPath DepositName=Deposit — путь к технологическимресурсным файлам WEB ИРБИС относительно директории, заданной параметром CgiPath ZipFile=WebIrbis.zip — название архива инсталлятора ZipFile_z39=webirbis_z39.zip — название архива инсталлятора Z39 компонентов GENERATION=64 – поколение WEB ИРБИС. Может принимать значения 32 или 64 ASSEMBLAGE=full – сборка WEB ИРБИС. В зависимости от того, включены ли в поставку средства Z39-50 параметр может принимать значения full или opac Все ресурсные файлы WEB ИРБИС по умолчанию располагаются в четырёх директориях: 1. В директории CGI-BIN \irbisYYr_XX\FRAMES 12 находятся файлы с расширением FRM; 2. В директории CGI-BIN\irbisYYr_XX\DEPOSIT находятся файлы с расширением PFT, MNU; 3. В директории HTDOCS\IRBISYYr_XX находятся файлы графики(JPG,GIF), стилевые таблицы(CSS), скрипты(JS), документация и другие ресурсы; 4. В директории CGI-BIN\irbisYYr_XX находится INI файл WEB ИРБИС, CGI, файл сообщений об ошибках(WebMSG.txt) и другие ресурсы. Установка WEB ИРБИС и расположение его компонентов Начиная с версии 2010.1 дистрибутивы WEB ИРБИС 32 и 64 для библиографических баз, WEB ИРБИС для полнотекстовых баз, WEB ИРБИС для имиджкаталога интегрированы. Для всех баз действует общая логика работы, и поиск выполняется по единым правилам. Полнотекстовая функция, функция работы с имидж-каталогом лицензируются независимо и право на их применение определяется ключами в установочном INI файле. Таким образом, за исключением настроек установок инсталляционного INI файла и компонентов Z39 все дистрибутивы WEB ИРБИС идентичны. В ходе установки пользователю требуется выбрать INI файл АРМа Читатель(для ИРБИС 32) или INI файл сервера(для ИРБИС 64),INI файл полнотекстового читателя(если приобретена полнотектстовая функция) и указать директории CGI, HTTPDOCS. 1 Здесь и далее XX означает номер версии WEB ИРБИС. Например: 91. 2 Здесь и далее YY означает поколение системы: 32 или 64. Рисунок 1 Дополнительно инсталлятор запрашивает адрес сервера и e-mail администратора. Рисунок 2 Указание адреса сервера обязательно, так как в дальнейшем эта информация будет подставляться во всех ссылках внутри фреймов и форматов вместо директивы < --CGI_PATH-->. В условиях, когда указание абсолютного адреса нежелательно, можно ввести в адресную строку слеш «/». Тогда WEB ИРБИС будет доступен как по запросу: http://localhost/irbis64r_01, так и по запросу http://library_name.ru/irbis64r_01/ Поле «Показ ссылок на электронные документы» будет определять, каким категориям пользователей будут доступны электронные коллекции. Рисунок 3 Пользователю заранее предлагается определить базы, которые будут видны в WEB ИРБИС. Следует исключить из списка технологические базы. Рисунок 4 Пользователю предлагается определить поисковые нужные поисковые режимы. Например, если библиотек не планирует выступать центром корпорации, она должна отключить режим Распределённого поиска. Инсталлятор WEB ИРБИС создаёт новые базы и дополняет технологическим обеспечением существующие. RSUDC – есть в системе ИРБИС. По умолчанию содержит несколько верхних рубрик УДК. HELP – есть в системе ИРБИС. В дистрибутив WEB ИРБИС включена особым образом проиндексированная полная версия ГРНТИ. RDRV – нет в системе ИРБИС. Аналог базы Читателей RDR. Предназначена для записи удаленного читателя. LOGDB – нет в системе ИРБИС. База данных статистики шлюза. RSBBK– есть в системе ИРБИС последних версий, но не включает никаких данных. MESH– нет в стандартной версии ИРБИС. По умолчан ию содержит несколько верхних рубрик MESH. В архиве webirbis эти файлы лежат в директории irbis. Папка [CGI каталог сервера]\[параметр CgiPath установочного INI] является основной для сервера. Здесь располагается главный INI файл системы(irbis_server.ini или irbis32.ini), файл сообщений(WebMSG.txt), файл индикации ошибки(error.html), файлы шаблонов (base_img_template.ini, base_ft_template.ini, base_template.ini), и, по умолчанию, папки frames и deposit Папки [параметр DepositName установочного INI] и [параметр FramesPath установочного INI] по умолчанию создаются в папке CgiPath. Они содержат основные ресурсы, используемые при работе WEB ИРБИС. Папка [HTDOCS сервера ]\[параметр HtdocsPath установочного INI] содержит документацию системы, рисунки, скрипты и другие вспомогательные файлы. В полную версию WEB ИРБИС включён Z39 клиент и сервер. Z39 клиент устанавливается в папку [CgiPath]\Z3950, Z32 сервер в [основная директория ИРБИС32] \Z3950(для ИРБИС 32) или директорию ИРБИС-сервера(для ИРБИС 64). Для работы предварительного заказа литературы, сбора статистики и регистрации читателей шлюзу требуются права на запись в базы RQST, RDRV, LOGDB. Для протоколирования текущих операций шлюз должен иметь право на запись в директорию CGI. Общий обзор работы шлюза WEB ИРБИС Последовательность операций по обработке пользовательского запроса можно представить состоящей из нескольких этапов: 1. Предпроцессинг 2. Выполнение команды пользователя 3. Объединение и обработка фреймов Полная последовательность операция шлюза такова: 1. Чтение параметров INI файла 2. Предпроцессинг a. Формальный контроль правильности параметров b. Интерпретация поискового запроса c. Авторизация d. Выполнение скрипта защиты e. Повторная авторизация 3. Выполнение поиска 4. Формирование ответа 5. Определение HTTP заголовков на основе INI файла 6. Возврат ответа. В случае возникновения ошибки выполнения или превышения времени обработки запроса, шлюз возвращает ошибку(error.html) Предпроцессинг WEB ИРБИС Скрипт-защита Формат скрипта защиты выполняет две функции: 1) проверку поступивших параме тров запроса и защиту от взлома 2) обработку и дополнение параметров. Первая строка, сформированная форматом срипт -защиты, определяет общий результат – если это 0 или файлом не было возвращено никаких значений – скрипт-защита определила ошибку, если результат 1 или файлом были возвращены другие ненулевые значения – ошибки нет. В первом случае шлюз возвращает error.html, в последнем случае шлюз читает остальные строки формата и изменяет параметры запроса на новые. Например, строка ‘SCRIPT_DONE=YES’/ зада ёт параметру SCRIPT_DONE значение YES. Авторизация пользователя Авторизация даёт возможность редактировать корзину заказов. заказывать литературу, просматривать формуляр и Для авторизации используется база RDR. Авторизация происходит по идентификатору и, если в пользовательском запросе задан параметр Z21FLAGID=1, – по фамилии. После авторизации шлюз выполняет шифрование идентификатора, и зашифрованный идентификатор передаётся при переходе по страницам. Команды WEB ИРБИС Принципы выполнения команд WEB ИРБИС Текущая команда WEB ИРБИС задаётся значением параметра С21 COM. Как и названия параметров, она должна вводиться в верхнем регистре. По заданной команде обычно читается последовательность фреймов из секции [значение параметра I21DBN] INI файла WEB ИРБИС. Но возможен так же вывод произвольного фрейма, название которого задано в параметр S21FRAME с использованием произвольной базы указанный в параметре I21DBN. Ниже приводится список соответствий команды последовательность фреймов. В скобках - значение C21COM. и параметра, определяющего 1. ShowFrames – команда “показ”(F). 2. SearchFrames - команда выполнения и показа результатов поиска - “поиск”(S). 3. DictionryFrames - команда показа терминов словаря - “словарь”(T). 4. ZakazFrames - команда отбора записей в корзину з аказов - “заказ”(Z) 5. RecUpdateFrames - команда редактуры записей- “запись” (R) Команды выгрузки записей – «экспорт»(E), чтения внешнего файла – «файл»(2), заимствования записи – «скачать»(4), выгрузки двоичного объекта – «интегрированный файл» (3), удалённого поиска «количество найденных»(G) не требуют задания последовательности фреймов, так как шлюз выдает в результате своей работы не HTML страницу. Важно отметить, что во всех случаях одновременно WEB ИРБИС может выполнить только одну команду. Команда вывода HTML страницы - “показ”(F) Команда F обычно используется для показа поисковых форм и, как правило, в ней задействованы лишь основные параметры: C21COM, I21DBN, P21DBN, Z21DBN. Но при наличии запроса(S21ALL) она работает полностью аналогично команде S Пример запроса для показа страницы расширенного поиска: http://127.0.0.1/cgi-bin/irbis64r_01/cgiirbis_64.exe?C21COM=F&I21DBN=IBIS_EX&P21DBN=IBIS Образец кода, формирующего запрос: dbname.frm Команда поиска - “поиск”(S) Команда S обычно используется для показа результатов поиска. В ней могут одновременно применяться поиск по словарю, последовательный поиск(по элементам, которые не индексируются) и полнотекстовый поиск с ранжированием. Задание на поиск по словарю обычно формируется из набора поименованных параметров *S21P*** 1. *S21STR – поисковый элемент; 2. *S21LOG – логика объединения слов из поискового элемента между собой; 3. *S21P01 – способ разбиения поискового элемента S21STR; 4. *S21P02 – необходимость применения правого усечения; 5. *S21P03 – префикс словаря; 6. *S21P04 – квалификатор; 7. *S21P05 – не используется 8. *S21P06, S21P07 – границы поиска по диапазону терминов словаря Пример поискового запроса, по ключевому слову «история» http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?I21DBN=IBIS&P21DBN=IBIS&S21STN=1&S21REF=3&S21FMT=ful lwebr&C21COM=S&S21CNR=20&S21P01=0&S21P02=0&S21LOG=1&S21P03=K=&S21STR=истори я Образец кода, формирующего запрос: fullwebr.pft Уже в скрипте защиты заданный таким образом поисковый запрос преобра зуется к запросу на языке ИРБИС и доступен в виртуальном поле, соответствующем параметру S21ALL(по умолчанию 2226). При наличии в запросе как параметров *S21**, так и запроса S21ALL происходит их объединение логикой, определённой S21LOG. Последовательный поиск задается параметрами(в скобках указаны метки по умолчанию): 1. S21SCAN_FULL – определяет необходимость полного сканирования базы. 2. S21SCAN(1013) – определяет файл с поисковым форматом Пример поискового запроса на последовательный поиск в базе RQST с использованием формата basket: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?C21COM=S&I21DBN=RQST&S21SCAN=basket&S21SCAN_FULL=1 &S21FMT=RQST_WEB&Z21ID=4444&P21DBN=IBIS Образец кода, формирующего запрос: author_3.frm При наличии поискового запроса по словарю, установке S21SCAN_FULL=0 и указании значения S21SCAN вначале выполняется поиск по словарю, а затем последовательный поиск. Полнотекстовый поиск определяется двумя основными параметрами(в скобках указаны метки по умолчанию): 1. FT_REQUEST(3335) – запрос в произвольной форме 2. FT_PREFIX(3337) – префикс словаря Пример полнотекстового поискового запроса на фразу «история России» http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?C21COM=S&I21DBN=IBIS&P21DBN=IBIS&S21STN=1&S21CNR=2 0&FT_REQUEST=история россии&FT_PREFIX=K= При объединении поиска по словарю и полнотекстового поиска сначала выполняется полнотекстовый поиск, а поиск по словарю и последовательный поиск используется для уточнения результатов. Более подробное описание всех поисковых параметров приведено в Приложении 1. Команда показа терминов словаря - “словарь”(T) Команда T выводит диапазон терминов сло варя и форматирует их согласно формату(по умолчанию – web_dic.pft). При этом применяются параметры: 1. T21TRM(2229) – начальный термин словаря 2. T21PRF(2228) – префикс словаря 3. T21CNR(1012) – количество выводимых терминов словаря При наличии запроса S21ALL найденными по запросу S21ALL. выводятся только термины, связанные с документами, Пример запроса на вывод 20 терминов словаря начиная с буквы А: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?C21COM=T&I21DBN=IBIS_EX&P21DBN=IBIS&T21TRM=A&T21P RF=K=&T21CNR=20 Образец кода, генерирующего запрос: alfabet.pft Команда предварительного заказа - “заказ”(Z) Предварительные заказы на книги формируются WEB ИРБИС точно так же, как и ARMом Читатель. Заказы отражаются в АРМе Книговыдачи и могут быть удалены пользователем WEB ИРБИС через режим “Корзина заказов”(в форме авторизаци). Пример запроса на предварительный заказ литературы: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?Z21ID=1&P21DBN=IBIS&I21DBN=IBIS_ZAKAZ&C21COM=Z&Z21 MFN=58 Команда изменения записей- “запись” (R) Команда записи в базовом комплекте используется только для регистрации пользователей в базе RDRV. Она выполняется только при условии авторизации. В случае неавторизированного доступа или возникновения других проблем команда возвращает ошибку в поле, определяемом параметром RecUpdateResultTag(по умолчанию 1101) Для записи используются параметры: 1. RN_R21MFN – номер записи 2. RN_R21NUMХX – метка поля 3. RN_R21SUBXX_YY – разделитель подполя(латинская буква). Необязательный параметр 4. RN_R21VOLXX_YY – значение подполя Команда позволяет одновременно выполнять операции с несколькими записями одной базы. Группы команд для каждой из записей должны иметь общий префикc(RI_), но если работа выполняется только с одной записью, то префикс может не использоваться. Для каждой записи задается набор изменяемых меток полей и подполей (если есть). Группа параметров, связанных с одной меткой поля в базе данных должны иметь общий порядковый суффикс( XX). Группа параметров, определяющих метку и содержание подполя должна иметь вторичный порядковый суффикс(YY). При задании поля целиком это всегда 1. При пропуске очередного порядкового суффикса(например 10 – 12…) система прерывает чтение параметров. То есть параметры R21NUM... перечисляют поля в строгом порядке - от 1 до N, где N порядковый номер последнего поля. Значения полей при этом могут отсутствовать. Пример запроса на создание новой записи и доба вление в 1000 строки XXXXX: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?C21COM=R&P21DBN=IBIS&I21 DBN=IBIS_REC&Z21ID=444&R21 MFN=0&R21NUM1=1000&R21VOL1=XXXXX Образец кода, генерирующего запрос: Reg.frm Команда выгрузки записей - “экспорт” (E) Команда экспорта предполагает авторизацию заимствующего в секции базы данных. и установку разрешения для IP адреса Экспорт осуществляется для множества записей, найденных поисковым запросом. Поэтому для данного режима полностью применим весь синтаксис команды «Поиск»( S). Но в этой команде используются и специфические параметры, определяющие представление результа та: 1. EXP21FMT – представление записи(может принимать значения: ISO или TEXT) 2. EXP21CODE – выходная кодировка(может принимать значения: UTF-8, WIN, DOS) 3. EXP21FST – таблица переформатирования( значение – файл FST) Крайне важно, что при экспорте в формат ISO 270 9 все поля с меткой больше 999 переносятся в поле 998. Это обусловлено тем, что данный формат не поддерживает четырёхзначных меток. Пример команды на экспорт первых 20 записей, найденных по запросу <.>K=история России<.> в текстовом представлении, кодиро вке UTF8 и формате ИРБИС: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?I21DBN=IBIS&P21DBN=IBIS&S21STN=1&C21COM=E&S21CNR=2 0&S21ALL=(<.>K=история России<.>)&EXP21FMT=TEXT Команда заимствования записи - “скачать” (4) Команда используется для заимствования записей в АРМ Каталогизатор. Как и команда экспорта, она предполагает авторизацию и разрешение на заимствование в секции INI файле, соответствующей нужной базе. Кроме того, ссылка на скачивание генерируется только на основании поля 112 записи авторизованного читателя, где так же должны быть перечислены маски или конкретные IP допустимых клиентов. Для команды действуют те же правила и те же параметры, что и в команде экспорта, но есть и один оригинальный параметр: EXP21MFN – номер скачиваемой записи. С помощью этой команды возможна выгрузка только одной запис и. Пример команды на выгрузку записи №100 в ISO представлении и кодировке UTF8: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?I21DBN=IBIS&P21DBN=IBIS&C21COM=4& EXP21MFN=100&EXP 21FMT=ISO Команда чтения внешнего файла - “файл”(2) Команда чтения внешнего ресурса используется для получения файлов, ссылки на кот орые приведены в поле 951. Команда использует параметры: 1. IMAGE_FILE_NAME – полный или относительный путь к файлу; 2. IMAGE_FILE_MFN – номер записи в случае, если файл лежит в архиве полнотекстовой базы данных; 3. IMAGE_FILE_DOWNLOAD – флаг, заставляющий браузер не открыть скачанный файл, а вызвать диалог с предложением открыть или сохранить его на диск. По умолчанию 0. Для выгрузки HTML файлов с картинками используется файл соответствий локальных и сетевых адресов к файлам webdirs.mnu В параметре IMAGE_FILE_NAME могут быть имена файлов, полные или относительные адреса. Тем не менее, использование абсолютных произвольных адресов является небезопасным, так как это позволяет выгружать с сервера любые файлы. Поэтому настоятельно рекомендуется ограничить их возможный диапазон, установив в INI файле WEB ИРБИС параметр Safe_File_Download=1 и перечислив через точку с запятой допустимые пути расположения файлов в параметре Safe_File_Paths. Например: Safe_File_Download=1 Safe_File_Paths=C:\irbis\datai\books\files;C:\web\images\ В случае если в параметре IMAGE_FILE_NAME указан относительный путь или имя файла, к нему будет добавляться нужный путь из Safe_File_Paths. Если указан абсолютный путь, то он принимается только тогда когда соответствует одному из путей Safe_File_P aths. Пример выгрузки записи №100 в формате ISO и кодировке UTF -8: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?Z21ID=4444&P21DBN=IBIS&I21DBN=IBIS&C21COM=2& IMAGE_ FILE_NAME=image.jpg&IMAGE_FILE_DOWNLOAD=1 Образец кода, генерирующего запрос на выгрузку файла: fullwebr.pft Команда чтения внутреннего двоичного объекта из библиографической записи – «интегрированный файл»(3) Команда показа внутренних двоичных ресурсов библиографической записи работает только в ИРБИС 64. Она использует параметры: BINARY_RESOURCE_MFN - номер записи BINARY_RESOURCE_OCC - номер повторения Пример выгрузки внутреннего ресурса записи №100 из повторения 1 http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?C21COM=3&I21DBN=IBIS&P21DBN=IBIS&BINARY_RESOURCE_ OCC=1&BINARY_RESOURCE_MFN=100 Команда получения количества найденных документов в удалённой базе – «количество найденных»(G) Команда используется при распределённом поиске по ИРБИС -корпорации. По своему синтаксису она полностью аналогична команде S, но возвращает не на йденные записи, а лишь строку RESULT=[количество найденных записей]. Она может применяться в форматах, в функции &unifor(‘+3G[запрос к удалённой БД]’), что позволяет легко узнать количество найденных записей и вывести его в формат или фрейм. Пример запроса по ключевому слову «история»: http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?I21DBN=IBIS&P21DBN=IBIS&C21COM= G&S21ALL=<.>K=истори я<.> Обработка фреймов Правила объединения фреймов Результат выполнения текущей команды(поиска, например), как правило «обрамляется» набором фреймов. Этот набор фреймов берётся из секции, соответствующей псевдониму базы(параметр I21DBN) и параметра соответствующего текущей команде. Но возможен так же вывод произвольного фрейма, название которого задано в параметр S21FRAME с использованием произвольной базы указанный в параметре I21DBN. Эта опция должна быть активирована параметром DirectAcess=1 в секции [MAIN] INI файла WEB ИРБИС. Директивы фреймов Директивы фреймов могут использоваться в дополнение к HTML тегам при формировании WEB ИРБИС ответа. В большинстве случаев предполагается, что на одной строке фрейма находится только одна команда. Все команды выполняются в следующем приоритете: 1. Директивы вставки формата 2. Директивы вставки файла(фрейма) 3. Директивы вставки PHP 4. Директивы вставки системных значений Таким образом, обеспечивается, например, возможность генерировать в формате команду вставки файла. Директивы вставки системных значений Шлюз выполняет специальные команды замены (вставки) значений во фреймы <--HTTP_PATH--> – путь к директории HTTP DOCS WEB ИРБИС. Соответствует параметру HTTP_PATH INI файла WEB ИРБИС <--CGI_PATH--> – путь к CGI WEB ИРБИС. Соответствует значению параметра CGI_ALIAS INI файла WEB ИРБИС <--TIME--> – текущее время <--MAXIMUMMFN--> –максимальный MFN базы данных <--RUNTIMEPID--> – по умолчанию– идентификатор читателя. Присваивается при авторизации. Соответствует метке ReaderIDTag (1002). <--DATABASE--> –имя базы данных <--MFNCOUNT--> – порция выдаваемых записей <--MFN--> – MFN текущей форматируемой записи < --DB-- > – имя текущей базы данных <--TOTALRECS--> – количество найденных записей <--BEGINRECS-->– стартовый номер при показе записей <--ENDRECS--> – конечный номер при показе записи Директивы вставки файла Каждый фрейм может включать в себя ссылки на другие файлы и фреймы, который должны быть в него вставлены. <!FILE=[имя файла]> Поиск файла происходит в директории текущей базы данных, а затем в папках с фреймами . Директивы вставки формата Формат может добавляться в тело фрейма с помощью обрамления короткими PHP тегами(<? И ?>) или в конструкции <!FORMAT=> Все форматы, выводящие не латинские символы должны начинаться с восклицательного знака. Это обеспечивает их перекодировку в UTF8. Применение коротких тегов в стиле PHP тегов позволяет расположить формат в произвольной части строки. Пример задания значения по умолчанию для параметра P21DBN(значение поля 3331): <input type="hidden"name="P21DBN" value="<? v3331 ?>" > Кроме того, формат может быть многострочным. Пример многострочного конструкций: представления формата с выравниванием логических <? if v2221='URUB' then else '<a href=','"','<--CGI_PATH->?C21COM=F&I21DBN=URUB&S21FMT=WEB_URUB0_WN&S21All=<.>U=<.>&S21CNR=30', '&P21DBN=',v3331, ’&Z21ID=',&uf('+3E',v2225), (if v3413<>'' then '&R21DBN=',v3413 else break fi), '">Тезаурус</a>' fi ?> Директивы <!FORMAT= может располагаться только с новой строчки и перед ней могут находиться только символы пробела или табуляции. Синтаксис директивы формат таков: <!FORMAT=[строка формата] > или <!FORMAT=@[имя файла] > Пример вставки формата referings: <!FORMAT=@referings> Кроме того, директива <!FORMAT=INSERT_ALL_PARAMETERS> формат может выполнять вставку всех параметров в виде скрытых полей: <input type="hidden" name="PARAM1_NAME" value="PARAM1_VALUE"> <input type="hidden" name="PARAM2_NAME" value="PARAM2_VALUE"> .............. В ссылке тот же результат может быть достигнут с помощью директивы: <!FORMAT=INSERT_ALL_PARAMETERS_IN_QUERY> Результатом будет ссылка: PARAM1_NAME=PARAM1_VALUE&PARAM_NAME2=PARAM2_VALUE. . . . . . . . . Директивы вызова внешнего скрипта Директива использует синтаксис: <!PHP=IP=[IP адрес]:[порт],[URL]> Если IP не задан используются параметры по умолчанию из секции [ PHP] DefaultServerPORT и DefaultServerIP. Параметры передаются строкой URI GET. Адрес и порт се рвера могут отличаться от строки URL. В этом случае перед URL должна стоять строка IP=IP_ADDRESS:IP_PORT. Например: <!PHP=IP=127.0.0.1:8080,http://www.bibl.ru/irbis64r/php/echo.php?PAR1=1&PAR2=2...> Директива вставки результата выполнения текущей команды Директива <!RESULT> идентична команде RESULT в перечне фреймов, INI файла. Она выполняет текущую команду и выводит вместо себя результаты поиска или системные сообщения. Это освобождает от необходимости разбивки фреймов на 2 части и повышает наглядность кода. Директивы отмены раскраски найденных терминов Искомый фрагмент в результатах поиска выделяется цветом путём обрамления парными тегами. В тех случаях, когда это недопустимо и требуется сохранить термины в неизменной форме(в ссылках, например) целесообразно использовать директивы <!>.При этом раскраски не происходит. Директива работает в форматах вывода. ( fullwebr.pft, например) Учебный анализ режимов WEB ИРБИС3 Базовые фреймы Верхняя часть(шапка) генерируемой страницы – header_1.frm из директории frames_r*\Default 4.В неё включаются блоки с другими фреймами и форматами(выделены комментариями): 1. <!-- Форма авторизации --> Определяется согласно формату <? if (v2225='') then '<!FILE=Not_author_3.frm>' else '<!FILE=author_3.frm>' fi ?> 2. <!-- Место для баннера --> – место для вставки заголовка или рисунка с символикой библиотеки 3. <!--Заголовок основной таблицы--> – вставка заголовка основной таблицы с именем текущей базы данных и вида поиска. Выполняется директивой <! FORMAT=@search_result> 4. <!--Навигация по базам данных--> - вставка меню выбора текущей базы данных. Выполняется директивой <!FORMAT=@web_mnu> Заключительная форма – файл footer_7.frm из директории frames_r*\Default. Cодержит меню выбора вида поиска. Фреймы стандартного вида поиска Вид поиска определяется секцией [НАЗВАНИЕ ТЕКУЩЕЙ БД] INI файла и собирается командой: ShowFrames=header_1.frm, standart_search_form.frm,footer_7.frm Файл standart_search_form.frm содержит формат для показа таблицы поиска новых поступлений: Файл search_search.frm содержит форматы: <!FORMAT=@search_mnu1> - искать то же самое в других базах данных. Формат показывает ссылки на другие базы данных, если в них есть документы по текущему запросу. <!FORMAT=@sort_mnu> - сортировка найденных(осуществляется для количества зап исей, не превышающее значение MAX_SORT_COUNT. По умолчанию – 1000 записей). Если необходимо изменить максимальное число сортируемых записей, следует также изменить этот формат. В начале формата проверка на число найденных записей в строке if (val(v1001)>1 ) and (val(v1001)<1000) then… Существует возможность SORT_HEADERS_PRINT=1. печати заголовков сортировки. Включается параметром Пример файла сортировки с выводом заголовков – сортировка по году: god_hdr.srw Пример файла сортировки с без вывода заголовков – сортировка по году: god.srw В зависимости от успеха поиска(val(v1001) > 0) вставляется соответствующий фрейм: Все указанные здесь названия фреймов, технологии и пути выступают лишь как иллюстрации и могут быть изменены в новых версиях системы. 3 Символ * обозначает здесь суффикс расширения из ини файла установщика дистрибутива WebIrbis.ini. 4 <? if val(v1001) > 0 then '<!FILE=insert_search_results.frm>' else '<!FILE=insert_search_results_empty.frm>' fi ?> Фреймы режима поиска по словрю Вид поиска определяется секцией [НАЗВАНИЕ ТЕКУЩЕЙ БД_ EX] INI файла и собирается командой: DictionryFrames=header_1.frm, header_dict.frm, RESULT, footer_dict.frm, footer_7.frm Файл header_dict.frm содержит форматы: <!FORMAT=@dic_Web> - вставка меню выбора вида словаря <!FORMAT=@alfabet> - вставка английского алфавита в виде набора поисковых ссылок по словарю <!FORMAT=@alfabet_rus> - вставка русского алфавита в виде набора поисковых ссылок по словарю Термины словаря отображаются согласно DICT_FORMAT=web_dict в INI файле WEB ИРБИС. формату, зада нному параметром Файл footer_dict.frm обеспечивает показ формы навигации по словарю по заданному ключу. Фреймы режима поиска по навигатору ГРНТИ Вид поиска определяется секцией [ HELP] INI файла и собирается командой: ShowFrames=header_1.frm, grnti_search_form.frm,RESULT,footer_grnti.frm,footer_7.frm Файлы grnti_search_form.frm frames_r*\Search_forms. и footer_grnti.frm располагаются в директории Рубрики отображает файл: web_rub_wn.pft Файл footer_grnti.frm включает форму для поиска в ГРНТИ по ключевым словам. Настройка основных функций WEB ИРБИС Замена названия библиотеки после установки Для изменения названия библиотеки требуется изменить параметр LIB_NAME в INI файле WEB ИРБИС. Для размещения в этой области графического баннера его код следует помещать между комментариями <!-- Место для баннера --> в файле header_1.frm Настройка функции авторизации Для отключения авторизации требуется удалить из файла header_1.frm фрагмент: <!-- Форма авторизации --> <?if (v2225='') then '<!FILE=Not_author_3.frm>' else '<!FILE=author_3.frm>' fi?> <!-- Форма авторизации --> Настройка функции регистрации пользователя Чтобы обеспечить корректную работу функции регистрации необходимо: 1) Добавить в файлы dbnam1.mnu,dbnam2.mnu базу RDRV и убедиться, что она открывается из АРМов Каталогизатор и Администратор; 2) Открыть файл default\virtual_rdr.frm 3) Найти там фрагмент &Z21ID=111 и заменить 111 на идентификатор любого читателя из базы RDR В том случае если регистрация предполагается с компьютеров библиотеки необходимо удалить из файла deposit_01\virtual_rdr.pft строки if val(&unifor('+3JRDRV,URL=',v1100))<=0 then …….. fi, Включение учёта статистики посещений Введение Средства ежедневной статистики WEB ИРБИС предполагают ведение дополнительной базы данных и предъявляют высокие требования к аппаратному обеспечению. Настройка функции статистики требует чёткого понимания механизма её работы и достаточной квалификации для учёта возможных последствий применения. Поэтому необходимость учёта статистики самостоятельно определяется пользователем. В WEB ИРБИС может использоваться краткая и полная форма вывода статистических данных. Эти формы применяют один и тот же набор данных базы LOGDB, но по-разному отображают его. Краткая форма постоянно выводится на правой навигационной панели. Полная форма отображается в центральной части сайта и только при выборе на правой навигационной панели пункта меню «Статистика обращений». Краткая форма содержит показатели: 1. Число запросов; 2. Число посетителей; 3. Число заказов. Полная форма содержит показатели: 1. Запросов всего; 2. Запросов в каждой базе электронного каталога; 3. Статистика по видам поиска; 4. Общее число посетителей; 5. Число посетителей из интранета; 6. Число пользователей каждой базы каталога; 7. Число заимствований записей. Поскольку подсчёт показателей с помощью полной формы статистики выполняется только по запросу читателя, она в меньшей степени снижает производительность системы и более предпочтительна. Включение режима ведения статистики Способы работы с базой статистики определяются рядом параметров в секции [MAIN] INI файла WEB ИРБИС. Ведение статистики включается раскомментированием или добавлением параметра: LogDateBase=LOGDB Он указывает, что система должна записывать запросы в базу LOGDB. Поскольку переполнение базы LOGDB может крайне негативно отразиться на состоянии системы, пользователю предлагается ежедневно опустошать базу статистики и экспортировать её содержимое в файлы CSV, легко интерпретируемые в Excel. Необходимость ежедневного экспорта данных включается параметром: EveryDayEmtyLogDB=1 Название файла параметром: формата, согласно которому должен создаваться отчёт определяется EveryDayEmtyLogDB_Format=otchet Название формата отчёта определяется параметром: EveryDayEmtyLogDB_Report=otchet.csv После установки параметров INI файла требуется небиблиографическую базу LOGDB и скопировать Addins\Statistic\logdb создать в АРМе Администратор в неё все файлы из папки Подключение краткой формы статистики Для подключения краткой формы статистики тр ебуется: 1. Скопировать файлы из папки Addins\Statistic\Shot Stat Files\Logdb в одноимённую папку базы. 2. Раскомментировать ссылку на статистическую форму в файле footer_7.frm (удалить один восклицательный знак в конструкции <!!FILE=stat.frm>) Подключение полной формы статистики Для подключения полной формы статистики требуется: 1. Скопировать файлы из папки Addins\Statistic\Full Stat Files\Logdb в одноимённую папку базы. 2. Раскомментировать( удалить deposit\search_modes.pft обрамляющие их ‘<!—‘ и ‘-->’) строки в файле Распределённый поиск и заимствование(корпоративные функции) Распределённый поиск ориентирован на заимствование записей из АРМ Каталогизатор. Он даёт конечным пользователям возможность отправить поисковый запрос нескольким веб -шлюзам Ирбис, взаимодействуя непосредственно только с одним веб -шлюзом Ирбис. Если на удалённых веб-шлюзах активирована функция экспорта, их каталоги могут служить в качестве источника для заимствования записей Схема работы веб-шлюзов Ирбис в режиме распределённого поиска Возможность распределённого поиска подразумевает наличие группы веб -шлюзов, среди которых возможен распределённый поиск. Пример такой группы - Ирбис корпорация. Среди этой группы веб-шлюзов один выступает в роли основного шлюза. Основной шлюз – это шлюз, принимающий запросы от конечных пользователей в режиме распределённого поиска. Шлюзы участников – все остальные шлюзы из указанной группы веб -шлюзов. Получив запрос в режиме распределённого поиска от конечного пользователя, основной шлюз передаёт поисковый запрос на шлюзы участников, получает от них ответы и выдаёт обобщённый результат конечному пользователю. ВКонечный пользователь может осуществлять распределённый поиск среди всех веб-шлюзов Ирбис, входящих в группу, или выбрать только некоторые шлюзы участников. При этом на основном шлюзе поиск будет производиться в любом случае. Подразделение шлюзов на основной и шлюзы участников является условным. Основной шлюз и шлюзы участников - это только роли, в которых шлюзы выступают при обработке конкретного запроса. Один и тот же шлюз при обработке разных запросов может выступать то в качестве основного, то в качестве шлюза участника. Настройка WEB ИРБИС как шлюза участника Заимствование записей из WEB ИРБИС разрешено(под записью появляется гиперссылка Скачать), если в базе читателей RDR присутствует запись c идентификатором 4444 и IP адресом допустимого клиента в поле 112. При этом IP может указываться как полностью(192.168.1.10), так и через абсолютную маску(*.*.*.*). Разрешение заимствования записей из конкретной ба зы данных даётся в INI файле WEB ИРБИС в секции профиля базы данных (по умолчанию это [IBIS]). Значением параметра может быть IP допустимого клиента или абсолютная маска: *.*.*.*=1 или 192.168.1.11=1 Настройка WEB ИРБИС как основного шлюза Информация о библиотеках-источниках должна быть внесена в файлы deposit_YY\dbn_web_remote_html.mnu и deposit_YY \ dbn_web_remote.mnu (YY -- номер версии) Ключ справочника dbn_web_remote.mnu содержит название используемой базы и через пробел адрес CGI(для WEB ИРБИС) или сайта(для J-ИРБИС). Значение содержит HTML гиперссылку на сайт библиотеки-пользователя. Например, для библиотеки использующей WEB ИРБИС это могут быть строки: IBIS http://irabis.irklib.ru:8080/Scripts/irbis64r_61/cgiirbis_64.exe <a href="http://irabis.irklib.ru:8080/Scripts/irbis64r_61/cgiirbis_64.exe?C21COM=F&I21DBN=IBIS &P21DBN=IBIS&S21CNR=20&Z21ID=">Иркутская ОГУНБ</a> Для библиотеки использующей J-ИРБИС: IBIS http://library.pgups.ru/jirbis <a href="http://library.pgups.ru/jirbis/index.php?option=com_irbis &Itemid=300">Петербургский университет путей сообщения</a> Ключ справочника dbn_web_remote_html.mnu должен быть идентичен dbn_web_remote.mnu, а значение содержать только полное название библиотеки. ключу Например, для библиотеки, использующей WEB ИРБИС это может быть строка: IBIS http://irabis.irklib.ru:8080/Scripts/irbis64r_61/cgiirbis_64.exe Иркутская ОГУНБ Для библиотеки, использующей J-ИРБИС IBIS http://library.pgups.ru/jirbis Петербургский университет путей сообщения Настройка АРМа Каталогизатор Для отображения интерфейса распределённого поиска в АРМе Каталогизатор ссылка на него должна присутствовать в файле IRBIS64 \webirbis.mnu (для ИРБИС 64) или IRBIS \webirbis.mnu (для ИРБИС 32). Первой строкой файла должна быть ссылка, второй — пояснение. http://127.0.0.1/cgibin/irbis64r_01/cgiirbis_64.exe?C21COM=F&I21DBN=TEST&P21DBN=TEST&Z21ID=4444 Пример ссылки на базу данных1 http://library.ru/cgibin/irbis64r_01/cgiirbis_64.exe?C21COM=F&I21DBN=IBIS&P21DBN=IBIS&Z21ID=4444 Пример ссылки на базу данных2 Предполагается, что это должен быть веб-шлюз Ирбис, выступающий в роли основного в группе веб-шлюзов, предоставляющих распределённый поиск. Для настройки шлюза в качестве участника Ирбис корпорации не требуется вносить никаких изменений в этот файл. Тем не м енее, для обеспечения возможности выгрузки записей обязательно требуется наличие параметра Z21ID с указанием пароля. Например: Z21ID=4444 Настройка функции выгрузки файлов В том случае, если путь к файлу указан в подполе 951^ I, предполагается выгрузка файла без участия программы. Если путь указан в подполе v951^A, файл будет выгружаться через CGI. В первом случае необходимо следить, чтобы путь из подполя 951^a, будучи введён в браузер позволял открыть файл. Во втором необходимо параметрировать выгрузку так, как описано ниже. Для изменения режима просмотра ссылок на полные тексты после установки WEB ИРБИС следует использовать параметр INI файла show_ed. Он может принимать значения: 0 — гиперссылки демонстрируются всем пользователям 1 — гиперссылки демонстрируются только авторизованным пользователям 2 — гиперссылки не выводятся вообще Для выгрузки HTML файлов с графикой используется файл соответствий локальных и сетевых адресов к файлам webdirs.mnu В связи с тем, что WEB ИРБИС может выгрузить любой файл на жестком диске пользователя необходимо обязательно применять ограничение доступных адресов. Поэтому рекомендуется ограничить их возможный диапазон, установив в INI файле WEB ИРБИС параметр Safe_File_Download=1 и перечислив через точку с запятой допустимы е пути расположения файлов в параметре Safe_File_Paths. Например: Safe_File_Download=1 Safe_File_Paths=C:\irbis\datai\books\files;C:\web\images\ В случае если в v951^A указан относительный путь или имя файла, к нему будет добавляться нужный путь из Safe_File_Paths. Если указан абсолютный путь, то он принимается только тогда когда соответствует одному из путей Safe_File_Paths. Добавление и сокрытие библиографических баз После установки WEB ИРБИС в интерфейсе отображается тот же перечень баз, который доступен в АРМе Читатель. При создании новой базы доступной в АРМе Администратор с опций «Доступна WEB ИРБИС», база так же становится видимой в WEB ИРБИС. Чтобы скрыть базу данных от пользователей WEB ИРБИС требуется удалить её данные из файла dbn_web.mnu. Чтобы вручную подключить новые базы: 1. Добавить в INI WEB ИРБИС содержимое файла шаблона секций базы(base_template.ini — для обычных библиографических баз, base_ft_template.ini — для полнотекстовых баз, base_img_template.ini — для баз имиджкаталога) Затем следует заменить метку {basename} на название базы и {frames_path} на путь к фреймам(по аналогии с путём к фремам секции [IBIS]; 2. Добавить названия новых баз в файл deposit_XX \dbn_web.mnu. Сокрытие неиспользуемых поисковых режимов 5 Скрыть или добавить поисковый режим можно путём установки соответствующего ему параметра в INI файле WEB ИРБИС в 1(для включения) и 0(для выключения) 1. Стандартнй режим: mstd 2. Расширенный режим: mext 3. Профессиональный режим: mprof 4. Распределённый режим: mraspr 5. Поиск по словарю: mdic 6. Поиск по УДК: mudk 7. Поиск по ББК: mbbk 8. Поиск по ГРНТИ: mgrnti 9. Поиск по тематическому рубрикатору: msubj Настройка функции предварительного заказа Функция предварительного заказа работает только при установке параметра Show_order в INI файле WEB ИРБИС. Для читателя предварительный заказ литературы возможен только при соблюдении двух условий: 1) Отделы хранения заказываемого deposit_XX\mhr_web.mnu; 2) Есть свободные экземпляры издания; издания указаны в справочнике Возможна ситуация, когда места хранения не совпадают с местами выдачи. В этом случае необходимо отредактировать файлы Kv.mnu, mhrkv.mnu Файл kv.mnu должен содержать аббревиатуры и полные названия кафедр выдачи. Его структура аналогична структуре файла mhr_web.mnu. Файл mhrkv.mnu должен иметь структуру: <Место хранения> <Соответствующая месту хранения кафедра выдачи> Изменение цветовой схемы WEB ИРБИС Для адаптации цветовой схемы WEB ИРБИС к общему дизайну сайта следует редактировать файл style.css Все цвета в нём определяются шестизначным шестнадцатеричным числом перед которым находится символ # Например, цвет фона меню с перечнем баз данных определяется: background-color: #99CCFF; Чтобы определить шестнадцатиричный код, соответствующий воспользоваться программами: Front Page, Home Page и другими. цвету можно Перевод WEB ИРБИС на национальный язык При переводе следует руководствоваться простым правилом: все русскоязычные литералы могут быть заменены на национальные. Т.е. независимо от контекста, в котором упомянуто русское слово, оно может быть за менено, так как не имеет системного значения. Внимание! В search_modes.pft 5 версии 2010.1 потребуется аналогичным образом редактировать файл Но правила перевода различных ресурсных файлов отличаются. 1) Фреймы(FRM), системные сообщения(WebMSG.txt) имеют кодировку UTF8 и могут быть переведены в любом редакторе файлов, поддерживающем UTF8; 2) Форматы(PFT) и справочники(MNU) должны переводиться с использованием стандартной латинской графики, а затем вместо азербайджанских спецсимволов должны подставляться коды. Это обусловлено использованием в них WIN 1251. Ниже приведена таблица кодов предоставленная Фархадом Азизовым. азербайджанских спецсимволов, любезно Приложение 1. Параметры запроса WEB ИРБИС Таблица 1. Базовые параметры Метка Имя 2221 I21DBN Строка Профиль базы данных – имя секции в irbis_server.ini НЕТ В секции, в параметре соответствующем команда задаётся последовательность для показа. 3331 P21DBN Строка Префикс в названии базы данных НЕТ Непосредственно не влияет на выполнение запроса 3331 R21DBN Строка Номер удалённой базы данных НЕТ Непосредственно не Не влияет на выполнение запроса! 2222 C21COM Команда Строка или символопределитель (см. таблицу параметры команд) НЕТ Строка Идентификатор читателя НЕТ После первого ввода шифруется Z21ID_T IME_UNLI MITED Цифра Флаг времени жизни идентификатора 0 Если больше 0, то идентификатор действителен неограниченное количество времени S21FRA ME Строка Название фрейма с расширением SCRIPT_ DONE Любое Любое значение 2225 3332 Z21ID Значение Содержание По умолча нию Примечания Команды F S Z E T R могут задаваться прямо или через строку, которая прописывается в секции WEB irbis_server.ini(для ИРБИС 64) или webirbis32.ini(для ИРБИС 32) Фрейм, выступающий альтернативой набору фреймов, перечисленному секции БД YES Непосредственно не Не влияет на выполнение запроса! Используется исключительно для иллюстрации работы скрипта защиты. Таблица 2. Параметры команд Команда S, F поиск и показ фреймов Метка По умолча нию Имя Значение Содержание Примечания 3400 FT_NEAR_MFN Число Номер которая качестве поиска 3339 FT_S21STR строка Вспомогательное поле с предыдущим полнотекстовым запросом 3401 FT_DISTANCE число Максимальное расстояние между словами 3402 FT_NEARLEVEL Число Степень текстов 3335 FT_REQUEST Любое Запрос на поиск с ранжированием в виде фразы на естественном языке 3337 FT_PREFIX Любое Префикс к поиску с ранжированием 3403 FT_CONTEXT Любое Контекст поиска похожих документов 3405 FT_PARAMS Любое Вспомогательное поле, определяющее видимость формы с дополнительными параметрами Не влияет на выполнение запроса! 3406 FT_RESTRICT Любое Вспомогательное поле Не влияет на выполнение запроса! 3407 DAT_S21P06 дата Начальная создания файла дата Не влияет на выполнение запроса! 3408 DAT_S21P07 дата Конечная создания файла дата Не влияет на выполнение запроса! 3409 COM_S21STR любое Групповой комментарий 2224 S21CNR число порция записей выводимых 20 1010 S21REF Число Число видимых ссылок “далее” 10 записи, берётся в образца Не влияет на выполнение запроса! -1 подобия Поиск с ранжирование м (***S21LOG= 4) ограничиваетс я S21ALL и S21SCAN K= Не влияет на выполнение запроса! Рекомендует ся задавать четное число 1009 S21FMT любое имя файла формата Имя без расширения БД 1008 S21SRW Имя файла Сортировка найденных записей Нет По автору заглавию. По году издания. По типу виду документа. 1007 S21SRD UP, DOWN 1013 S21SCAN Любое S21SCAN_FULL 0, 1 S21ALL Любое 2226 Порядок сортировки UP По возрастанию, по убыванию Имя файла формата Налич Последовате без расширения ие льный поиск свободн (сканирование ых найденных) экземпл яров Булевский флаг 0 Поисковое выражение в формате ИРБИС Флаг для сканирования всей БД, если поиск ничего не дал В ссылках строка должна быть в кодировке URI. Знак“ заменен на <.> В форме знак+ должен быть заменен на %20Β 3415 S21STR любое Строка поиска с термином 3411 SEARCH_STRING любое Копия запроса 3414 S21P03 любое Префикс поискового термина S21LOG 0, 1, 3 логика связи выражений заданных через префиксы *** в поисковом задании текущего Не влияет на выполнение запроса! 1 0 выражения связаны логикой ИЛИ; 1 выражения связаны логикой И; - 3 выражения связаны логикой НЕТ; 2227 3338 S21ALLTRM Любое Набор терминов для раскраски S21COLORTERM 0,1 Флаг, определяющий необходимость раскраски терминов S Термины с префиксом следую через | 1 Раскраска может быть отменена в области формата ограниченной <!> ***S21LOG 0, 1, 2, 3, логика связи слов в 4, 5 поисковой строке 0 – Не применять раскраску найденных терминов 1 Применить раскраску найденных терминов 0 – 0 - слова связаны логикой ИЛИ; 1 - слова связаны логикой И; 2 – термином является фраза целиком 3 - слова связаны логикой НЕТ; 4 – поиск с ранжирование м; 5ограничение поиска по результатам сканирования словаря от S21P06 до S21P07 ***S21P01 0, 1, 2, 3 правило терминов текста извлечения поиска из 0 0 – весь текст рассматривает ся как один термин; 1 – терминами поиска являются слова, извлеченные из текста; 2 – термином является первое слово текста (до пробела); 3 - то же, что 1 и дополнительн о – слова нормализуютс я (извлекаются основы слов) ***S21P02 0, 1 Применение аппарата правого усечения терминов поиска 0 0 не применять; 1 применять – ***S21P03 Любое Префикс терминов поиска для - зависит от инвертирован ия базы данных ***S21P04 Любое Квалификатор для терминов поиска (в виде меток полей) - зависит от инвертирован ия базы данных ***S21P05 Любое Содержание терминов поиска ***S21P06 Любое Левая граница сканирования словаря Не используется! - Дополнитель но может быть задан S21P02 ***S21P07 Любое Правая граница сканирования словаря - Выражение для сканирования словаря на языке запросов ISIS выглядит так: (“PREFIX_S P06$” […] “PREFIX_SP 07$”) 3412 E*, 4* Печать заголовков, генерируемых SRW файлом SORT_HEADERS_ PRINT 1, 0 CHECKINDEX число Отмеченные записи CHECKINDEX_FT_ SEARCH_FORMAT строка Название файла с форматом обработки отмеченных записей ISO - TEXT Формат представления данных UTF-8 Выходная кодировка - Имя таблицы для переформатирования записей БД (FST) - EXP21FMT Экспорт EXP21CODE 0 WIN DOS EXP21FST UMARCE W RMARCE UNIMARC RUSMARCE USMARC SMARCE W T 1012 T21CNR число Показ словаря Внутренний формат ИРБИС порция терминов выводимых S21CN R 20 1012 T21PRF Любое Значение префикса ***S2 Значение для показываемых 1P03 поля терминов пустая ***S21PRF строка используется при наличии значения поля T21VAL T21TRM Любое Текущий ключ T21SELTRM Любое Отобранные ключи T21CHK Любое Отмеченные ключи Z* Z21CMT Примечания к заказу Z21FAMILY Фамилия читателя Предвари тельный заказ Z21FLAGID 1011 3334 0, 1 Флаг идентификации если1 проверяется и идентификатор и фамилия. Если 0 – только идентификатор. MFN заказываемого документа Z21MFN Z21YEAR Год Для периодически х изданий Z21TOM Том Для периодически х изданий Z21NUM Номера Для периодически х изданий Z21MRG Место выдачи RQST21MFN Число MFN записи для удаления из корзины заказов Используетс я скрыто в корзине заказа. Параметр S21SCAN_F ULL равен 1. R* ***R21MFN число Запись MFN редактирования для 0 При отсутствии параметра или переданном пустом значении 1 0 – добавленная или измененная запись не актуализирует ся Если =0 – новая запись,>0 – добавить поля ***R21IFP число Необходимость актуализации записи 1 – необходимост ь актуализацииз аписи ***R21UPD число Способ внесения полей в запись 1 0 – запись опустошается ипереписывае тся заново 1 – поля добавляются как новые вхождения 2 настоящая запись удаляется – 3(версия 1) – поля добавляются как новые вхождения, при этом все повторения используемых меток сначала удаляются ***R21NUMi Число > 0 Метка поля - *** произвольное число Символ Подполе - Если пусто значения полей с индексом j конкатенирую тся в начале поля - Пустые поля игнорируются i-порядковый номер ***R21SUBi_j j-порядковый номер для каждого i Любое Значение (поля) BINARY_RESOU RCE_MFN число Номер которой ресурс BINARY_RESOU RCE_OCC число Повторение поля, в котором находится ресурс IMAGE_FILE_MF N число Номер записи, для ситуации, когда рисунок лежит в архиве полнотекстовой БД IMAGE_FILE_DO WNLOAD число Флаг, определяющий необходимость открытия диалогового окна сохранения файла IMAGE_FILE_NAM E строка Путь к фалу(относительный или полный) ***R21VOLi_j 3* Выгрузка двоичного объекта из библиогра фической записи 2* Выгрузка файла латиница * Выполнение команд возможно только после авторизации! подполя записи, в находится 0 Приложение 2. Параметры INI файла WEB ИРБИС Структурирование параметров Файл irbis_server.ini(для ИРБИС 64) или irbis32(для ИРБИС 32) имеет следующую структуру секций: 1. [MAIN] – секция с основными параметрами шлюза 2. [WEB] – секция с путями, необходимыми для работы шлюза 3. Секции библиографических баз 4. [IBIS] – секция, определяющая стандартный поиск, поиск по словарю и вывод результатов поиска [IBIS_EX] –секция, определяющая расширенный поиск [IBIS_PROF] – секция, определяющая профессиональный поиск [IBIS_ZAKAZ] – секция, определяющая вывод страницы с запросом параметров заказа [IBIS_REC] – секция, определяющая вывод формы авторизации и запись в базу RDRV. Связана с базой RDRV. [IBIS_RASPR] – секция, определяющая работу распределённого поиска. Связана с базой IBIS, но её ресурсы не использует. [RDR] – секция, определяющая показ формуляра читателя. Связана с базой RDR. 5. [RQST] – секция, определяющая показ листа заказов читат еля и удаление заказов.Связана с базой RQST 6. [UDC] –секция, определяющая работу Навигатора УДК. Связана с базой RSUDC 7. [HELP] – секция, определяющая работу Навигатора ГРНТИ. Связана с базой HELP. 8. [MESH] – секция, определяющая работу Навигатора MESH. Связана с базой MESH. 9. [URUB] – секция, определяющая работу Тематического навигатора. Связана с базой URUB. 10. [BBK] секция, определяющая работу Навигатора ББК . Связана с базой RSBBK. 11. [PARAMETRS] – секция устанавливает соответствие параметров и меток виртуальных полей, которые используются в форматах и фреймах. 12. [Reader] – секция, определяющая параметры авторизации читателя. 13. [Request] – секция, определяющая параметры формирования предварительного заказа. 14. [PHP] – секция, определяющая параметры вызова PHP Крайне важно, что все параметры для базы IBIS и других библиографических баз пользователя по умолчанию идентичны. Т. е. для базы BOOKS, оригинальной для библиотеки, будут созданы те же разделы, что и для IBIS: BOOKS, BOOKS_EX, BOOKS_PROF и т. д. Они будут включать названия базы, и дополняться суффиксами отражающими назначение раздела. Секция библиографической БД Функциона льная группа Набор фреймов команды 6 Название параметра Назначение Значение умолчанию 6 ShowFrames Вывод фрейма поисковой формы Определяется суффиксом секции SearchFrames Вывод фреймов результата поиска Определяется суффиксом секции по Примечания Здесь далее приводятся значения по умолчанию для базовой поставки WEB ИРБИС. RecUpdateFram es Вывод фреймов после выполнения операции записи Определяется суффиксом секции ZakazFrames Вывод фреймов после операции предварительног о заказа Определяется суффиксом секции DictionryFrame Вывод фреймов при показе словаря Определяется суффиксом секции DBName Название реальной базы данных FRAMES Путь фреймам DICT_FORMA Формат, используемый для показа словаря EXTPREF Префиксная часть тегов выделения EXTPOST Суффиксная часть тегов выделения s Источники данных T Выделение IBIS к В случае если нужный фрейм отсутствует в указанной папке, происходит обращение к папке, указанной в параметре FRAMES папки WEB MIN_COLOR_ COUNT Минимальное количество выделяемых символов 2 IMPORT_ISO_ *.*.*.* Маска адресов импорта ИРБИС WEB 1 IMPORT_ISO_ DBNFLC ФЛК импорта через WEB ИРБИС Импорт IP для в через Dbnflc *.*.*.* в названии параметра могут быть заменены на IP адрес ContentType Content-Base ContentEncoding Альтенративны е стандартным HTTP заголовки Используются обычно в тех случаях, когда с помощью WEB ИРБИС требуется сгенерировать не HTML страницу. ContentLanguage ContentLocation Content-MD5 Content-Range Etag Expires Last-Modified ContentDisposition ContentDisposition Секция MAIN Функциона льная группа Ведение базы статистики Название параметра Назначение Значение умолчанию по Примечания LogDateBase Название базы протоколов LOGDB Подробней см. документации компоненту в к EveryDayEmty LogDB Необходимость ежедневного опустошения 1 Подробней см. документации компоненту в к EveryDayEmty LogDB_Format Формат отчёта, создаваемого перед опустошением Otchet Подробней см. документации компоненту в к LogFileName Название файла протокола или путь к нему cgiirbis_64.log Файл создаётся директории CGI в LogFileSize Размер файла протокола 10000000 DBNNAMECA Название MNU файла с перечнем доступных шлюзу баз dbn_web.mnu IRBISPATH Путь к каталогу ИРБИСсервера(для ИРБИС 64) или каталогу ИРБИС 32(для ИРБИС 32) DATAPATH Путь к папке DATAI Ведение текстового протокола T Пути Задаётся в байтах Заказ DepositPATH Путь к папке Deposit с форматами WEB ИРБИС Workdir Путь к папке irbiswrk, где создаются временные файлы ACTABPATH Путь к таблице символов, считающимися буквенными Isisacw.tab UCTABPATH Путь к таблице перекодировки Isisucw.tab SYSPATH Путь к каталогу ИРБИСсервера(для ИРБИС 64) или каталогу с исполняемыми файлами ИРБИС(для ИРБИС 32) SerVid Рабочий лист сериального издания J AnalVid1 Рабочий лист аналитики 1 ASP AnalVid2 Рабочий лист аналитики 2 AUNTD AnalVid3 Рабочий лист аналитики 3 NJP TagVid Метка поля с названием рабочего листа 920 DBNPREFSHIF Префикс шифра I= R DBNTAGSHIF Метка шифра 903 DBNTAGSOUR CE Поле источник шифра 463 DBNDELIMSO URCE Подполеисточник шифра W Путь к файлу со скриптом защиты cgiflc.pft R CgiFlc DEFAULT_EX PORT_FST Таблица переформатиров ания для экспорта по умолчанию Не задана CGITimeOut Ограничение времени работы шлюза 30 USE_CASH_TE RMS Включение режима кэширования терминов 0 CashTermsFile Name Временный файл, в котором кэшируются термины CashTerms.dct DirectAccess Разрешение на определение рабочей базы в строке запроса через параметр S21FRAME 0 В секундах Режим кэширования применяется при редко изменяющейся базе для ускорения поиска Включение прямого доступа не безопасно и требует специальной настройки cgiflk.pft Секция WEB Функциона льная группа Название параметра EXTPREF Префиксная часть тегов выделения EXTPOST Суффиксная часть тегов выделения Выделение Значение умолчанию Минимальное количество выделяемых символов 2 Записать Текстовый псевдоним команды R Выполнить Текстовый псевдоним команды F Заказать Текстовый псевдоним команды Z Экспорт Текстовый псевдоним команды E Поиск Текстовый псевдоним команды S MIN_COLOR_ COUNT Не используется Назначение по Примечания Устаревшие, не используемые параметры Словарь Текстовый псевдоним команды T Далее Текстовый псевдоним команды T Вернуться Текстовый псевдоним команды F frus Файл полного формата по умолчанию Fullwebr brus Файл краткого формата по умолчанию Briefwebr ZakazFormat Формат заказа SearchHeader Первая часть генерируемой страницы по умолчанию Zakaz header.frm SearchFooter Последняя часть генерируемой страницы по умолчанию footer.frm SearchMain Часть генерируемой страницы по умолчанию Smain.frm SearchEmpty Часть генерируемой страницы по умолчанию Sempty.frm SearchNext Часть генерируемой страницы по умолчанию Snext.frm Параметр функционирует! не Часть генерируемой страницы по умолчанию Search.frm Параметр функционирует! не Dictionry Часть генерируемой страницы по умолчанию dict.frm ZAKAZ Часть генерируемой страницы по умолчанию zakaz.frm SearchAfterDict ionry Параметры сортировки MAX_SORT_C OUNT Максимальное количество сортируемых записей 1000 MAX_FULLTE XTSEARCH_CO UNT Максимальное количество сортируемых записей при ранжированном поиске 100000 CGIPATH CGI_ALIAS Определени е кодировки Оказывает определяющее влияние на скорость вывода Путь к CGI WEB ИРБИС Внутри системы файловой Путь к интернет URL CGI CGI в FRAMES_CHA R_SET Кодирока фреймов UTF-8 Может принимать значения: UTF-8 или WINDOWS-1251 QUERY_CHAR _SET Кодировка запросов UTF-8 Может принимать значения: UTF-8 или WINDOWS-1251 TimeLiveKey Время жизни зашифрованного пароля читателя 20 Указывается минутах Safe_File_Dow nload Включение режима безопасной выгрузки файлов 0 Если 1, включён. выключен Safe_File_Paths Перечень директорий для выгрузки файлов в то режим Если 0, Используется в режиме безопасной выгрузки файлов Секция PARAMETRS Функциона льная группа Название параметра Значение умолчанию по Примечания SearchResultTa Количество найденных записей 1001 ReaderIDTag Незашифрован ный идентификатор читателя 1002 DictTermTag Текущий термин словаря 1003 Используется только в режиме показа словаря DictNDocsTag Количество ссылок на текущий термин словаря 1004 Используется только в режиме показа словаря URLTag IP клиента адрес 1100 g Определени е меток виртуальных полей, содержащих системные данные Содержание поля RecUpdateResul tTag Результат выполнения команды записи 1101 Используется записи FT_WORDS_T AG Слова, найденные в документе при полнотекстовом поиске с ранжированием 3336 Используется полнотекстовых запросах в MFN_TAG Номер текущей записи в БД 1014 Используется режиме поиска: S F в CHECKINDEX Набор MFN отмеченных записей 3412 Используется режиме поиска: S F в Имя загружаемого файла 1102 Используется в команде выгрузки файлов(2) DOWNLOAD_F ILE при Секция PHP Функциона льная группа Название параметра DefaultServerP ORT DefaultServerIP Назначение Значение умолчанию по Примечания Порт сервера скриптов PHP по умолчанию 80 Используется команде вставки PHP= в <-- Адрес сервера PHP скриптов по умолчанию 127.0.0.1 Используется команде вставки PHP= в <-- Секция IRBISSERVER Функциона льная группа Параметры WebToIrbisSe rver.exe Название параметра Назначение Значение умолчанию по Примечания IP IP ИРБИСсервера 127.0.0.1 Используется только HTTP прокси WebToIrbisServer.exe PORT Порт ИРБИСсервера 80 Используется только HTTP прокси WebToIrbisServer.exe CGITimeOut Максимальное время отклика 3 Используется только HTTP прокси WebToIrbisServer.exe Секция FULLTEXT Функциона льная группа Название параметра RelavtionConte xt Параметры полнотекстов ого поиска Назначение Минимальный процент слов из контекста в тексте при поиске похожих записей Значение умолчанию 7 по Примечания RelavtionText Минимальный процент слов из текста образца в другом тексте при поиске похожих записей 10 Приложение 3. Специфические для WEB ИРБИС функции UNIFOR &unifor('+3J[имя базы],[префикс][термин с усечением]) – аналог &uf(‘J, но поддерживает усечение искомого термина. &unifor(‘+3G[URL к внешнему сайту WEB ИРБИС, с запросом G]’) – вывод количества документов, найденных во внешней базе по команде G.(команда возвращает строку RESULT=[кол-во найденных по запросу документов]) &unifor('+3S[имя базы],[количество выводимых записей],[ограничитель][формат][ограничитель],[формат или @имя файла с форматом]) – расформатирует найденные по запросу записи. Если [количество выводимых записей]=0, то возвращает только количество найденных по запросу документов &unifor('+3E' - перевод в формат URI для передачи серверу. &unifor('+3D' – перевод из URI (применяется шлюзом при работе по методу GET). &unifor('+3U' – перевод ANSI в UTF8 – применяется в WEB ИРБИС32 для формирования ссылок в кодировке UTF8. &unifor('+3W' – перевод UTF8 в ANSI. &unifor('+3+' – перевод знака + в %2B для правильной передачи поискового запроса содержащего логику ИЛИ в ссылках. Приложение 4. Отличия WEB ИРБИС 32 и WEB ИРБИС 64 1. В WEB ИРБИС 32 отсутствует: А) Функция поиска похожих документов Б) Режим *S21LOG 4, превращающий запрос в полнотекстовый с ранжированием В) Возможность поиска с использованием тематического рубрикатора В) возможность использования команды 3(выгрузка внутреннего двоичного ресурса библиографической записи) 2. Для формирования GET запросов(генерации ссылок) в WEB ИРБИС 32 наряду с перекодировкой в URI (функция &unifor(‘+3E’)) осуществляется перекодировка запросов в UTF8(функция &unifor(‘+3U’)) 3. Идентификатор поколения – 32 или 64 отражается в названиях папок и других ресурсов. Приложение 5. Дополнения в составе WEB ИРБИС В составе WEB ИРБИС могут поставляться расширения: 1. Z39 клиент и сервер. Поставляются только в полной версии WEB ИРБИС. описаны в документации. Подробно 2. Расширение для ведения базы данных статистики запросов и отображения статистики на сайте. 3. СЕРВИС WebIrbis_service_64.exe, который позволяет по ссылке из формата показа найденных документов открыть заданный MFN в АРМ Каталогизатор. 4. Консольная версия WEB ИРБИС для использования в сторонних программах. Расширения(кроме z39) располагаются в директории AddIns инсталляционного архива Webirbis.zip и содержат инструкции по использованию в файлах readme.txt