Настройка отображения контекстно-зависимой справки

В Web-клиенте реализована возможность отображения контекстно-зависимой справки, содержащей информацию о работе в Системе.

Для отображения контекстно-зависимой справки в Web-клиенте должны быть выполнены следующие условия:

  • в справочнике Параметры параметр enableHelp должен иметь значение + (п. Справочник «Параметры»);

  • в файл «config.json» должен быть добавлен раздел «help» в блоке «sections».

Для настройки справки для определенного объекта Системы нужно дополнительно указать ссылки на справочные разделы в файле «help.json», например:

  • Для вызова справки с описанием создания документа из формы создания нужно в файле «help.json» в блоке document указать ссылку для формы создания для конкретного журнала регистрации – после нажатия кнопки img будет открыта ссылка на справку, указанную в блоке document для данного журнала регистрации.

  • Для вызова справки с описанием справочника из формы справочника нужно в файле «help.json» в блоке vocabulary указать ссылку для списка конкретного справочника – после нажатия кнопки img будет открыта ссылка на справку, указанную в блоке vocabulary для данного справочника.

Пример настройки файла «help.json», блок vocabulary:

"vocabulary": {
  "1623": "Справочники/Справочник%20Виды%20документов.html",
  "1638": "Справочники/Справочник%20Группы%20рассылки.html",
  "1692": "Справочники/Справочник%20Группы%20рассылки.html",
  "1693": "Справочники/Справочник%20Группы%20рассылки.html",
  "1694": "Справочники/Справочник%20Группы%20рассылки.html",
  "1682": "Справочники/Справочник%20Сотрудники.html",
  "1687": "Справочники/Справочник%20Физические%20лица.html",
  "1688": "Справочники/Справочник%20Юридические%20лица.html",
  "1679": "Справочники/Справочник%20Номенклатура%20дел.html",
  "1705": "Справочники/Пользовательские%20справочники.html#_2",
  "1706": "Справочники/Пользовательские%20справочники.html#_3",
  "1711": "Справочники/Пользовательские%20справочники.html#_4",
  "1715": "Справочники/Пользовательские%20справочники.html#_5",
  "1713": "Справочники/Пользовательские%20справочники.html#_6",
  "1714": "Справочники/Пользовательские%20справочники.html#_7"
 },

Для кастомных элементов управления контекстная справка реализована для компонентов card-select-users, card-select, card-combobox, card-select-list-textbox, card-datepicker, card-edit-text. Для данных компонентов можно задать пропс help: { tooltip: string; link: string; }.

Для использования контекстной справки для конкретного компонента элемента управления необходимо выполнить следующие действия:

  1. В карточке конструктора задать пропс:

":help": "{ link: $app.help.link('cards.901.reg_num') }"

2. По ключу cards.901.reg_num добавить соответствующую ссылку в файле assets/resources/help.json, например:

"cards": {
 "901": {
  "reg_num": "Карточка входящего документа/Поле регистрационный номер.html"
  }
 }

Контекстная справка будет доступна для конкретного компонента.

Для создания кастомной карточки с возможностью отображения справки необходимо выполнить следующие действия:

  1. Открыть Web-администратор.
  2. Открыть раздел Элементы кастомизации, подраздел Типы объектов.
  3. Нажать ЛКМ на документ, затем нажать кнопку [Создать потомка].
  4. Заполнить поля в форме создания и нажать кнопку [ОК].
  5. Применить модель.
  6. Открыть раздел Элементы кастомизации, подраздел Карточки.
  7. Найти созданный объект.
  8. Для режима создания нажать кнопку [Создать].
  9. Нажать кнопку [Добавить элемент] и выбрать пункт [Разделы].

  10. Добавить поля:

    • RegistrationNumber (текстовое поле) – в атрибуты добавить ":help": "{ link: $app.help.link('cards.20001.reg_num') }";

    • RegistrationDate (дата) – в атрибуты добавить ":help": "{ link: $app.help.link('cards.20001.reg_date') }";

    • DOCUMENTTYPE (выбор из справочника) – в атрибуты добавить ":help": "{ link: $app.help.link('cards.20001.doctype') }";

    • State (выпадающий список) – в атрибуты добавить ":help": "{ link: $app.help.link('cards.20001.combobox') }";

    • USER – выбор сотрудника, в атрибуты добавить ":help": "{ link: $app.help.link('cards.20001.users') }".

11. Для кастомного компонента в поле ввести card-select, в параметры компонента добавить:

{
 "name": "card-select",
 "attributes": {
  ":items": "[{ id: 1, value: 'a' }, { id: 2, value: 'b' }]",
  "label": "Селект",
  "variant": "outlined",
 ":help": "{ link: $app.help.link('cards.20001.cardselect') }"
 }
}

12. Сохранить карточку.

13. Скопировать карточку режима создания и добавить ее в режим редактирования.

14. В справочнике Журналы регистрации добавить журнал для созданной карточки и выдать права.

Кастомная карточка с возможностью отображения справки будет создана.