История страницы
...
Блок кода | ||
---|---|---|
| ||
# название справочника
# наш пример — справочник сотрудников
name: employees
# настройки чтения CSV файла
# необязательно, значения по умолчанию описаны ниже
csv:
quote: '"'
delimiter: ','
endOfLine: '\n'
encoding: UTF-8
# какие есть поля и как их использовать
fields:
# Исправлять латинскую раскладку, по умолчанию true
switch_layout: false
# какие поля участвуют в поиске по идентификаторам
# необязательно, по умолчанию не задано
ids:
hid: ~
inn: ~
# какие поля участвуют в полнотекстовом поиске (обязательно хотя бы одно)
# для полей можно указать параметр boost — вес для ранжирования
# чем больше вес, тем «весомее» считается совпадение по этому полю
# например, если вес по fullname = 10, а по email = 1,
# то совпадение по ФИО считается весомее, чем по адресу эл. почты
# по умолчанию вес = 1
search:
fullname:
boost: 10
email: ~
phone: ~
# по каким полям фильтровать
# необязательно, по умолчанию не задано
filter:
department: ~
# по какому полю ранжировать
# необязательно, по умолчанию не задано
# чем больше значение, тем выше ранжируется соответствующая запись справочника
# если указано несколько полей, то значения умножаются
# по умолчанию вес = 1
boost:
salary: ~
# по какому полю сортировать
# необязательно, по умолчанию равно настройке fields.value + ALPHA_NUMERIC
# принцип сортировки:
# ALPHA_NUMERIC - по алфавиту (с честной сортировкой чисел)
# TOKEN_COUNT - по количеству слов (чем меньше слов, тем выше позиция)
sort:
fullname: TOKEN_COUNT
department: ALPHA_NUMERIC
# какое поле показывать в списке (suggestion.value, обязательно)
value: fullname
# какое поле содержит полное значение одной строкой
# необязательно, по умолчанию равно настройке fields.value
unrestricted_value: fullname_with_position
# какие поля возвращать в объекте подсказки (suggestion.data)
# необязательно, по умолчанию не задано (suggestion.data == null)
data:
name: ~
surname: ~
patronymic: ~
email: ~
phone: ~
position: ~
department: ~ |
...
- Сохранить конфигурацию в файл
{name}.yaml
, где{name}
— название справочника, как указано в самом первом параметре конфигурации.
Для нашего примера этоemployees.yaml
- Создать на сервере каталог
/SGT_ROOT/configuration/outward/
и скопировать в него файл конфигурации.
Для нашего примера итоговый путь к файлу будет/data/configuration/outward/employees.yaml
Справочник:
- Сохранить справочник в файл
{name}.csv
, где{name}
— название справочника, как указано в конфигурации.
Для нашего примера этоemployees.csv
- Создать на сервере каталог
/SGT_ROOT/dictionaries/{name}/
и скопировать в него файл справочника.
Для нашего примера итоговый путь к файлу будет/data/dictionaries/employees/employees.csv
Чтобы подсказки увидели, справочник, перезапустите их.
Проверить на демо-странице
Работу подсказок можно проверить на демо-странице по адресу http://СЕРВЕР:ПОРТ/suggestions/outward
В поле «Тип» укажите название справочника, после этого подсказки заработают:
API
Аналогично «родным» справочникам:
...
Обзор
Инструменты контента