Activiti: пример создания workflow

На форуме прозвучала просьба написать пример воркфлоу на activiti с подробными объяснениями. Попытаюсь просьбу исполнить. Пишу в этом блоге впервые, прошу строго не судить.

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

Пример создания workflow в ECM Alfresco

Создание workflow. Продолжение

Давайте имплементируем следующий сценарий:

1. Регистратор загружает документ-директиву и инициирует процесс, передавая документ начальнику некоего подразделения.

2. Начальник знакомится с содержанием документа-директивы, формирует поручение и отправляет поручение на исполнение, выбирая исполнителя.

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

4. Начальник утверждает исполнение, и процесс заканчивается. Иначе -  начальник возвращает исполнителю поручение на доработку, и процесс возвращается к шагу 3.

Получится вот такой маршрут для документа:

Итак, создаем модель процесса DirectiveWorkflowModel.xml:

<?xml version="1.0" encoding="UTF-8"?>
<!-- Описание модели бизнес-процесса -->
<model name="dir:workflowmodel" xmlns="http://www.alfresco.org/model/dictionary/1.0">
 
	<!-- Импорт необходимых описаний -->
	<imports>
		<import uri="http://www.alfresco.org/model/dictionary/1.0" prefix="d" />
		<import uri="http://www.alfresco.org/model/bpm/1.0" prefix="bpm" />
		<import uri="http://www.alfresco.org/model/content/1.0" prefix="cm"/>
	</imports>
 
	<!-- Описываем пространство имен для нашего процесса -->
	<namespaces>
		<namespace uri="http://www.somecompany.ru/model/workflow/1.0" prefix="dir" />
	</namespaces>
 
	<types>
		<!-- Подача директивы -->
		<type name="dir:start">
			<!-- Наследуем от bpm:startTask -->
			<parent>bpm:startTask</parent>
			<!-- Указываем обязательные аспекты -->
			<mandatory-aspects>
				<!-- Начальник подразделения -->
				<aspect>bpm:assignee</aspect>
			</mandatory-aspects>
		</type>
 
		<!-- Ознакомление с директивой и передача на исполнение -->
		<type name="dir:inspection">
			<!-- Наследуем от bpm:workflowTask -->
			<parent>bpm:workflowTask</parent>
 
			<!-- Доступ к документам пакета -->
			<overrides>
				<!-- Документ может быть добавлен -->
				<property name="bpm:packageActionGroup">
					<default>add_package_item_actions</default>
				</property>
				<!-- Документ может быть отредактирован -->
				<property name="bpm:packageItemActionGroup">
					<default>edit_package_item_actions</default>
				</property>
			</overrides>
				<!-- Указываем обязательные аспекты -->
				<mandatory-aspects>
					<!-- Исполнитель -->
					<aspect>dir:performer</aspect>
				</mandatory-aspects>
		</type>
 
		<!-- Исполнение поручения -->
		<type name="dir:perform">
			<parent>bpm:workflowTask</parent>
			<!-- Доступ к документам пакета -->
			<overrides>
				<!-- Документ может быть добавлен -->
				<property name="bpm:packageActionGroup">
					<default>add_package_item_actions</default>
				</property>
				<!-- Документ может быть отредактирован -->
				<property name="bpm:packageItemActionGroup">
					<default>edit_package_item_actions</default>
				</property>
			</overrides>
		</type>
 
		<!-- Проверка исполнения -->
		<type name="dir:approve">
			<!-- Наследуем от bpm:activitiOutcomeTask -->
			<!-- Новый объект, появился с введением activiti в альфреско -->
			<parent>bpm:activitiOutcomeTask</parent>
			<!-- Свойства -->
			<properties>
				<!-- Утвердить исполнение или же отправить на доработку -->
				<property name="dir:appOutcome">
					<type>d:text</type>
					<default>reject</default>
					<constraints>
						<constraint name="dir:propAppOutcome" type="LIST">
							<parameter name="allowedValues">
								<list>
									<!-- Утвердить -->
									<value>approve</value>
									<!-- Отправить на доработку -->
									<value>reject</value>
								</list>
							</parameter>
							<parameter name="caseSensitive">
								<value>true</value>
							</parameter>
						</constraint>
					</constraints>
				</property>
			</properties>
			<!-- Доступ к документам пакета -->
			<overrides>
				<!-- Документ может быть добавлен -->
				<property name="bpm:packageActionGroup">
					<default>add_package_item_actions</default>
				</property>
				<!-- Документ может быть отредактирован -->
				<property name="bpm:packageItemActionGroup">
					<default>edit_package_item_actions</default>
				</property>
			</overrides>
		</type>
	</types>
 
	<aspects>
		<aspect name="dir:performer">
			<associations>
				<association name="dir:performer">
					<source>
						<mandatory>true</mandatory>
						<many>false</many>
					</source>
					<target>
						<class>cm:person</class>
						<mandatory>true</mandatory>
						<many>false</many>
					</target>
				</association>
			</associations>
		</aspect>
	</aspects>
</model>

Помещаем модель в ALFRESCO_HOME/tomcat/shared/classes/alfresco/extension/model/

Создаем процесс DirectiveProcess.xml:

<?xml version="1.0" encoding="UTF-8" ?>
 
<!-- Объявление необходимых пространств имен -->
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:activiti="http://activiti.org/bpmn"
	xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:omgdc="http://www.omg.org/spec/DD/20100524/DC"
	xmlns:omgdi="http://www.omg.org/spec/DD/20100524/DI" typeLanguage="http://www.w3.org/2001/XMLSchema"
	expressionLanguage="http://www.w3.org/1999/XPath" targetNamespace="http://www.activiti.org/test">
 
	<!-- Начало описания процесса -->
	<process id="PerformDirective" name="Исполнение внешних директив">
 
		<!-- Начальный узел процесса -->
		<startEvent id="start"	activiti:formKey="dir:start" />
 
		<!-- Переход от старта к задаче ознакомления с директивой -->
		<sequenceFlow id='flow1' sourceRef='start' targetRef='inspection' />
 
		<!-- Ознакомление с директивой и передача на исполнение -->
		<userTask id="inspection" name="Ознакомиться с документом и передать на исполнение."	
			activiti:formKey="dir:inspection" >
			<extensionElements>
				<!-- Скрипт при создании задачи -->
				<!-- Устанавливаем срок исполнения и приоритет, если те не указаны -->
				<!-- Запоминаем начальника -->
				<activiti:taskListener event="create" 
					class="org.alfresco.repo.workflow.activiti.tasklistener.ScriptTaskListener">
					<activiti:field name="script">
						<activiti:string>
							if (typeof bpm_workflowDueDate != 'undefined') task.dueDate = bpm_workflowDueDate
							if (typeof bpm_workflowPriority != 'undefined') task.priority = bpm_workflowPriority;
							execution.setVariable('manager', bpm_assignee.properties.userName);
						</activiti:string>
					</activiti:field>
				</activiti:taskListener>
				<!-- Скрипт при закрытии задачи -->
				<!-- Запоминаем исполнителя -->
				<activiti:taskListener event="complete" 
					class="org.alfresco.repo.workflow.activiti.tasklistener.ScriptTaskListener">
					<activiti:field name="script">
						<activiti:string>
							var performer = task.getVariable('dir_performer');
							execution.setVariable('performer', performer.properties.userName);
						</activiti:string>
					</activiti:field>
				</activiti:taskListener>
			</extensionElements>
			<!-- Задача для начальника -->
			<humanPerformer>
				<resourceAssignmentExpression>
					<formalExpression>${bpm_assignee.properties.userName}</formalExpression>
				</resourceAssignmentExpression>
			</humanPerformer>
		</userTask>
 
		<!-- Переход от ознакомления с директивой к исполнениию -->
		<sequenceFlow id='flow2' sourceRef='inspection' targetRef='perform' />
 
		<!--Исполнение поручения -->
		<!-- Второй способ обозначить владельца задачи - через activiti:assignee -->
		<!-- Задача для исполнителя -->
		<userTask id="perform" name="Исполнение поручения."	activiti:formKey="dir:perform" 
			activiti:assignee="${performer}" >
			<extensionElements>
				<!-- Скрипт при создании задачи -->
				<!-- Устанавливаем срок исполнения и приоритет, если те не указаны -->
				<activiti:taskListener event="create" 
					class="org.alfresco.repo.workflow.activiti.tasklistener.ScriptTaskListener">
					<activiti:field name="script">
						<activiti:string>
							if (typeof bpm_workflowDueDate != 'undefined') task.dueDate = bpm_workflowDueDate
							if (typeof bpm_workflowPriority != 'undefined') task.priority = bpm_workflowPriority;
						</activiti:string>
					</activiti:field>
				</activiti:taskListener>
			</extensionElements>
		</userTask>
 
		<!-- Переход от исполнениия к проверке исполнения -->
		<sequenceFlow id='flow3' sourceRef='perform' targetRef='approve' />
 
		<!-- Проверка исполнения -->
		<!-- Задача для начальника -->
		<userTask id="approve" name="Проверить исполнение поручения."	activiti:formKey="dir:approve"
			activiti:assignee="${manager}" >
			<extensionElements>
				<!-- Скрипт при создании задачи -->
				<!-- Устанавливаем срок исполнения и приоритет, если те не указаны -->
				<activiti:taskListener event="create" 
					class="org.alfresco.repo.workflow.activiti.tasklistener.ScriptTaskListener">
					<activiti:field name="script">
						<activiti:string>
							if (typeof bpm_workflowDueDate != 'undefined') task.dueDate = bpm_workflowDueDate
							if (typeof bpm_workflowPriority != 'undefined') task.priority = bpm_workflowPriority;
						</activiti:string>
					</activiti:field>
				</activiti:taskListener>
				<!-- Скрипт при закрытии задачи -->
				<!-- Устанавливаем результат -->
				<activiti:taskListener event="complete" 
					class="org.alfresco.repo.workflow.activiti.tasklistener.ScriptTaskListener">
					<activiti:field name="script">
						<activiti:string>
							execution.setVariable('dir_appOutcome', task.getVariable('dir_appOutcome'));
						</activiti:string>
					</activiti:field>
				</activiti:taskListener>
			</extensionElements>
		</userTask>
 
		<!-- Переход от проверки исполнения к развилке -->
		<sequenceFlow id='flow4' sourceRef='approve' targetRef='decision' />
 
		<!-- Развилка: вернуться ли к исполнению или же окончить процесс -->
		<exclusiveGateway id="decision" name="Decision" /> 
 
		<!-- Исполнение не утверждено: вернуться к задаче исполнения -->
		<sequenceFlow id='flow5' sourceRef='decision' targetRef='perform' >
			<conditionExpression xsi:type="tFormalExpression">${dir_appOutcome == 'reject'}</conditionExpression>
		</sequenceFlow>
 
		<!-- Исполнение утверждено: окончить процесс -->
		<sequenceFlow id='flow6' sourceRef='decision' targetRef='end' />
 
		<!-- Конец процесса -->
		<endEvent id="end" />
 
	</process>
</definitions>

Помещаем процесс в ALFRESCO_HOME/tomcat/shared/classes/alfresco/extension/workflows/

Локализуем бизнес-процесс (dirWorkflow_ru_RU.properties):

PerformDirective.workflow.title=Обработка внешних директив
PerformDirective.workflow.description=Ознакомиться с директивой и исполнить ее
 
listconstraint.dir_propAppOutcome.approve=Утвердить исполнение
listconstraint.dir_propAppOutcome.reject=Послать на доработку
 
PerformDirective.node.inspection.transition.title=Направить на исполнение
PerformDirective.node.inspection.transition.description=Направить на исполнение
 
PerformDirective.node.perform.transition.title=Передать на утверждение
PerformDirective.node.perform.transition.description=Передать на утверждение
 

Помещаем локализацию в ALFRESCO_HOME/tomcat/shared/classes/alfresco/extension/messages/

Настраиваем вэб-клиент (web-client-config-custom.xml):

<alfresco-config>
 
	<config evaluator="string-compare" condition="Languages">
		<languages>
			<language locale="ru_RU">Russian</language>
		</languages>
	</config>
 
	<!--  Отображение  бизнес процессов -->
 
	<!-- Подача директивы -->
	<config evaluator="node-type" condition="dir:start" replace="true">
		<property-sheet>
			 <!-- Разделитель -->
      <separator name="sep1" display-label-id="general" component-generator="HeaderSeparatorGenerator" />
      <!-- Описание процесса -->
      <show-property name="bpm:workflowDescription" component-generator="TextAreaGenerator" />
      <!-- Выбор начальника -->
      <show-association name="bpm:assignee" />
		</property-sheet>
	</config>
 
	<!-- Ознакомление с директивой и передача на исполнение -->
	<config evaluator="node-type" condition="dir:inspection" replace="true">
		<property-sheet>
			 <!-- Разделитель -->
      <separator name="sep1" display-label-id="general" component-generator="HeaderSeparatorGenerator" />
      <!-- Описание процесса -->
      <show-property name="bpm:workflowDescription" component-generator="TextAreaGenerator" />
      <!-- Комментарий -->
      <show-property name="bpm:comment" component-generator="TextAreaGenerator" />
      <!-- Выбор исполнителя -->
      <show-association name="dir:performer" />
		</property-sheet>
	</config>
 
	<!-- Исполнение поручения -->
	<config evaluator="node-type" condition="dir:perform" replace="true">
		<property-sheet>
			 <!-- Разделитель -->
      <separator name="sep1" display-label-id="general" component-generator="HeaderSeparatorGenerator" />
      <!-- Описание процесса -->
      <show-property name="bpm:workflowDescription" component-generator="TextAreaGenerator" />
      <!-- Комментарий -->
      <show-property name="bpm:comment" component-generator="TextAreaGenerator" />
		</property-sheet>
	</config>
 
	<!-- Проверка исполнения -->
	<config evaluator="node-type" condition="dir:approve" replace="true">
		<property-sheet>
			 <!-- Разделитель -->
      <separator name="sep1" display-label-id="general" component-generator="HeaderSeparatorGenerator" />
      <!-- Описание процесса -->
      <show-property name="bpm:workflowDescription" component-generator="TextAreaGenerator" />
      <!-- Комментарий -->
      <show-property name="bpm:comment" component-generator="TextAreaGenerator" />
      <show-property name="dir:appOutcome" />
		</property-sheet>
	</config>
 
</alfresco-config>

Помещаем вэб-клиент в ALFRESCO_HOME/tomcat/shared/classes/alfresco/extension

Создаем загрузчик (dir-workflow-context.xml):

<?xml version='1.0' encoding='UTF-8'?>
 
<!-- Описание моделей и процессов для загрузки -->
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
 
<beans>
 
  <!-- Регистрируем ресурсы -->
  <bean id="dir.workflowBootstrap" parent="workflowDeployer">
    <property name="workflowDefinitions">
      <list>
        <props>
          <!-- Тип процесса -->
          <prop key="engineId">activiti</prop>
          <!-- Путь -->
          <prop key="location">alfresco/extension/workflows/DirectiveProcess.xml</prop>
          <!-- MIME -->
          <prop key="mimetype">text/xml</prop>
          <!-- Загружать каждый раз -->
          <prop key="redeploy">true</prop>
        </props>
      </list>
    </property>
 
    <!-- Локализация -->
    <property name="labels">
      <list>
        <value>alfresco.extension.messages.dirWorkflow</value>
      </list>
    </property>
 
    <!-- Список моделей для загрузки -->
    <property name="models">
        <list>
            <value>alfresco/extension/model/DirectiveWorkflowModel.xml</value>
        </list>
    </property>
 
  </bean>
 
</beans>
<!-- Конец описания -->

И помещаем его в ALFRESCO_HOME/tomcat/shared/classes/alfresco/extension

Настраиваем пользовательский интерфейс для share (web-extension/share-config-custom.xml):

<!-- Настройки интерфейса -->
<alfresco-config>
 
	<!-- Этим элементом можно включить режим отладки -->
	<config replace="true">
		<flags>
			<client-debug>false</client-debug>
			<client-debug-autologging>false</client-debug-autologging>
		</flags>
	</config>
 
	<!-- Отображение информации при просмотре бизнес-процесса -->
	<config evaluator="string-compare" condition="activiti$PerformDirective">
		<forms>
			<form>
				<!-- Список видимых полей -->
				<field-visibility>
					<show id="bpm:workflowDescription"/>
					<show id="bpm:assignee"/>
					<show id="packageItems" />
				</field-visibility>
				<appearance>
					<!-- Блоки -->
					<set id="" appearance="title" label-id="workflow.set.general" />
					<set id="assignee" appearance="title" label-id="dir_assignee" />					
					<set id="items" appearance="title" label-id="dir_items" />
					<!-- Отображение полей -->
					<field id="bpm:workflowDescription" label-id="dir_description">
						<control template="/org/alfresco/components/form/controls/textarea.ftl">
							<control-param name="style">width: 95%</control-param>
						</control>
					</field>
					<field id="bpm:assignee" label-id="dir_assign_to" set="assignee" />
					<field id="packageItems" set="items" label-id="dir_pitems" />
				</appearance>
			</form>
		</forms>
	</config>
 
	<!-- Начальный узел процесса -->
	<config evaluator="task-type" condition="dir:start">
		<forms>
			<form>
				<!-- Список видимых полей -->
				<field-visibility>
					<show id="bpm:workflowDescription"/>
					<show id="bpm:assignee"/>
					<show id="packageItems" />
				</field-visibility>
				<appearance>
					<!-- Блоки -->
					<set id="" appearance="title" label-id="workflow.set.general" />
					<set id="assignee" appearance="title" label-id="dir_assignee" />					
					<set id="items" appearance="title" label-id="dir_items" />
					<!-- Отображение полей -->
					<field id="bpm:workflowDescription" label-id="dir_description">
						<control template="/org/alfresco/components/form/controls/textarea.ftl">
							<control-param name="style">width: 95%</control-param>
						</control>
					</field>
					<field id="bpm:assignee" label-id="dir_assign_to" set="assignee" />
					<field id="packageItems" set="items" label-id="dir_pitems" />
				</appearance>
			</form>
		</forms>
	</config>
 
	<!-- Ознакомление с директивой и передача на исполнение -->
	<config evaluator="task-type" condition="dir:inspection">
		<forms>
			<form>
				<!-- Список видимых полей -->
				<field-visibility>
					<show id="bpm:workflowDescription"/>
					<show id="bpm:comment"/>
					<show id="dir:performer"/>
					<show id="transitions" />
					<show id="packageItems" />
				</field-visibility>
				<appearance>
					<!-- Блоки -->
					<set id="" appearance="title" label-id="workflow.set.general" />
					<set id="assignee" appearance="title" label-id="dir_assignee" />
					<set id="trans" appearance="" />
					<set id="items" appearance="title" label-id="dir_items" />
					<!-- Отображение полей -->
					<field id="bpm:workflowDescription" label-id="dir_description">
						<control template="/org/alfresco/components/form/controls/textarea.ftl">
							<control-param name="style">width: 95%</control-param>
						</control>
					</field>
					<field id="bpm:comment" label-id="dir_comment" />
					<field id="dir:performer" label-id="dir_performer" set="assignee" />
					<field id="transitions" set="trans" />
					<field id="packageItems" set="items" label-id="dir_pitems" />
				</appearance>
			</form>
		</forms>
	</config>
 
	<!--Исполнение поручения -->
	<config evaluator="task-type" condition="dir:perform">
		<forms>
			<form>
				<!-- Список видимых полей -->
				<field-visibility>
					<show id="bpm:workflowDescription"/>
					<show id="bpm:comment"/>
					<show id="transitions" />
					<show id="packageItems" />
				</field-visibility>
				<appearance>
					<!-- Блоки -->
					<set id="" appearance="title" label-id="workflow.set.general" />
					<set id="trans" appearance="" />
					<set id="items" appearance="title" label-id="dir_items" />
					<!-- Отображение полей -->
					<field id="bpm:workflowDescription" label-id="dir_description">
						<control template="/org/alfresco/components/form/controls/textarea.ftl">
							<control-param name="style">width: 95%</control-param>
						</control>
					</field>
					<field id="bpm:comment" label-id="dir_comment" />
					<field id="transitions" set="trans" />
					<field id="packageItems" set="items" label-id="dir_pitems" />
				</appearance>
			</form>
		</forms>
	</config>
 
	<!--Проверка исполнения -->
	<config evaluator="task-type" condition="dir:approve">
		<forms>
			<form>
				<!-- Список видимых полей -->
				<field-visibility>
					<show id="bpm:workflowDescription"/>
					<show id="bpm:comment"/>
					<show id="dir:appOutcome" />
					<show id="packageItems" />
				</field-visibility>
				<appearance>
					<!-- Блоки -->
					<set id="" appearance="title" label-id="workflow.set.general" />
					<set id="items" appearance="title" label-id="dir_items" />
					<!-- Отображение полей -->
					<field id="bpm:workflowDescription" label-id="dir_description">
						<control template="/org/alfresco/components/form/controls/textarea.ftl">
							<control-param name="style">width: 95%</control-param>
						</control>
					</field>
					<field id="bpm:comment" label-id="dir_comment" />
					<field id="dir:appOutcome" label-id="workflow.field.outcome" >
						<control template="/org/alfresco/components/form/controls/workflow/activiti-transitions.ftl" />
					</field>
					<field id="packageItems" set="items" label-id="dir_pitems" />
				</appearance>
			</form>
		</forms>
	</config>
 
</alfresco-config>

Помещаем вэб-клиент в ALFRESCO_HOME/tomcat/shared/classes/alfresco/web-extension

Локализуем метки интерфейса (dir_ru_RU.properties):

dir_assignee=Назначить ответственного
dir_assign_to=Начальник подразделения
dir_performer=Исполнитель
dir_items=Документы
dir_pitems=Директивы и пр. документы
dir_description=Описание
dir_comment=Комментарий
 

Помещаем локализацию в ALFRESCO_HOME/tomcat/shared/classes/alfresco/web-extension/messages/

Конфигурируем Spring bean для локализации интерфейса (custom-slingshot-application-context):

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
 
<beans>
 
   <bean id="dir.resources" class="org.springframework.extensions.surf.util.ResourceBundleBootstrapComponent">
      <property name="resourceBundles">
         <list>
            <value>alfresco.web-extension.messages.dir</value>
         </list>
      </property>
   </bean>
 
</beans>

Записываем его в ALFRESCO_HOME/tomcat/shared/classes/alfresco/web-extension

После рестарта альфрески заходим в localhost:8080/share, где в списке процессов мы видим наш процесс "Обработка внешних директив (Ознакомиться с директивой и исполнить ее)"

Updated

Вот так выглядит бизнес-процесс исполнения директив: