Произвольные справочники

Произвольный справочник — это ваша собственная таблица с произвольным набором полей, которую вы настраиваете самостоятельно. Данные справочника доступны во всей системе: в панели администрирования, пользовательских скриптах, витрине и интеграциях.

Создаёт и настраивает справочники администратор основного региона, работать со справочниками могут менеджеры, для которых вы настроили доступ.

Где можно обращаться к справочнику:

• Панель администрирования — раздел Справочники → Управление справочниками или Справочники → /Ваш справочник/ (если это настроено);
• Пользовательские скрипты — fn.dictionary.get / find / set / update / delete;
• Витрина — Liquid-фильтры custom_dictionary_lookup, custom_dictionary_page, custom_dictionary_search;
• Внешние системы — api/v3 — чтение, запись, импорт, постраничная выгрузка.

Список справочников

Список созданных вами произвольных справочников находится в разделе Справочники → Управление справочниками.

На странице со списком справочников доступны следующие действия:

1. Перейти к записям справочника;
2. Перейти в карточку справочника;
3. Перейти к настройкам справочника;
4. Удалить справочник;
5. Добавить новый справочник.

Список справочников

Создание справочника

Добавить новый справочник в систему можно:

• вручную
• с помощью JSON-файла (например, если переносите справочник из другой системы)

Вручную

Чтобы добавить новый справочник вручную, выполните следующие действия:

ШАГ 1. В панели администрирования перейдите в раздел Справочники → Управление справочниками и нажмите кнопку Создать справочник.

ШАГ 2. На открывшейся странице укажите название справочника в поле Название.

Название справочника

ШАГ 3. В блоке Поля справочника создайте хотя бы одно (ключевое) поле справочника.

Таблица 1. Настройки поля справочника

№	Название настройки	Описание
1	Название поля	Укажите название поля.
2	Код поля	Генерируется системой автоматически. Вы также можете придумать код самостоятельно. Поддерживаются только строчные латинские буквы, цифры и символ нижнего подчёркивания. После создания изменить код нельзя.
3	Тип поля	Выберите тип поля в зависимости от его ожидаемого содержимого: Строка — короткие значения, можно искать по началу значения; Текст — длинные описания; Целое / Дробное число — количества, коэффициенты, цены; Да/Нет — флаги и переключатели; Список — значение только из заданного набора вариантов; Дата — сроки и периоды.
4	Обязательное	Активируйте опцию, если требуется, чтобы это поле было обязательно для заполнения.
5	Участвует в поиске	Активируйте опцию, если требуется, чтобы для поля был сгенерирован отдельный индекс для участия в поиске. Доступно только для полей типа Строка и Текст.

Нажмите кнопку Сохранить.

Настройки поля

ШАГ 4. На открывшейся странице нажмите кнопку Редактировать и на странице настроек выберите нужное поле в опции Ключевое поле.

По ключевому полю система находит записи и обновляет их при повторном импорте вместо создания дублей.

Сохраните изменения.

Ключевое поле

ШАГ 5. В блоке Импорт из файла нажмите кнопку Скачать пустой шаблон xlsx, чтобы скачать правильно настроенный шаблон справочника на свой компьютер.

Шаблон уже содержит правильные заголовки и подсказки к колонкам.

Скачивание шаблона

ШАГ 6. Откройте шаблон на своем компьютере, заполните его нужными данными и сохраните изменения.

Поддерживаются форматы csv, xls, xlsx до 50 МБ.

Подготовка шаблона

ШАГ 7. Загрузите подготовленный файл в систему. Для этого выполните следующие действия:

1. Загрузите файл с помощью кнопки Выберите файл;
2. В поле При дубликате ключа выберите поведение системы в случае нахождения дубля:

• Пропустить — запись останется без изменений;
• Обновить — значение из файла будет добавлено в существующую запись;
• Прервать — импорт будет остановлен на первом дубле.

Вариант Прервать останавливает импорт, но не откатывает его, т.е. строки, загруженные до остановки, останутся в справочнике (откатывается только последняя порция в 500 строк).

3. Нажмите кнопку Загрузить.

При проблемах с загрузкой файла примените дополнительные настройки в полях Разделитель/Кодировка/Лист (xls/xlsx).

Загрузка выполняется в фоновом режиме и не блокирует работу.

Загрузка файла

ШАГ 8. После загрузки справочника вернитесь в его настройки с помощью кнопки Редактировать и задайте остальные параметры:

Таблица 2. Настройки справочника

№	Название настройки	Описание
1	Название	Измените название справочника, если требуется.
2	Код	Генерируется системой автоматически.
3	Описание	Добавьте описание справочника, если требуется.
4	Активен	Активируйте опцию, чтобы справочник стал доступен для работы.
5	Показывать в меню «Справочники»	Активируйте опцию, если требуется, чтобы справочник отображался в разделе панели администрирования Справочники.
6	Доступен в шаблонах витрины	Активируйте опцию, если требуется разрешить чтение справочника из Liquid-шаблонов публичного сайта. Готовые примеры под ваш справочник (с его кодом и кодами полей) находятся в карточке справочника, на вкладке Примеры для Liquid-шаблонов витрины. Примеры можно копировать и использовать как есть. Список справочников с полями и примерами для скриптов появляется и в справке редактора скриптов.
7	Название в меню	Если требуется, укажите альтернативное название справочника, под которым он будет отображаться в разделе панели администрирования Справочники (если активирована опция Показывать в меню «Справочники»). По умолчанию отображается основное название справочника.
8	Ключевое поле	Измените ключевое поле, если требуется. Не рекомендуем менять ключевое поле без необходимости, т.к. смена ключевого поля у заполненного справочника запускает пересчёт ключей и временно закрывает запись.
9	Менеджеры с доступом	Выберите менеджеров, которым будет доступна работа со справочником. Если оставить это поле и поле Роли с доступом пустыми, справочник будет доступен только администраторам основного региона.
10	Роли с доступом	Выберите роли пользователей, обладателям которых будет доступна работа со справочником. Если оставить это поле и поле Менеджеры с доступом пустыми, справочник будет доступен только администраторам основного региона.

Сохраните изменения.

Настройки справочника

Справочник в разделе Справочники

ШАГ 9. Если требуется, добавьте дополнительные поля в справочник с помощью кнопки Добавить поле.

Сохраните изменения.

Добавление поля

Действия в справочнике

Перейти к записям справочника можно с помощью кнопки Список записей в разделе Справочники → Управление справочниками.

Если в настройках справочника активирована опция Показывать в меню «Справочники», перейти к нему можно прямо в разделе Справочники → /Ваш справочник/.

Переход к записям справочника

В справочнике доступны следующие действия:

• Найти нужную запись с помощью блока фильтрации и поиска;
• Просмотреть запись;
• Редактировать запись;
• Удалить запись;
• Добавить новую запись.

Действия в справочнике

Форма добавления записи

Перенос с помощью JSON

Перенос уже готового справочника между разными установками выполняется с помощью JSON-файла. Чтобы перенести справочник, выполните следующие действия:

ШАГ 1. В панели администрирования перейдите в раздел Справочники → Управление справочниками и в строке нужного справочника нажмите кнопку Просмотр.

Переход в карточку справочника

ШАГ 2. В блоке Поля справочника нажмите кнопку Выгрузить схему в json и сохраните файл на свой компьютер.

С помощью файла будет создан такой же справочник на другой установке. В файле сохраняется структура справочника: поля, типы, ключ. Записи и доступы в файл не попадают — для каждого магазина они свои.

Скачивание файла JSON

ШАГ 3. Импортируйте справочник с помощью полученного JSON-файла на нужную установку.

Перенос в систему PARTS SOFT

Если требуется импортировать справочник в систему PARTS SOFT, выполните следующие действия:

ШАГ 1. В панели администрирования перейдите в раздел Справочники → Управление справочниками и нажмите кнопку Создать справочник.

ШАГ 2. На открывшейся странице выполните следующие действия:

Таблица 3. Настройки загрузки произвольного справочника из файла

№	Название настройки	Описание
1	Файл схемы	Загрузите JSON-файл со справочником с помощью кнопки Выберите файл.
2	Другой код	Укажите код, если справочник с кодом из файла уже есть в вашем списке справочников (например, если вы загружаете справочник в эту же систему).  Поддерживаются только строчные латинские буквы, цифры и символ нижнего подчёркивания. После создания изменить код нельзя.
3	Другое название	Укажите название справочника, если название, указанное в файле, не подходит.

Нажмите кнопку Создать из файла.

Загрузка справочника из файла

В случае успешной загрузки в верхней части страницы появится уведомление Справочник создан по схеме из файла. Проверьте доступы — они не переносятся.

ШАГ 4. Перейдите в настройки созданного справочника с помощью кнопки Редактировать и задайте параметры справочника.

Настройки доступа