Настройки модуля — это глобальные параметры, которые можно использовать в серверных скриптах виджетов и бизнес-процессов модулей, а также для создания методов API. Например, можно добавить параметры для хранения токена или ключа API.
Для обращения к параметрам в скриптах используйте:
Namespace.params.data."название параметра".
Чтобы добавить параметры настроек модуля:
- Перейдите в Администрирование > Модули.
- Наведите курсор на модуль и нажмите на появившийся значок шестерёнки.
- Перейдите на вкладку Настройки.
- Нажмите + Добавить и в окне создания заполните поля:
- Отображаемое имя* — название свойства, которое будет отображаться на различных формах модуля и в его настройках;
- Имя свойства* — название свойства, использующееся при работе с API, скриптами;
- Подсказка — дополнительная информация о свойстве;
- Тип* — тип свойства, например, Строка;
- Поиск и сортировка по полю — если вы выберете эту опцию, то значение данного поля будет использоваться в качестве параметра для поиска;
- Полнотекстовый поиск — значение поля будет участвовать в полнотекстовом поиске.
- Заполняется по формуле — эта опция доступна только для полей типа строка, число и деньги. Вы можете указать формулу, при помощи которой система будет автоматически рассчитывать значение для данного свойства. Подробнее читайте в статье «Заполнение по формуле и отображение поля».
- Отображается при выполнении условия — эта опция позволяет скрывать/отображать свойство в зависимости от заданных вами условий. Подробнее читайте в статье «Заполнение по формуле и отображение поля».
- После того как вы укажете все настройки, нажмите Сохранить.
Все созданные поля настроек по умолчанию добавляются на страницу подключения модуля. Пользователь увидит их, нажав на название модуля в разделе Администрирование.
Отображение настроек
Отображение настроек можно менять. Например, часть настроек можно скрыть, добавить поля для проверки токенов или настроить страницу так, чтобы на ней сразу отображались нужные данные из внешнего сервиса.
Для этого в модуле на вкладке Настройки нажмите Изменить форму.
Откроется Дизайнер интерфейсов, в котором можно настроить собственный виджет для отображения настроек. Когда вы переходите в дизайнер, то сразу открывается вкладка Шаблон. В ней по центру расположено поле для моделирования, справа — все доступные виджеты. На вкладке Свойства отображаются настройки модуля.
На вкладке Контекст вы можете добавить свойства, которые будут использоваться при написании скриптов для виджета. Подробнее о свойствах вы можете почитать в статьях «Типы контекста» и «Типы данных в системе».
На вкладке Скрипты вы можете написать скрипты, определяющие поведение виджета.
Готовый виджет необходимо опубликовать.