Уведомления о новой задаче в Alfresco по email

Пользователи Alfresco, регулярно работающие с бизнес-процессами, обычно хотят получать уведомления о новой задаче по электронной почте (а еще по смс, в Jabber, Skype итд, но это потом).

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

Оба способа требуют предварительной настройки почтового сервера. Для этого в файл tomcat/shared/classes/alfresco-global.properties пропишем информацию о том, от чьего имени будут отправляться уведомления. Например, так:

mail.host=127.0.0.1
mail.port=25
mail.username=noreply
mail.password=qwerty

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

mail.protocol=smtps
mail.smtps.starttls.enable=true
mail.smtps.auth=true

Для того, чтобы начать использовать новые настройки нужно перезагрузить Alfresco.

А теперь к способам:

1. Сложный
В описании бизнес-процесса можно использовать JavaScript, отправляющий письмо нна произвольный email и произвольным текстом. Пример, как это делается, можно найти в этой статье: www.ossportal.ru/technologies/alfresco/blogs/141

      <script>
        <![CDATA[
          logger.log("PublishPaperProcess: Approved");
          if (tcwf_notifyMe)
          {
            var mail = actions.create("mail");
            mail.parameters.to = initiator.properties["cm:email"];
            mail.parameters.subject = "Публикация статьи";
            mail.parameters.text = "Добрый день. Ваша статья прошла проверку редактора и отправлена техническому редактору на рассмотрение.";
            mail.execute(bpm_package);
            }
          ]]>
      </script>

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

Плюсы использования этого способа:

• Вы можете сами задать текст уведомления, и этот текст может быть специфичный для каждого типа задачи.
• Вы можете отправлять уведомления произвольному пользователю в произвольный момент времени. В приведенном примере необязательно ставить пользователю задачу "Ваша статья прошла проверку", которую он просмотрит и закроет, нажав "Ок". Уведомление может прийти на email и не оставить никаких следов в системе.

Минусы использования этого способа:

• Если почтовый сервер недоступен, задача не завершится (не поставится). Пользователь должен дождаться, когда почтовый сервер будет доступен, и только тогда завершить задачу.
• Если систему используют люди, говорящие на разных языках (например в разных филиалах в одной компании), они все будут получать письма на русском. Интерфейс системы может быть локализован, но текст уведомления "жестко" вписан в процесс и не может меняться.
• JavaScript, отправляющий уведомления, нужно добавлять для каждой задачи в каждом бизнес-процессе.
• Обратная сторона второго пункта среди "плюсов": в системе не остается никаких следов о том, что какому-то сотруднику ушло какое-то письмо. Если от этого письма зависили дальнейшие действия, и они не были выполнены, сотрудник всегда может "свалить" невыполнение задачи на отсутствие письма, что никто не проверит.

Когда использовать этот способ:

• Когда вам нужно отправить нестандартное письмо, содержащее нестандартные данные, и без него никак нельзя обойтись.

2. Простой:
В Alfresco встроен сервис отправки уведомлений. И именно его нужно использовать, чтобы избежать всех минусов первого способа.
Все типы бизнес-процессов наследуются из стандартных типов Alfresco. То есть во всех процессах можно использовать переменные, введенные в Alfresco. За отправку уведомлений о новой задаче отвечает значение свойства bpm:sendEMailNotifications из модели bpmModel. По умолчанию, это значение - "0", то есть уведомление не отправляется. Для отправки уведомления его нужно изменить на "1". Как это сделать?
Добавим в конфигурацию Share первого этапа своего произвольного процесса отображение поля bpm:sendEMailNifications и включим его по умолчанию, используя шаблон Alfresco:

<config evaluator="task-type" condition="wf:startTask">
  <forms>
    <form>
      <field-visibility>
        <show id="bpm:workflowDescription" />
        <show id="bpm:assignee" />
        <show id="bpm:sendEMailNotifications"/>
        <show id="packageItems" />
      </field-visibility>
      <appearance>
        <set id="task-info" appearance="title" label-id="" template="/org/alfresco/components/form/2-column-set.ftl"/>
        <set id="documents" appearance="title" label-id="alvex.workflow.related-documents" />
        <field id="bpm:workflowDescription" label-id="alvex.workflow.task-summary" set="task-info" mandatory="true"/>
        <field id="bpm:assignee" label-id="alvex.workflow.bpm_assignee" set="task-info">
          <control template="/orgchart-picker.ftl" />
        </field>
        <field id="bpm:sendEMailNotifications" set="task-info">
            <control template="/org/alfresco/components/form/controls/workflow/email-notification.ftl" />
        </field>
      </appearance>
    </form>
  </forms>
</config>  

После того, как уведомления включены в первой задаче, все остальные задачи процесса также будут отправлять уведомления. По умолчанию в Alfresco пока что нет шаблона уведомления о новой задаче на русском языке. Появится, начиная с 4.1.4 и 4.2.d(e?). Для его добавления в систему:

1. Скопируем файл dl.dropbox.com/u/2916264/wf-email_ru.html.ftl в репозиторий системы в папку Data Dictionary > Email Templates > Workflow Notification (или Словарь данных > Шаблоны сообщений электронной почты > Уведомление о бизнес-процессе, если вам не повезло установить Alfresco на машину с русской локалью).
2. Поправим перевод темы письма в файле tomcat/webapps/alfresco/WEB-INF/classes/alfresco/messages/notification-service_ru.properties, изменив перевод строк assigned-task и new-pooled-task (последние 2 строки) на:

assigned-task=\u0412\u0430\u043c \u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u0430 \u0437\u0430\u0434\u0430\u0447\u0430
new-pooled-task=\u041d\u043e\u0432\u0430\u044f \u043d\u0435\u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u043d\u0430\u044f \u0437\u0430\u0434\u0430\u0447\u0430

Чтобы второй пункт вступил в силу, перезагрузим Alfresco.
Нестандартные поля задачи не переводятся, но все остальное локализовано (ссылка будет правильной, если у машины настроены DNS и прописаны hosts):


Плюсы использования этого способа:

• Если почтовый сервер недоступен, и не удается отправить письмо, то задача успешно завершается (ставится), хотя уведомление и не отправлено. 
• Письмо отправляется на языке инициатора задачи. Так как обычно разные филиалы в разных странах редко взаимодействуют между собой в рамках бизнес-процессов, то обычно письмо отправляется и на языке получателя.
• Шаблон письма содержит основную информацию о задаче: название, сроки, ссылки на документы, что позволяет использовать сервис во всех процессах.
• Добавляя уведомления по email к первой задаче в процессе, вы добавляете уведомления для всех задач.

Минусы использования этого способа:

• Письмо стандартно и отправляется только при постановке задачи. Если вам нужна отправка письма НЕ исполнителю и НЕ в момент постановки задачи, то все равно придется использовать первый способ.

Когда использовать этот способ:

• Всегда, когда возможно.