As of version 8.2, dotConnect for MySQL implements MySQL Workflow Instance Store. To use MySQL Workflow Instance Store you need MySQL server 5 or higher.

Before using MySQL Workflow Instance Store, you need to create a database that is used to persist workflow instances. dotConnect for MySQL provides the scripts for creating this database. They are placed to the WF Services subfolder of the dotConnect for MySQL installation folder. By default it is %ProgramFiles%\Devart\dotConnect\MySQL\WF Services\. Note that there are two versions of scripts - for .NET Framework 4.5, and for previous versions of .NET Framework.

If you target .NET Framework 4.5, execute the MySqlInstanceStoreSchema45.sql script first and then execute MySqlInstanceStoreLogic45.sql. If you target .NET Framework 3.0, 3.5, or 4.0, execute the MySqlInstanceStoreSchema.sql script first and then execute MySqlInstanceStoreLogic.sql. You may use these scripts to clean up the persistence database to have a fresh database in the same way, just execute them in the same order.

Configuring InstanceStore for Self-Hosted Workflows that use WorkflowApplication

To enable persistence for self-hosted workflows that use WorkflowApplication, perform the following steps:

1. Add the reference to Devart.Data.MySql.WorkflowFoundation.dll in your project.

2. Specify the using directive:

   • C#

   using Devart.Data.MySql.DurableInstancing;

   • Visual Basic

   Imports Devart.Data.MySql.DurableInstancing
   

3. Create MySqlInstanceStore and assign the following code to the InstanceStore property of WorkflowApplication:

   • C#

   MySqlInstanceStore store = new MySqlInstanceStore(your_connection_string);
   WorkflowApplication wfApp = new WorkflowApplication(new Workflow1());
   wfApp.InstanceStore = store;

   • Visual Basic

   Dim store As New MySqlInstanceStore(your_connection_string)
   Dim wfApp As New WorkflowApplication(New Workflow1())
   wfApp.InstanceStore = store
   

4. Call the Persist() method on the WorkflowApplication to persist a workflow.

Configuring InstanceStore with MySqlInstanceStoreBehavior Class

To enable persistence using the MySqlInstanceStoreBehavior class, perform the following steps:

1. Add a reference to the Devart.Data.MySql.Activities.Description.dll

2. Add the following statement at the top of the source file after the existing "using" statements.

   • C#

   using Devart.Data.MySql.Activities.Description;

   • Visual Basic

   Imports Devart.Data.MySql.Activities.Description
   

3. Create an instance of the WorkflowServiceHost and add endpoints for the workflow service.

   • C#

   WorkflowServiceHost host = new WorkflowServiceHost(new CountingWorkflow(), new Uri(hostBaseAddress));
   host.AddServiceEndpoint("ICountingWorkflow", new BasicHttpBinding(), "");

   • Visual Basic

   Dim host As New WorkflowServiceHost(New CountingWorkflow(), New Uri(hostBaseAddress))
   host.AddServiceEndpoint("ICountingWorkflow", New BasicHttpBinding(), "")
   

4. Construct an MySqlInstanceStoreBehavior object and to set properties of the behavior object.

   • C#

   MySqlInstanceStoreBehavior instanceStoreBehavior = new MySqlInstanceStoreBehavior(connectionString);
   instanceStoreBehavior.HostLockRenewalPeriod = new TimeSpan(0, 0, 5);
   instanceStoreBehavior.InstanceCompletionAction = InstanceCompletionAction.DeleteAll;
   instanceStoreBehavior.InstanceLockedExceptionAction = InstanceLockedExceptionAction.AggressiveRetry;
   instanceStoreBehavior.InstanceEncodingOption = InstanceEncodingOption.GZip;
   instanceStoreBehavior.RunnableInstancesDetectionPeriod = new TimeSpan("00:00:02");
   host.Description.Behaviors.Add(instanceStoreBehavior);

   • Visual Basic

   Dim instanceStoreBehavior As New MySqlInstanceStoreBehavior(connectionString)
   instanceStoreBehavior.HostLockRenewalPeriod = New TimeSpan(0, 0, 5)
   instanceStoreBehavior.InstanceCompletionAction = InstanceCompletionAction.DeleteAll
   instanceStoreBehavior.InstanceLockedExceptionAction = InstanceLockedExceptionAction.AggressiveRetry
   instanceStoreBehavior.InstanceEncodingOption = InstanceEncodingOption.GZip
   instanceStoreBehavior.RunnableInstancesDetectionPeriod = New TimeSpan("00:00:02")
   host.Description.Behaviors.Add(instanceStoreBehavior)
   

5. Open the workflow service host.

   • C#

   host.Open();

   • Visual Basic

   host.Open()
   

Configuring InstanceStore with Config File

To configure MySQL Instance Store by using the mysqlInstanceStore behavior element in a configuration file, perform the following steps:

1. Add the following behavior extension element to the Machine.config file so that you can use the <mysqlInstanceStore> service behavior element in the configuration files of your applications to configure persistence for your services:

   <configuration>
       <system.serviceModel>
           <extensions>
               <behaviorExtensions>
                   <add name="mysqlInstanceStore" type="Devart.Data.MySql.Activities.Configuration.MySqlInstanceStoreElement, Devart.Data.MySql.WorkflowFoundation, Version=8.3.215.0, Culture=neutral, PublicKeyToken=09af7300eec23701" />
               </behaviorExtensions>
           </extensions>
       </system.serviceModel>
   </configuration>

   Note: Replace 8.3.215.0 in the code with your actual version.

2. Configure MySQL Instance Store by using the mysqlInstanceStore behavior element in a configuration file of your application:

   <configuration>
       <system.serviceModel>
         <behaviors>  
           <serviceBehaviors>
       	    <behavior name="">
                   <mysqlInstanceStore 
                       connectionString="User Id=root;Host=localhost;Database=Test;"
                       instanceEncodingOption="GZip | None"
                       instanceCompletionAction="DeleteAll | DeleteNothing"
                       instanceLockedExceptionAction="NoRetry | BasicRetry |AggressiveRetry"
                       hostLockRenewalPeriod="00:00:30" 
                       runnableInstancesDetectionPeriod="00:00:05" />
       	    </behavior>
           </serviceBehaviors>
         </behaviors>  
       </system.serviceModel>
   </configuration>

See Also

Workflow Tracking Support  | Development Tools and Features