Программный продукт «QP8.Framework» (стр. 10 )

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

в родительском контенте создать поле «Классификатор», создать нужное количество контентов-расширений. В каждом из этих контентов нужно создать поле «Связь» типа O2M, сослаться на созданное поле классификатора и включить опцию «Агрегированное».

В ГПИ бекэнда при создании/изменении статьи значение для поля «Классификатор» задаётся с помощью выпадающего списка, в качестве элементов которого используются названия подготовленных контентов-расширений. После выбора значения в форму создания/изменения статьи загружаются все поля выбранного контента-расширения (кроме поля «Cвязь» типа O2M, которое реализует отношение агрегации).

Свойства поля:

Название	Описание
Изменяемое поле (Changeable)	Указатель, разрешено ли изменение значения поля после создания статьи
Использовать права доступа по типам (Use type security)	Указатель, требуется ли ограничить права доступа по типу элемента (страница, виджет)

Строковое перечисление (String Enum)

Тип поля реализован на базе типа «Строка». При создании поля следует задать набор строковых значений. Используется в бекэнде при создании и изменении статьи. Пользователю предоставляется возможность выбрать одно значение из набора.

В БД сохраняются строковые значения.

Свойства поля:

Название	Описание
Использовать группу радиокнопок (Show as Radio Button Group)	Указатель, что для вывода набора в ГПИ требуется использовать группу переключателей. По умолчанию отключено. В этом случае в ГПИ используется выпадающий список.
Значения (Values)	Данные для значения. Для значения допускается задание следующих параметров: значение, сохраняемое в БД (Value); значение, выводимое в ГПИ (Alias); указатель, что значение следует выводить в ГПИ по умолчанию (Default).

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

Копирование поля выполняется одним из следующих способов:

в контекстном меню поля выбрать пункт «Создать по образцу» (Create Like), в списке полей выбрать требуемый сайт и нажать кнопку «Создать по образцу» (Create Like).

В результате QP создаёт новый контент с именем Copy of Имя исходного контента.

Изменение свойств поля

Изменение свойств поля выполняется одним из следующих способов:

в контекстном меню поля выбрать пункт «Свойства» (Properties), в списке полей выбрать требуемое поле и нажать кнопку «Свойства» (Properties). Удаление поля

Удаление поля выполняется одним из следующих способов:

в контекстном меню поля выбрать пункт «Удалить» (Remove), в списке полей выбрать требуемое поле и нажать кнопку «Удалить» (Remove).
Статья (Article)

Статьи содержат данные контентов в соответствии со структурой, заданной с помощью полей. В БД статья является записью в таблице, используемой для контента.

Управлять статьями можно с помощью:

ГПИ бэкэнда (вкладка со списком статей и со свойствами статьи); Контекстного меню, вызванного для статьи. Команды: «Создать по образцу». Команда создает копию статьи; «Архивировать». Команда архивирует статью; «Удалить». Команда удаляет статью после ее подтверждения; «Свойства». Команда открывает вкладку со свойствами статьи; «История изменений». Команда выводит вкладку с историей изменений; «Версии». Команда выводит вкладку с версиями статей; «Права доступа». Команда открывает вкладку, задающую права доступа к текущей статье.

Взаимодействие со статьями доступно так же с помощью QP API (см. QP8 API).

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

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

Расписание видимости автоматически работает при доступе к контентам через объект типа «Publishing Container» (если не отключено в его настройках). Если нужна работа расписания при прямом доступе к БД, то необходимо фильтровать статьи по условию visible = 1.

Служебные свойства статьи

Название	Описание
CONTENT_ITEM_ID	Уникальный идентификатор статьи. Примечание: используется сквозная нумерация по всем контентам в пределах БД. Примечание: на это поле ссылаются поля типа «Связь».
CREATED	Дата создания статьи
MODIFIED	Дата последнего изменения статьи
ARCHIVE	Указатель, находится ли статья в Архиве статьей
VISIBLE	Указатель, доступна ли статья на веб-сайте. Используется функцией расписания.
LAST_MODIFIED_BY	Идентификатор пользователя, который последним изменил содержимое статьи
STATUS_TYPE_ID	Идентификатор статуса Workflow статьи

Архивная статья (Archive Article)

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

Работа с архивными статьями осуществляется в разделе «Архивные статьи» в контенте.

Поместить статью в архив можно с использованием ГПИ:

«Архивировать» (Move to Archive) в списке статей, «Архивировать» (Archive) на странице свойств статьи.

Примечание: статья может попасть в архив и при её удалении в случае, если в свойствах контента активировано свойство «Архивировать при удалении» (Archive on Removal).

Статья в архиве:

может быть удалена, не может быть отредактирована (предварительно её следует восстановить).

Восстановить статью из архива можно двумя способами:

«Восстановить» (Restore Selected) в списке архивных статей, «Восстановить» (Restore) на странице свойств архивированной статьи.

Примечание: команда «Восстановить» доступна в контекстном меню.

Также контекстное меню, для статьи, содержит команды:

«Удалить». Команда удаляет статью после ее подтверждения; «Свойства». Команда открывает вкладку со свойствами статьи.

При доступе к контенту через объект «Publishing Container» архивные статьи по умолчанию не показываются (может быть изменено в свойствах объекта). При прямом доступе к БД, если необходимо исключить архивные статьи, следует использовать условие archive = 0.

Взаимодействие с архивными статьями доступно так же с помощью QP API (см. QP8 API).

Уведомление (Notification)

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

ГПИ инструмента доступен в разделе «Уведомления» (Notifications) контента.

Внимание: для создания электронных писем c уведомлениями в конфигурационном файле QP должны быть указаны данные для работы с SMTP-сервером, ответственным за отправку электронных писем.

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

Архитектура уведомлений

Метод SendNotification (реализует алгоритм отправки уведомлений), Компонент сборки (используется для создания динамической страницы уведомления), Компонент HTTP-загрузки (используется для получения тела сообщения из динамической страницы), Почтовый компонент (отправка почтового сообщения), Глобальные настройки (хранятся в конфигурационном файле), Локальные настройки (хранятся в таблице NOTIFICATIONS).

Обобщённый алгоритм работы уведомлений Явно (из кода формата) или неявно (в результате действий пользователя) вызывается метод SendNotification. Данным методом определяются уведомления, которые подходят по типу события. Для каждого уведомления производится: сборка формата в динамическую страницу; загрузка динамической страницы с нужными параметрами (идентификатор статьи) и инициализация тела сообщения; инициализация всех необходимых полей сообщения; отправка электронного письма. Свойства уведомления

Основные свойства (Basic Parameters)

Название	Описание
Имя (Name)	Уникальный идентификатор уведомления (в пределах контента). Кроме этого, данное значение подставляется в поле «Тема отправляемого письма».
Внешнее (External)	Указатель, что уведомление должно быть обработано сторонней Системой.
Внешний URL (External URL)	URL для запроса к сторонней Системе, ответственной за обработку уведомления.
Использовать сервис для отправки (Use service for sending)	Указатель, требуется ли использовать службу формирования внешних уведомлений.
Создать формат по умолчанию (Create Default Format)	Доступно только при создании уведомления. После создания уведомления: В шаблоне «Default Notification Template» будет создан объект типа «Publishing Container»; В созданном объекте будет сгенерирован формат, связанный с уведомлением.
Формат (Format)	Выбор формата. Предлагаются все связанные с контентом форматы, принадлежащие объектам типа «Publishing Container».

События (Events)

Поддерживаются следующие типы событий:

Название	Описание события
Создание (Create)	Статья создана. Срабатывает при: создании новой статьи через ГПИ бекэнда; создании копии статьи с использованием функции «Создать по образцу» (Create like): через ГПИ бекэнда, в режиме OnScreen бекэнда; вызове метода AddFormToContent; вызове метода SendNotification с параметром for_create.
Изменение (Modify)	Существующая статья изменена. Срабатывает при: обновлении статьи через ГПИ бекэнда, вызове метода UpdateContentItem, вызове метода UpdateContentItemField, вызове метода SendNotification с параметром for_modify.
Удаление (Remove)	Статья удалена. Срабатывает при: удалении статьи через ГПИ бекэнда, вызове метода RemoveContentItem, вызове метода SendNotification с параметром for_remove.
Изменение статуса (Status Changed)	В статье достигнут указанный пользователем статус Workflow. Срабатывает при: изменении статуса статьи через ГПИ бекэнда, изменении статуса статьи с помощью метода UpdateContentItem, вызове метода SendNotification с параметром for_status_changed. Примечание: при изменении статьи через ГПИ бекэнда с одновременным изменением статуса срабатывают два события – «Изменение» и «Изменение статуса».
Частичное изменение статуса (Status Partially Changed)	В статье достигнут указанный пользователем статус Workflow при параллельном Workflow.
Запрос по требованию (Request On Demand)	Произошло событие из собственного кода Разработчика. Срабатывает при вызове метода SendNotification с параметром for_frontend.
Отложенная публикация (Delayed Publication)	Статья автоматически опубликована по расписанию публикации. Используется с Workflow в режиме расщепления статей.

Отправитель (Sender)

Название	Описание
Использовать имя отправителя по умолчанию (Use Default Sender Name)	Указатель, что требуется использовать имя отправителя по умолчанию. В качестве имени отправителя используется значение Q-Publishing Backend. Примечание: значение можно изменить в конфигурационном файле QP.
Имя отправителя (Sender Name)	Самостоятельно указанное имя отправителя.
Использовать e-mail пользователя QP8 (Use QP8 User Email)	Указатель, что в качестве значения поля From: требуется использовать адрес электронной почты пользователя QP.
E-mail	Самостоятельно указанное значение поля From:.
Пользователь QP8 (QP8 User)	Имя пользователя QP, чей адрес электронной почты требуется использовать в качестве значения поля From:.

Получатель (Receiver)

Название	Описание
Тип получателя (Receiver Type)	Выбор получателя уведомления. Доступные типы получателей: «Пользователь» (User), «Группа» (User Group), «Все пользователи из истории изменений» (Everyone in History), «Уведомление на поле из статьи» (E-Mail from Article Field), «Не уведомлять» (None). При использовании типа «Все пользователи из истории изменений» уведомление формируется на адреса электронной почты всех пользователей QP, указанных в истории изменений для статьи. Тип «Не уведомлять» используется в случае, если не требуется формировать и отправлять уведомление по электронной почте.
Пользователь (User)	Пользователь QP, на чей адрес электронной почту должно формироваться уведомление.
Группа (User Group)	Группа пользователей QP, все пользователи из которой должны получить уведомление на указанный ими адрес электронной почты.
Уведомление на поле из статьи (E-Mail from Article Field)	Поле контента, содержащее адрес электронной почты, который требуется использовать для формирования уведомления.