Справочники

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

Типичные примеры: города, отрасли, условия оплаты, шаблоны договоров, категории услуг. Каждый тип справочника задаёт администратор через систему типов сущностей.

Эта страница описывает механизм. Конкретные виды — типы документов, поля, статусы — определяются для вашей организации и могут отличаться. См. систему сущностей.

Когда использовать справочник

Используйте справочник, когда нужен контролируемый список значений, который:

  • имеет собственные поля (не только название — например, справочник городов, где каждая запись хранит ещё регион и страну),

  • используется записями других типов сущностей через поля-ссылки,

  • ведётся независимо от записей, которые на него ссылаются.

Если вам нужны только плоские метки для фильтрации и отчётов, без собственных полей и ссылок между записями, проще использовать критерии.

Типы справочников

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

Системные типы справочников

CityScreen Deals резервирует два системных типа справочников — один для описаний цифрового инвентаря, другой для описаний печатного инвентаря. Эти типы лежат в основе каталогов инвентаря, и удалить их нельзя. Создавать записи системного типа справочника пользователи не могут: приложение отклоняет такую попытку.

Все остальные типы справочников пользовательские — их задаёт администратор.

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

Типы справочников создаются в разделе «Сущности», в папке «Справочники». Процесс такой же, как для любого типа сущности: выберите отображаемое название и машинное имя, добавьте группы полей и поля, затем сохраните.

Полную процедуру, включая правила машинных имён, группы полей и архивирование, см. в разделе типы сущностей.

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

Справочники вынесены в отдельный раздел главной навигации.

Структура

Раздел «Справочники» открывается с панелью вкладок вверху. Первая вкладка, Все, показывает записи всех типов справочников вместе. Для каждого типа справочника, на чтение которого у текущего сотрудника есть право, появляется отдельная вкладка: она оставляет в списке только записи этого типа.

Просмотр записей

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

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

Создание записи

Чтобы создать запись справочника, используйте действие «Создать» на странице списка. В форме создания есть следующие поля:

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

Обязательное. Выберите один из типов справочников, на изменение которых у текущего сотрудника есть право. После сохранения тип справочника записи изменить нельзя.

Название

Обязательное. Отображаемое название записи.

Ответственный

Сотрудник, отвечающий за эту запись. При создании новой записи ответственным по умолчанию становится текущий сотрудник.

Группы сотрудников

Одна или несколько групп сотрудников, связанных с записью. Используются для ограничения прав по области (свои / группа / все).

Описание

Необязательный произвольный текст.

Под системными полями форма показывает пользовательские поля, заданные в выбранном типе справочника, организованные по группам полей.

Просмотр и редактирование записи

Если выбрать запись в списке, откроется её страница с системными полями и значениями всех пользовательских полей. Действие «Редактировать» открывает ту же форму, что и при создании, но тип справочника в ней показан как текст только для чтения, и менять его нельзя.

Удаление записей

Записи можно удалять по одной из списка или пакетом. Для удаления одной записи используйте кнопку удаления в её строке; для пакетного удаления — колонку флажков и действие пакетного удаления.

В обоих случаях перед удалением показывается диалог подтверждения. Удаление зависит от прав: у сотрудника должно быть право на удаление для типа справочника этой записи.

Как другие записи ссылаются на записи справочников

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

Выбор связанной записи справочника может запустить автозаполнение: если в родительском типе сущности есть поля-выражения, которые ссылаются на поля выбранной записи, эти значения вычисляются и подставляются автоматически. О совместной работе полей-ссылок и полей-выражений см. типы данных.

Экспорт

На странице списка есть действие экспорта в XLSX. Экспорт включает записи, попавшие в текущую выборку, с их системными полями (id, название, описание, создано, изменено) и всеми значениями пользовательских полей.

Действием экспорта управляет отдельное право на экспорт.

Записи справочников создаются по одной в интерфейсе или через API.

Права

Права на справочники выдаются для каждого типа справочника, по той же модели, что и для других типов сущностей. У сотрудника может быть доступ к одному типу справочника и не быть доступа к другому.

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

О том, как настраиваются права на уровне типа сущности и на уровне полей, см. роли и права.

Связанные страницы

  • Типы сущностей — создание и редактирование схем типов сущностей, включая типы справочников

  • Типы данных — девять типов полей, включая поля-ссылки на записи справочников

  • Вложенные сущности — структуры с повторяющимися строками, доступные внутри типов справочников

  • Критерии — плоские метки классификации, альтернатива справочникам для простой категоризации

  • Типы контрагентов — ещё один супертип сущностей с похожей структурой