Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Ниже каждый из шагов рассмотрен более подробно.

Справочник

Справочник — это обычный CSV-файл:

...

Все значения подсказки трактуют как строки, даже если по факту это числа или даты.

Пример справочника
hidnamesurnamepatronymicfullnameemailphoneinnsalarypositiondepartment
1001ВолковаТатьянаАнатольевнаВолковаТатьянаАнатольевнаvolkova.tatyana@evercorp.ru+7 926 387-34-2356010462543250000Менеджер по закупкамОтдел закупок
1002БарчукВалерийНиколаевич

Барчук Валерий Николаевич

barchuk.valeriy@evercorp.ru+7 495 234-13-9849087541349045000Менеджер по продажамОтдел корпоративных продаж
1003ЖуковаКристинаОлеговна271307275938ceo@evercorp.ru
27130727593890000Директор
...

Конфигурация

Конфигурация — это YAML-файл, который описывает, как подсказки работают со справочниками. Проще всего объяснить его на примере:

Блок кода
languagevb
# название справочника
# наш пример — справочник сотрудников
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: ~

Скопировать на сервер

Конфигурацию:

  1. Сохранить конфигурацию в файл {name}.yaml, где {name} — название справочника, как указано в конфигурации.
  2. Скопировать файл на сервер в каталог /SGT_ROOT/configuration/

...

  1. Сохранить справочник в файл {name}.csv, где {name} — название справочника, как указано в конфигурации.
  2. Создать на сервере каталог /SGT_ROOT/dictionaries/{name}/ и скопировать в него файл справочника.

API

Аналогично «родным» справочникам:

...

Без форматирования
POST /suggestions/api/4_1/rs/findById/employees HTTP/1.1
Host: suggestions.evercorp.ru
Content-Type: application/json

{
  "query": "1024"
}

jQuery-плагин

В плагине всё как обычно, только в поле type указывается название справочника:

...