<sqlWorkflowInstanceStore>

Article
09/15/2021

A service behavior that allows you to configure the SqlWorkflowInstanceStore feature, which supports persisting state information for workflow service instances into an SQL Server 2005 or SQL Server 2008 database. For more information on this feature, see SQL Workflow Instance Store.

<configuration>
  <system.ServiceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior>
          <sqlWorkflowInstanceStore>

Syntax

<behaviors>
  <serviceBehaviors>
    <behavior name="String">
      <sqlWorkflowInstanceStore connectionStringName="String"
                                hostLockRenewalPeriod="TimeSpan"
                                instanceCompletionAction="DeleteNothing/DeleteAll"
                                instanceEncodingAction="None/GZip"
                                instanceLockedExceptionAction="NoRetry/BasicRetry/AggressiveRetry"
                                runnableInstancesDetectionPeriod="TimeSpan" />
    </behavior>
  </serviceBehaviors>
</behaviors>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
`connectionString`	A string that contains a connection string used to connect to an underlying persistence database.
`connectionStringName`	A string that contains a named connection string to the database server. An example of a named connection string is "DefaultConnectionString".
`hostLockRenewalPeriod`	A Timespan value that specifies the time period in which the host must renew the lock on an instance. If the host does not renew the lock in the specified time period, the instance is unlocked and may be picked up by another host. Unloading a workflow implies that it is also persisted. If this attribute is set to zero the workflow instance is persisted and unloaded immediately after the workflow becomes idle. Setting this attribute to TimeSpan.MaxValue effectively disables the unload operation. Idle workflow instances are never unloaded.
`instanceCompletionAction`	A value that specifies whether workflow instance data is kept in the persistence store after the workflow instance completes or if it is deleted at that point. This value is of type InstanceCompletionAction. The enumerated actions consist of deleting the instance data from the persistence store or not deleting the instance data from the persistence store, when the instance has completed its operation. Keeping instances after completion causes the persistence database to grow rapidly and this affects the performance of the database. You should configure a database purge policy to delete these records periodically to ensure that the performance of the database is at the level that satisfy your performance requirements.
`instanceEncodingOption`	An optional value that specifies whether the instance state information is compressed using the GZip algorithm before the information is saved in the persistence store.. This value is of type InstanceEncodingOption. Possible values for this property are None, which specifies no compression, and GZip, which specifies that instance data is compressed and uses the gzip algorithm.
`instanceLockedExceptionAction`	A value that specifies the action that occurs in response to an exception that is thrown when the host tries to lock an instance because the instance is currently locked by another host. This value is of type InstanceLockedExceptionAction. The options allowed for this field are: None, Basic Retry, and Aggressive Retry. The default value is None. The following list provides you with the descriptions for these three options: - None. The service host does not attempt to lock the instance and passes the InstanceLockedException to the caller. - Basic Retry. The service host reattempts to lock the instance with a linear retry interval and passes the exception to the caller at the end of the sequence. - Aggressive Retry. The service host reattempts to lock the instance with an exponentially increasing delay and passes the InstanceLockedException to the caller at the end of the sequence.
`runnableInstancesDetectionPeriod`

Child Elements

None.

Parent Elements

Element	Description
<behavior> of <serviceBehaviors>	Specifies a behavior element.

Share via