Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Manual de Introducción A JBoss JBPM
Manual de Introducción A JBoss JBPM
ndice de contenido
Control de versiones.............................................................................................................................2 1. Introduccin......................................................................................................................................3 2. Instalacin.........................................................................................................................................4 2.1 Instalacin del servidor de aplicaciones JBoss..........................................................................4 2.2 Ejecucin del instalador jBPM..................................................................................................4 2.3 Instalacin de un servidor de base de datos MySQL.................................................................4 2.4 Instalacin del plugin para Eclipse Jboss Tools ........................................................................5 2.5 Comprobacin del conjunto de la instalacin............................................................................5 3. Modelado de procesos en jBPM.......................................................................................................7 3.1 Nodos.........................................................................................................................................7 3.1.1 Nodo de inicio y fin (start y end).......................................................................................7 3.1.2 Nodo de tarea (task-node)..................................................................................................7 3.1.3 Nodo de estado (state) .......................................................................................................7 3.1.4 Nodo de decisin (decision)...............................................................................................7 3.1.5 Nodos fork y join ..............................................................................................................8 3.1.6 Nodo node..........................................................................................................................8 3.2 Transiciones...............................................................................................................................8 3.3 Acciones ....................................................................................................................................8 4. Ejemplo de proceso simple...............................................................................................................9 5. Persistencia de procesos.................................................................................................................12 6. Asignacin de tareas.......................................................................................................................15 7. Uso de un nodo de decisin............................................................................................................18 Conclusiones.......................................................................................................................................21 Referencias.........................................................................................................................................22
Control de versiones
Fecha Autor Observaciones 10/08/09 Jorge Roldn Barrio Versin inicial del documento
1. Introduccin
La lgica de negocio se puede definir en forma de una serie de tareas relacionadas que se deben ejecutar de forma secuencial, paralela o en funcin de alguna condicin. Al conjunto de estas tareas se le conoce como proceso de negocio. La gestin de procesos de negocio (BPM Business Process Management) se encarga del modelado de los procesos de negocio, y define el flujo de trabajo (workflow) que rige su funcionamiento. Un workflow modela de forma grfica las relaciones entre las distintas tareas. Un sistema de gestin de procesos de negocio (BPMS - Business Process Management System) es una aplicacin que gestiona estos flujos de trabajo, y se encarga de automatizar la secuencia de acciones, actividades o tareas que componen del proceso. Esta automatizacin permite integrar los procesos de la empresa y redisearlos de acuerdo a nuevas estrategias. Existen varios sistemas de gestin de procesos de negocio, y uno de ellos es JBoss jBPM, cuya principal ventaja para aquellos que quieren aprender esta tecnologa es que es open-source. En el presente manual se pretende introducir al lector en el uso de esta herramienta.
3 de 22
2. Instalacin
Antes de empezar a trabajar con jBPM, se va a proceder a la instalacin de dicha herramienta y de un conjunto de utilidades que facilitan el desarrollo jBPM en Eclipse llamadas jBoss Tools. La instalacin comprende los siguientes pasos: Instalacin del servidor de aplicaciones Jboss. Ejecucin del instalador de jBPM. Instalacin de un servidor de base de datos MySQL. Instalacin del plugin para Eclipse Jboss Tools. Comprobacin del conjunto de la instalacin. Es necesaria la instalacin de un JDK en el equipo si es que no se encuentra ya instalado. Durante la realizacin de este manual, se ha a realizado la instalacin en un equipo Windows XP que tiene instalada la versin 1.6.0_04-b12 de la JDK de Sun.
Manual de introduccin a JBoss jBPM dev.mysql.com/downloads/ el servidor MySQL Community Server y las herramientas de administracin GUI Tools. Una vez descargados se procede a su instalacin. Ahora habra que crear el esquema de base de datos que usa jBPM. Por sencillez, se va a mantener la configuracin por defecto para la fuente de datos que utiliza jBPM. Para hacer que funcione, se debe ir al MySQL Administrator y crear un nuevo catlogo llamado jbpmtest y un nuevo usuario de nombre jbpmtest y sin password. Se asigna a este usuario todos los permisos de la tabla jbpmtest. En la ruta de instalacin de jbpm (C:\java\jbpm) hay, entre otras cosas, scripts de creacin del esquema usado por jBPM. Si se va al MySQL Query Browser y se realiza la conexin al esquema jbpmtest, a travs de File Open Script se puede seleccionar el script para la creacin de las tablas en MySQL, C:\java\jbpm\database\jbpm.jpdl.mysql.sql. Con la ejecucin de este script, se habr finalizado la instalacin de jBPM con MySQL.
Manual de introduccin a JBoss jBPM librera. Al hacer un clean del proyecto el error debera haber desaparecido. Si se hace doble clic sobre el archivo processdefinition.xml se abrir el jBPM Graphical Process Designer con la descripcin grfica del proceso de ejemplo. El siguiente paso a dar es desplegar esta definicin de proceso en el servidor jBPM para poder trabajar con ella. Para ello hay que ir a la pestaa deployment y revisar los datos en el apartado Deployment Server Settings para que coincidan con los del servidor de aplicaciones, que deber estar arrancado. Pulsando en Deploy Process Archive se realizar el despliegue, se puede comprobar verificando que esta definicin se ha guardado en la tabla JBPM_PROCESSDEFINITION de la base de datos. Ya se dispone del entorno de trabajo configurado y una definicin de proceso desplegada.
6 de 22
3.1 Nodos
Definen los pasos que que se tienen que seguir durante la ejecucin de un proceso, y pueden ser de los siguientes tipos: Nodos de inicio y fin Nodo de tarea Nodo de estado Nodo de decisin Nodos fork y join Nodos node
Manual de introduccin a JBoss jBPM Aadiendo condiciones a las transiciones, mediante beanshell scripts que devuelven un boolean. Los nodos recorreran sus transiciones examinando las condiciones hasta encontrar la primera transicin que cumpla las condiciones. Mediante una clase DecissionHandler que devuelva la transicin a seguir. Si es una entidad externa quien debe tomar la decisin se deberan usar varias transiciones que salgan de un estado de espera. A este estado de espera se le indicar cual es la transicin a seguir cuando se relance la ejecucin del proceso.
3.2 Transiciones
Indican el camino a seguir desde un nodo a otro dentro del proceso. Pueden tener condiciones de guarda las restringen.
3.3 Acciones
Una accin se ejecuta cuando ocurren determinados eventos en la ejecucin de un proceso. Principalmente cuando se entra o se sale de un nodo y cuando se toma una transicin. Estas acciones no tienen influencia sobre el flujo de control del proceso.
8 de 22
El proceso simple est compuesto de tres nodos y dos transiciones: Nodo start: Nodo inicial. Nodo first: Nodo intermedio de estado. Nodo end: Nodo final del proceso. Transicin to_state: Transicin que lleva del nodo start al nodo first. Transicin to_end: Transicin que va del nodo first al nodo end. Las dos transiciones tienen asociadas una accin definida a travs del manejador MessageActionHandler:
package com.sample.action; import org.jbpm.graph.def.ActionHandler; import org.jbpm.graph.exe.ExecutionContext; public class MessageActionHandler implements ActionHandler { private static final long serialVersionUID = 1L;
/** * The message member gets its value from the configuration in the
9 de 22
String message;
/** * A message process variable is assigned the value of the message * member. The process variable is created if it doesn't exist yet. */
Esta accin guarda en el contexto de la instancia de proceso la variable 'message', cuyo valor est definido dentro de las propiedades de la accin. Vamos a probar la ejecucin de este proceso mediante la clase de test SimpleProcessTest:
package com.sample; import junit.framework.TestCase; import org.jbpm.graph.def.ProcessDefinition; import org.jbpm.graph.exe.ProcessInstance; public class SimpleProcessTest extends TestCase { public void testSimpleProcess() throws Exception {
// Extract a process definition from the processdefinition.xml file.
ProcessInstance instance = new ProcessInstance(processDefinition); assertEquals( "Instance is in start state", instance.getRootToken().getNode().getName(), "start"); assertNull( "Message variable should not exist yet", instance.getContextInstance().getVariable("message"));
// Move the process instance from its start state to the first state. // The configured action should execute and the appropriate message // should appear in the message process variable.
10 de 22
} }
instance.signal(); assertEquals( "Instance is in end state", instance.getRootToken().getNode().getName(), "end"); assertTrue("Instance has ended", instance.hasEnded()); assertEquals( "Message variable is changed", instance.getContextInstance().getVariable("message"), "About to finish!");
Lo primero que hace este mtodo de prueba es leer la definicin del proceso del archivo simple/processdefinition.xml. A continuacin crea un nueva instancia del proceso simple y despus manda una seal a la instancia creada para que pase al primer estado. Por ltimo, se enva otra seal a la instancia para que vaya al estado final y termine la ejecucin del proceso. En este ejemplo se ha visto cmo crear instancias de un proceso a partir de un archivo de definicin de proceso, que puede ser creado de forma grfica. Tambin se ha visto cmo se realiza la ejecucin de un proceso.
11 de 22
5. Persistencia de procesos
En el apartado anterior se ha visto cmo ir recorriendo el flujo de ejecucin de una instancia de un proceso de forma local. El estado de esta ejecucin se guarda en memoria y cuando esta termina no queda rastro de ella. Sin embargo, lo normal es que un proceso no se ejecute de esta forma, sino que haya ocasiones en que se mantenga a la espera de que ocurra algn evento o de que algn actor realice una tarea antes de reanudar la ejecucin. Por ello, toda la informacin relativa a la ejecucin del proceso debe persistir en una base de datos de la que poder recuperar cuando sea preciso. Para la persistencia en bases de datos, jBPM utiliza Hibernate. Por tanto, lo primero que hay que hacer es realizar la configuracin adecuada para la base de datos en el archivo hibernate.config.xml. Dentro del proyecto que hemos creado, en la carpeta src/main/config se pueden encontrar varios ejemplos de configuracin para las distintas bases de datos soportadas. Hay que sustituir el contenido del archivo hibernate.config.xml por el de hibernate.config.mysql.xml y hacer un cambio para que no se vuelva a crear el esquema de la base de datos cada vez que se cargue la configuracin, que va a ser comentar la lnea:
<property name="hibernate.hbm2ddl.auto">create</property>
Tambin hay que aadir la librera del conector de MySQL que contiene el driver JDBC a la base de datos. Una vez hecho esto, se va a ver cmo se maneja la persistencia en jBPM. Lo primero es cargar la configuracin de jBPM, que se guarda en el archivo jbpm.cfg.xml, de la siguiente manera:
// Se carga la configuracin de jBPM
Una vez creado este contexto, se pueden realizar operaciones de persistencia. Cuando se hayan finalizado estas operaciones, se debe cerrar el contexto:
// Se cierra el contexto jBPM
jbpmContext.close();
12 de 22
System.out.println("Se ha creado la instancia: " + processInstance.getId() + " del proceso: " + processDefinition.getName()); }
Ahora se puede revisar la base de datos y comprobar la creacin de esta instancia en la tabla JBPM_PROCESSINSTANCE. Tambin se puede ver en la tabla JBPM_TOKEN el token de ejecucion de esta instancia. En el campo NODE de esta tabla se indica en que nodo del flujo se encuentra la ejecucin de este proceso. De esta manera, se ha creado una instancia del proceso simple que est preparada para su ejecucin. Para ello, un usuario debera recuperar esta instancia del contexto de la siguiente forma:
// Se carga la configuracin de jBPM
// Se obtiene un GraphSession que permite realizar operaciones adicionales // sobre los grafos de procesos
13 de 22
List processInstances = graphSession.findProcessInstances(processDefinition.getId()); for (Object object : processInstances) { ProcessInstance processInstance = (ProcessInstance)object;
processInstance.signal(); System.out.println( "Se ha enviado una seal a la instancia: " + processInstance.getId()); } else { System.out.println( "Ya ha terminado la instancia: " + processInstance.getId()); } }
Con esto se ha visto cmo usar la persistencia de jBPM para crear una instancia de un proceso y posteriormente recuperar esta instancia y continuar con su ejecucin.
14 de 22
6. Asignacin de tareas
A continuacin se va a exponer cmo crear tareas en jBPM y asignar qu actor o actores las deben realizar. Esto permite a los actores responsables de su realizacin recoger las tareas pendientes que existan en un determinado momento para completar su ejecucin. En primer lugar vamos a crear una definicin de proceso llamada tarea formada por un nodo inicial, un nodo de tarea y un nodo final:
Como ya se ha mencionado anteriormente, un nodo de tarea representa una o varias tareas que deben ser ejecutadas por una persona. Cuando la ejecucin del proceso llega a un nodo de tarea, se crea una instancia de una tarea (task) en la lista de los miembros del workflow. El nodo se quedar en estado de espera hasta que el usuario informe de la realizacin de la tarea. Para crear una tarea en un nodo de tarea, vamos a las propiedades de este nodo. En la tabla de tareas pulsamos el botn derecho del ratn y seleccionamos New Task. Le damos nombre a esta tarea, en este caso algoquehacer y descripcin si queremos. En el apartado Assignment, vemos que hay varias formas de asignar un tarea: Actor: Se le indica el actorId, que es un String que identifica el actor responsable de la tarea. Cuando se crea la tarea al entrar al nodo de tarea, esta tarea pasa inmediatamente a la lista de actividades pendientes de este actor. Pooled Actor: Se le indica una secuencia de actorId separados por comas. Esta tarea al ser creada no es asignada a la lista de ningn actor. Un actor la debe recuperar de la lista de tareas pendientes para el pool de actores y asignarsela para que forme parte de su lista de tareas. Swimlane: Un swimlane o carril sirve para definir una asignacin que es la misma para varias tareas de un proceso. Expression: Se le indica una expresin de asignacin evaluada por el componente de 15 de 22
Manual de introduccin a JBoss jBPM identidad de jBPM. Permite realizar asignaciones en funcin del usuario, grupo o rol. Handler: Se le indica una clase manejadora, que ser la que realice la asignacin de la tarea. Para mantener el ejemplo sencillo vamos a realizar la asignacin de la tarea a un actor, al que vamos a llamar user1:
Despus de desplegar este proceso en el servidor, vamos a realizar una prueba en dos pasos. En el primer paso vamos a crear una instancia de este proceso tarea y a iniciar su ejecucin. Esto es algo que ya hemos visto:
// Se carga la configuracin de jBPM
// Se obtiene un GraphSession que permite realizar operaciones adicionales // sobre los grafos de procesos
processInstance.signal();
16 de 22
jbpmContext.close();
Se puede ver en la tabla JBPM_TASKINSTANCES de la base de datos una instancia de la tarea algoquehacer asignada al usuario user1 pendiente de ser ejecutada, es decir, no esta marcada como terminada. Vamos a recuperar los procesos pendientes para el usuario user1 gracias a la clase TaskManagementSession y a informar de la finalizacin de esta tarea:
// Se carga la configuracin de jBPM
TaskMgmtSession tms = jbpmContext.getTaskMgmtSession(); String actorId = "user1"; List instances = tms.findTaskInstances(actorId); for (TaskInstance taskInstance : instances) { System.out.println( "Tarea pendiente de ejecutar por " + actorId +":" + taskInstance.getName() + taskInstance.getId());
taskInstance.end(); }
jbpmContext.close();
Se ha visto como asignar una tarea a un actor y de como recuperar las tareas pendientes de un actor en un proceso posterior para llevar a cabo su ejecucin.
17 de 22
Este proceso empieza en un nodo de inicio del que se sale mediante la transicin comenzar. Esta transicin tiene una accin crearvalor manejada por la clase ValorAction, que se encarga de introducir en el contexto de ejecucin una variable valor:
public class ValorAction implements ActionHandler { public String valor;
18 de 22
Manual de introduccin a JBoss jBPM A continuacin se llega a un nodo de decision manejado por una clase Decisor, que comprueba si en el contexto de ejecucin existe una variable valor con un valor asignado. Si existe esta variable se abandona el nodo por la transicin terminar1 y si no, por la transicin terminar2:
public class Decisor implements DecisionHandler { public Decisor(String info) { super(); }
@Override public String decide(ExecutionContext executionContext) throws Exception { String valor = (String)executionContext.getContextInstance().getVariable("valor"); if(valor != null) { return "terminar1"; } else { return "terminar2"; } } }
Por ltimo, al llegar a cualquiera de los nodos finales se lanza una accin que muestra en que nodo est terminando la ejecucin del flujo, manejada por la clase MostrarMensajeAction:
public class MostrarMensajeAction implements ActionHandler { public MostrarMensajeAction(String info) { super(); }
@Override public void execute(ExecutionContext executionContext) throws Exception { System.out.println( "Se sale del flujo por el nodo: " + executionContext.getNode().getName()); } }
19 de 22
Se puede ejecutar este proceso mediante una clase de test como esta:
public void testSimpleProcess() throws Exception {
// Extraer la definicion de proceso del archivo processdefinition.xml.
ProcessInstance instance = new ProcessInstance(processDefinition); assertEquals( "La instancia est en el estado inicial", instance.getRootToken().getNode().getName(), "inicio"); assertNull( "La variable 'valor' no debe existir todava", instance.getContextInstance().getVariable("valor"));
instance.signal(); }
Si en la configuracin se ha introducido un valor para la variable valor, por la consola se ver un mensaje que indica que ha terminado en el nodo final1. En caso contrario se termina en el nodo final2.
20 de 22
Conclusiones
El presente manual est siendo realizado durante el aprendizaje de la herramienta jBPM. No es ms que la compilacin de los pequeos artculos que estoy escribiendo en mi blog (http://tratandodeentenderlo.blogspot.com). Estoy tratando de plasmar en ellos la experiencia adquirida durante el aprendizaje de jBPM, aunque mi intencin es escribir sobre otros temas de inters, tambin relacionados con el mundo Java. Aunque este manual contiene suficiente informacin para ayudar a los usuarios inexpertos en su introduccin a jBPM, es mi intencin seguir amplindolo. Para ello agradecera que todo aquel lector que tenga alguna duda o sugerencia sobre el material presentado en este documento me la hiciese llegar por correo electrnico (jorge.roldan@gmail.com) o como comentarios a travs de mi blog.
21 de 22
Referencias
jBPM jPDL User Guide 3.2.3 Bussines Process Management with Jboss jBPM (Matt Cumberlidge, Packt Publishing)
22 de 22