Документация для разработчиков
Темная тема

Агенты

Агенты - это технология, позволяющая запускать произвольные PHP-функции (агенты) с заданной периодичностью. В самом начале загрузки каждой страницы система автоматически проверяет, есть ли агент, который нуждается в запуске и в случае необходимости - исполняет его.

Список используемых в системе агентов приводится на странице Список агентов (Настройки > Настройки продукта > Агенты).


Фильтр

Форма фильтра используется для выбора из списка агентов в соответствии с указанными условиями. Нижеследующая таблица описывает параметры, по которым может выполняться поиск.

Поле Описание
НайтиДанное поле позволяет выполнить поиск агентов по наиболее часто используемым критериям: ID агента, Модуль, ID пользователя или Имя агента. Поле присутствует, даже если фильтр свернут.
ID агентаИдентификатор агента.
МодульНазвание модуля, к которому относится данный агент.
ID пользователяИдентификатор пользователя, который запустил агент. Если необходимо отобразить только те агенты, которые запускаются системой, то в данном поле нужно указать Система.
Имя агентаПоиск агента по его имени (название функции).
АктивностьДанное поле позволяет отобразить активные, неактивные или все агенты.
Дата последнего запуска (DD.MM.YYYY)Поиск агентов по дате их последнего запуска.
Дата следующего запуска (DD.MM.YYYY)Поиск агентов по дате их последующего запуска.
ПериодичностьДанное поле позволяет отобрать периодические, непериодические или все агенты.

Периодические агенты нужны чтобы выполнять операцию строго определенное число раз. Например, удаляем 10 файлов кеша раз в 10 секунд. Надо чтобы через минуту было удалено 60 файлов, тогда создается периодический агент.

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

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

Пример: Есть два агента с периодом 1 минута периодический и нет. На сайт никто не заходил 10 минут: периодический агент отработает 10 раз, а непериодический - только один.

Для того чтобы отобразить агенты по заданным критериям поиска нажмите кнопку Найти. Для отображения всех агентов нажмите кнопку Отменить.



Контекстная панель

КнопкаОписание
Добавить агента Переход к форме создания нового агента.
НастроитьПереход к диалогу настройки внешнего вида отчетной формы.
ExcelЭкспорт данных из отображаемой таблицы в MS Excel.


Список агентов

Поле Описание
Колонка флажковПоле предназначено для выбора агентов, к которым предполагается применить какое-либо правило или действие.
ДействиеДействия, которые можно произвести над агентом:
IDИдентификатор агента.
МодульНазвание модуля, к которому относится агент.
[ID] Логин Система или ID, логин, имя пользователя, запустившего агент.
СортировкаОтносительный "вес" агента. Чем меньше указанное число, тем выше показан в списке агент.
Функция агентаВыполняемая PHP-функция агента.
АктивностьПризнак активности агента.
Последний запуск Дата и время последнего запуска агента.
Следующий запускДата и время следующего запуска агента.
ИнтервалИнтервал запуска агента, указанный в секундах.
ПериодическийПризнак периодичности агента.


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Андрей Чурсин
Сообщение не промодерировано, возможны ошибки и неточности.
Для тех кто с локализацией, а в документации всё называют по другому:
  • "через заданный интервал" - не периодический
  • "точно в указанное время" - периодические
8
Denis Sharomov
Если с прошлого запуска агента прошло времени больше, чем его период, то периодический будет отрабатывать то число раз, которое он не отработал.
Пример: Есть два агента с периодом 1 минута периодический и нет. На сайт никто не заходил 10 минут: периодический агент отработает 10 раз, а непериодический - только один.


Периодические агенты нужны чтобы выполнять операцию строго определенное число раз. Например, удаляем 1 файл кеша раз в 10 секунд. Надо чтобы через минуту было удалено 6 файлов, тогда создается периодический агент. Если же он удаляет весь старый кеш разом, то должен быть непериодический.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх