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

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

В этом разделе

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

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

    Кнопка Описание
    Список подключений Ссылка для перехода на страницу со списком подключений.

    Закладка "Подключение"

    POST-подключение

    Поле Описание
    Настройка параметров подключения для публикации в Живую ленту
    ID Идентификатор подключения.

    Поле отображается только в режиме редактирования существующего вопроса.
    Тип подключения POST-запрос.
    Активность Признак активности подключения.
    СайтВыбор сайта, для которого настраивается подключение.
    *НазваниеПроизвольное название подключения.

    Обратите внимание, это название будет непосредственно отображаться в Живой ленте, поэтому оно должно быть простым и понятным.

    Сортировка Вес сортировки подключения; применяется при выводе списка подключений.
    Параметры события Живой ленты
    *Добавлять событие для Указывается тип события:
    • рабочей группы - выбор рабочей группы, к которой привязывается событие;
    • страницы пользователя - выбрать сотрудника, на странице которого будет отображаться данные;
    • ленты новостей - выбрать информационный блок новостей;
    • внешнего источника данных - без привязки к какой-либо сущности портала;
    Выберите рабочую группу Выбор рабочей группы из списка, для которой будет доступно событие.

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

    Выберите пользователя Указывается идентификатор пользователя в системе, либо с помощью кнопки [...] выбирается из списка пользователей в системе.

    Примечание: Опция доступна, только если выбран тип события - страницы пользователя.

    Лента новостей Выбор ленты новостей из списка доступных инфоблоков.

    Примечание: Опция доступна, только если выбран тип события - ленты новостей.

    Права на доступ к событию Выбор групп прав для доступа к событию: Все посетители, Авторизованные пользователи или Выбранные пользователи (можно указать идентификатор или выбрать из списка пользователей системы. По ссылке Добавить пользователя добавляются дополнительные пользователи).

    Примечание: Опция доступна, только если выбран тип события - внешнего источника данных.

    *Разрешить добавление комментариев к событию При выводе события в Живую ленту в ней будет доступен функционал комментариев к данному посту.

    Примечание: Опция доступна, только если выбран тип события - внешнего источника данных.

    Параметры подключения для передачи POST-запроса

    В данной секции запроса указывается скрипт портала и параметры запроса, который должна сформировать внешняя по отношению к порталу система:

    • hash - хеш авторизации, чтобы портал разрешил импорт данных;
    • title - заголовок события для отображения в Живой ленте;
    • message - текст события для отображения в Живой ленте (может включать HTML-форматирование);
    • В параметре message передается HTML - при включенной опции текст события (параметр message) будет передавать в формате HTML;
    • text-message - текст события в виде простого текста (для уведомлений подписчиков по почте или jabber);
    • url - абсолютный путь события, для просмотра подробностей по этому событию, которые можно посмотреть вне портала.

    RSS-подключение

    Поле Описание
    Настройка параметров подключения для публикации в Живую ленту
    ID Идентификатор подключения.

    Поле отображается только в режиме редактирования существующего вопроса.
    Тип подключения RSS-лента.
    Активность Признак активности подключения.
    СайтВыбор сайта, для которого настраивается подключение.
    *НазваниеПроизвольное название подключения.

    Обратите внимание, это название будет непосредственно отображаться в Живой ленте, поэтому оно должно быть простым и понятным.

    Сортировка Вес сортировки подключения; применяется при выводе списка подключений.
    Параметры события Живой ленты
    *Добавлять событие для Указывается тип события:
    • рабочей группы - выбор рабочей группы, к которой привязывается событие;
    • страницы пользователя - выбрать сотрудника, на странице которого будет отображаться данные;
    • ленты новостей - выбрать информационный блок новостей;
    • внешнего источника данных - без привязки к какой-либо сущности портала;
    Выберите рабочую группу Выбор рабочей группы из списка, для которой будет доступно событие.

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

    Выберите пользователя Указывается идентификатор пользователя в системе, либо с помощью кнопки [...] выбирается из списка пользователей в системе.

    Примечание: Опция доступна, только если выбран тип события - страницы пользователя.

    Лента новостей Выбор ленты новостей из списка доступных инфоблоков.

    Примечание: Опция доступна, только если выбран тип события - ленты новостей.

    Права на доступ к событию Выбор групп прав для доступа к событию: Все посетители, Авторизованные пользователи или Выбранные пользователи (можно указать идентификатор или выбрать из списка пользователей системы. По ссылке Добавить пользователя добавляются дополнительные пользователи).

    Примечание: Опция доступна, только если выбран тип события - внешнего источника данных.

    *Разрешить добавление комментариев к событию При выводе события в Живую ленту в ней будет доступен функционал комментариев к данному посту.

    Примечание: Опция доступна, только если выбран тип события - внешнего источника данных.

    Параметры подключения к источнику данных
    *URI Указывается путь к источнику данных.
    В элементе description передается HTML При включенной опции указывается, что в элементе description передаваемого через RSS сообщения используется HTML.

    Примечание: В связи с изменениями, связанными с безопасностью, убедитесь, что в настройках схем публикации в живую ленту типа "RSS-лента" установлена активной опция В элементе description передается HTML там, где это необходимо.

    Расписание автоматической публикации
    *Время последней генерации выпуска (DD.MM.YYYY HH:MI:SS) Выбирается время и дата последнего подключения.
    Дни месяца (например 1,10-20,25) Указывается числа месяца, когда производить подключение к внешним сервисам.
    Дни недели Указывается дни недели, когда производить подключение к внешним сервисам.
    *Время (например 9:00,18:00) Указывается время, когда производить подключение к внешним сервисам.

    XML-подключение

    Поле Описание
    Настройка параметров подключения для публикации в Живую ленту
    ID Идентификатор подключения.

    Поле отображается только в режиме редактирования существующего вопроса.
    Тип подключения XML.
    Активность Признак активности подключения.
    СайтВыбор сайта, для которого настраивается подключение.
    *НазваниеПроизвольное название подключения.

    Обратите внимание, это название будет непосредственно отображаться в Живой ленте, поэтому оно должно быть простым и понятным.

    Сортировка Вес сортировки подключения; применяется при выводе списка подключений.
    Параметры события Живой ленты
    *Добавлять событие для Указывается тип события:
    • рабочей группы - выбор рабочей группы, к которой привязывается событие;
    • страницы пользователя - выбрать сотрудника, на странице которого будет отображаться данные;
    • ленты новостей - выбрать информационный блок новостей;
    • внешнего источника данных - без привязки к какой-либо сущности портала;
    Выберите рабочую группу Выбор рабочей группы из списка, для которой будет доступно событие.

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

    Выберите пользователя Указывается идентификатор пользователя в системе, либо с помощью кнопки [...] выбирается из списка пользователей в системе.

    Примечание: Опция доступна, только если выбран тип события - страницы пользователя.

    Лента новостей Выбор ленты новостей из списка доступных инфоблоков.

    Примечание: Опция доступна, только если выбран тип события - ленты новостей.

    Права на доступ к событию Выбор групп прав для доступа к событию: Все посетители, Авторизованные пользователи или Выбранные пользователи (можно указать идентификатор или выбрать из списка пользователей системы. По ссылке Добавить пользователя добавляются дополнительные пользователи).

    Примечание: Опция доступна, только если выбран тип события - внешнего источника данных.

    *Разрешить добавление комментариев к событию При выводе события в Живую ленту в ней будет доступен функционал комментариев к данному посту.

    Примечание: Опция доступна, только если выбран тип события - внешнего источника данных.

    Параметры подключения к источнику данных
    Стандартные схемы обмена Выбирается один из источников данных, входящих в состав системы: нет, Статистика сайта, Статистика по заказам.
    *URI Указывается путь к источнику данных.

    Примечание: Поле доступно, только если выбрана опция Стандартные схемы обмена - нет.

    Сервер Указывается сервер источника данных.

    Примечание: Поле доступно, только если выбраны опции Стандартные схемы обмена: Статистика сайта и Статистика по заказам.

    Метод веб-сервиса Указывается метод веб-сервиса.

    Примечание: Поле доступно, только если выбрана опция Стандартные схемы обмена: нет.

    Строка параметров для метода Указывается строка параметров для метода веб-сервиса.
    Логин Указывается логин для подключения к веб-сервису.
    Пароль Указывается пароль для подключения к веб-сервису.
    Расписание автоматической публикации
    *Время последней генерации выпуска (DD.MM.YYYY HH:MI:SS) Выбирается время и дата последнего подключения.
    Дни месяца (например 1,10-20,25) Указывается числа месяца, когда производить подключение к внешним сервисам.
    Дни недели Указывается дни недели, когда производить подключение к внешним сервисам.
    *Время (например 9:00,18:00) Указывается время, когда производить подключение к внешним сервисам.

    * - поля, обязательные для заполнения.

    Кнопки управления

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


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

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

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

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

    Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
    © «Битрикс», 2001-2019, «1С-Битрикс», 2019
    Наверх