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

Примечание: адрес электронной почты получателя может быть определён в качестве параметра метода SendNotification. Данное значение имеет больший приоритет, чем значение, заданное в ГПИ бекэнда.

Дополнительные опции (Options)

Название	Описание
Посылать файлы как вложения (Send files as attachments)	Указатель, что содержимое полей типа «Файл» и «Изображение» следует добавлять в электронное письмо с уведомлением в виде вложений.

Сборка уведомления

Сборка требуемого набора уведомлений осуществляется кнопкой «Собрать» (Assemble).

Внешнее уведомление

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

Примечание: при использовании внешнего уведомления QP не осуществляет отправку электронных писем с уведомлениями.

Приёмник внешнего уведомления может быть реализован, например, как служба, которая сбрасывает кэш веб-приложения.

Рисунок 4. Создание внешнего уведомления.

При запросе к URL передаются следующие данные:

eventName (одна из строковых констант, определённых в классе Quantumart. QPublishing. NotificationEvent), id, contentId, siteId, visible, archive, splitted, statusName.

Если произошло событие «Изменение», «Изменение статуса» или «Частичное изменение статуса», то также передаются следующие данные:

oldVisible, oldArchive, oldStatusName.

Служба формирования внешних уведомлений

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

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

Если служба используется, то все задачи на отправку запросов помещаются в очередь и собираются в пакеты. Служба регулярно обрабатывает очередь и осуществляет обращения в внешним URL. Обращения выполняются методом POST, в запросе передаются как служебные данные, так и значения всех полей статьи, с которой связано уведомление. В случае, если принимающая запрос сторона не смогла его обработать, то позднее служба отправляет запрос повторно. Результат работы службы не оказывает влияния на успешность выполнения операции в QP, в результате которой возникает событие, требующее формирования уведомления (например, невозможность сформировать уведомление о создании статьи не помешает операции по созданию этой статьи; в предыдущих версиях продукта успешность операции зависела от формирования уведомления).

Workflow

Инструмент «Workflow» позволяет организовать автоматизированный документооборот для статей. Каждый Workflow представляет собой набор правил, которые должны быть в определённом порядке применены к статье, чтобы она была опубликована на веб-сайте. Фактически набор правил представляет собой упорядоченный список статусов (этапов Workflow), через которые последовательно должна пройти статья. При достижении максимального статуса Workflow статья считается опубликованной. На каждый этап Workflow назначается пользователь либо группа пользователей, которые получают возможность переводить статью на данный этап.

Создание и изменение Workflow осуществляется в бекэнде на уровне сайта (раздел «Workflows» в дереве сущностей).

Создание Workflow возможно с помощью:

ГПИ бэкэнда (сущность «Сайт» → сущность «Workflow» → список Workflow → команда «Добавить новый Workflow»); Исполнения команды «Создать новый Workflow» в контекстном меню для сущности «Workflow».

Изменение Workflow возможно с помощью:

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

Назначить Workflow можно для следующих объектов:

Название	Описание
Контент	Workflow применяется ко всем статьям контента (существующим и новым).
Статья	Статья может: наследовать настройки Workflow от контента (поведение по умолчанию), иметь собственный Workflow (даже если на контент не назначен Workflow), не использовать Workflow.

По умолчанию используется режим расщепления статей (Split articles). В этом режиме статья, ранее опубликованная на веб-сайте (получившая максимальный статус), не снимается с публикации после понижения её статуса. Существующая версия статьи выводится на веб-сайте до тех пор, пока статья повторно не будет доведена до максимального статуса. После этого будет опубликована новая версия статьи вместо старой.

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

Статус

Статус используется в Workflow. Создание и изменение статусов осуществляется в бекэнде на уровне сайта (раздел «Статусы» (Statuses) в дереве сущностей).

Существуют следующие системные статусы:

Название	Вес	Описание
None	0	Используется по умолчанию при создании статьи Примечание: не может быть использован в Workflow.
Created	10	Статья создана
Approved	50	Статья изменена
Published	100	Статья опубликована

Примечание: создать, изменить или удалить системные статусы невозможно.

Можно создать собственные статусы, присваивая им незанятые веса в интервале значений от 0 до 100. В Workflow могут быть использованы как допустимые системные, так и собственные статусы.

Свойства статуса

Название	Описание
Имя (Name)	Имя статуса
Описание (Description)	Описание статуса
Вес (Weight)	Вес статуса
Цвет (Color)	Цвет для статьи с данным статусом. Используется в ГПИ для списка статей в качестве фонового цвета в блоке с данными по статье. Значения «Цвет» и «Альтернативный цвет» используются для чётных и нечётных статей соответственно. Принимается значение в формате HEX.
Альтернативный цвет (Alternate color)

Создание и изменение Workflow

Доступные возможности:

задание этапов (выбор статусов) Workflow; задание контентов, для статей в которых нужно использовать Workflow. Для каждого этапа: назначение пользователя или группы пользователей; задание комментария.

Примечание: при использовании объекта «Publishing Containers» рекомендуется последним статусом делать Published, так как объект по умолчанию настроен на вывод статей с данным статусом.

Свойства Workflow

Название	Описание
Имя (Name)	Название Workflow
Описание (Description)	Описание Workflow
Создавать автоматические уведомления (Create Auto Notifications)	Указатель, требуется ли автоматически создать уведомление для Workflow. Примечание: относится ко внутренним уведомлениям.
Статусы (Statuses)	Набор статусов для использования в Workflow
Контенты (Contents)	Набор контентов, для которых должен использоваться Workflow. Примечание: для выбора доступны только контенты, для которых не задан Workflow.

Использование Workflow

Если на контент или статью назначен Workflow, то в ГПИ бекэнда на странице изменения статьи доступна смена статуса статьи.

При выборе максимального статуса Workflow пользователю становится доступна опция «Отложить публикацию новой версии» (Schedule New Version Publication), которая позволяет установить расписание публикации статьи.

Дополнительные данные

Если на статью назначен Workflow, то вступают в силу дополнительные ограничения прав доступа:

Только пользователь-участник Workflow (как лично, так и в составе группы) может удалять и изменять статьи, находящиеся в Workflow; Пользователь-участник Workflow может удалить статью, находящуюся в Workflow, только если он явно или в составе группы назначен на последний этап Workflow.

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

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

При создании новой статьи она получает статус:

None, если на контент назначен Workflow; Published, если Workflow не назначен.

Примечание: при создании копии для статьи, находящейся в Workflow, копия создается со статусом None.

Параллельный Workflow

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