jBPM Persistence and Transaction

jBPM allows the storage of certain information. jBPM persistence is a runtime persistence which persists the state of all our process instances and log audit information that is happening at runtime of the processes. The main purpose of persistence is to store process executions during wait states. This section describes the different types of persistence and how to configure them.

Runtime State Persistence

When a process is started, immediately its instance is created which represents the current execution state in that specific context. If something goes wrong during the execution of a process then it is necessary to store the process runtime state which helps to continue the execution of a process instance. For example, when we execute a process for sales order, one process instance is created for every sales request.

jBPM provides plug-in for different persistence strategies. The runtime state of an executing process can be made persistent. The persistence strategies allow restoring the state of execution of all running processes in case of unexpected failure.

To use persistence, we have to configure the process engine. This configuration will automatically store the runtime state into the database. We cannot trigger persistence itself. The process engine will take care of this when persistence is enabled. The engine will automatically reload process instances on demand.

Binary Persistence

Binary persistence mechanism is used to convert the process state instance information into a binary dataset. This mechanism is used to save or retrieve the process instance state from the database.

In Binary Persistence, two things happen when the process instance state is persisted-

The state of process instance information is transformed into a binary blob.
This binary blob is then store some other metadata with this process instance. This metadata includes the process instance id, process id, and the process start date.

Audit Log

The jBPM audit log stores the history log of execution information in a database using JPA. In many cases, it is useful to store information about the execution of process instances so that this information can be used later. For example, sometimes we need to-

Verify which actions have been executed for a particular process instance.
To monitor and analyse the efficiency of a particular process.

The history log of execution information is created based on events. It is possible because the jBPM runtime engine provides an appropriate mechanism to listen to events. The necessary information can easily be extracted from these events and then persisted to a database.

Transaction

The jBPM process engine supports JTA(Java Transaction API) transactions. It also supports local transactions by using Spring but does not support pure local transactions. In jBPM, it is necessary to provide transaction boundaries inside our application. If we do not give transaction boundaries inside our application, the engine will automatically invoke each executes method in a separate transaction. However, we can also specify the transaction boundaries itself. This allows us to combine multiple commands into one transaction.

To create user-defined transactions we need to register a transaction manager at the environment. The following sample code understand how to create transaction manager.

  // create the entity manager factory          EntityManagerFactory emf = EntityManagerFactoryManager.get().getOrCreate(“org.jbpm.persistence.jpa”);          TransactionManager tm = TransactionManagerServices.getTransactionManager();    // setup the runtime environment          RuntimeEnvironment environment = RuntimeEnvironmentBuilder.Factory.get()          .newDefaultBuilder()          .addAsset(ResourceFactory.newClassPathResource(“MyProcessDefinition.bpmn2”), ResourceType.BPMN2)          .addEnvironmentEntry(EnvironmentName.TRANSACTION_MANAGER, tm)          .get();    // get the kie session          RuntimeManager manager = RuntimeManagerFactory.Factory.get().newPerRequestRuntimeManager(environment);          RuntimeEngine runtime = manager.getRuntimeEngine(ProcessInstanceIdContext.get());          KieSession ksession = runtime.getKieSession();    // start the transaction          UserTransaction ut = InitialContext.doLookup(“java:comp/UserTransaction”);          ut.begin();    // perform multiple commands inside one transaction          ksession.insert( new Person( “John Doe” ) );          ksession.startProcess(“MyProcess”);    // commit the transaction          ut.commit();  

Persistence Configuration

Persistence can be used by configuring the process engine. Persistence configuration requires adding the necessary dependencies, configuring a data source and creating the engine with persistence configured.

Adding Dependencies

If we are using jBPM Eclipse plug-in, we have to make sure that the necessary JARs are added to our jBPM runtime directory. We can manually add the necessary dependencies in our project. To add dependencies manually, perform the following steps –

We need the JAR file jbpm-persistence-jpa.jar. It contains code to save the runtime state whenever necessary.
We need various other dependencies which depend on the persistence solution and database we are using. Some of the following dependencies listed below –

jbpm-persistence-jpa (org.jbpm)
drools-persistence-jpa (org.drools)
persistence-api (javax.persistence)
hibernate-entitymanager (org.hibernate)
hibernate-annotations (org.hibernate)
hibernate-commons-annotations (org.hibernate)
hibernate-core (org.hibernate)
commons-collections (commons-collections)
dom4j (dom4j)
jta (javax.transaction)
btm (org.codehaus.btm)
javassist
slf4j-api (org.slf4j)
slf4j-jdk14 (org.slf4j)

Manually configuring the engine to use persistence

Configure process engine, create a new knowledge session using JPAKnowledgeService based on knowledge base, a knowledge session configuration and an environment.

For example-

  // create the entity manager factory and register it in the environment          EntityManagerFactory emf =          Persistence.createEntityManagerFactory( “org.jbpm.persistence.jpa” );          Environment env = KnowledgeBaseFactory.newEnvironment();          env.set( EnvironmentName.ENTITY_MANAGER_FACTORY, emf );    // create a new knowledge session that uses JPA to store the runtime state          StatefulKnowledgeSession ksession = JPAKnowledgeService.newStatefulKnowledgeSession( kbase, null, env );          int sessionId = ksession.getId();    // invoke methods on your method here          kSession.startProcess( “MyProcess” );          kSession.dispose();  

Next TopicjBPM Component

jBPM Persistence and Transaction

jBPM Persistence and Transaction

Runtime State Persistence

Binary Persistence

Audit Log

Transaction

Persistence Configuration

Adding Dependencies

Manually configuring the engine to use persistence

For example-

JavaScript Window open method

Build JMeter Test Plan

You may also like