Skip to main content
Kofax

Retry Functionality for Network or Operation Failure

9565

Question / Problem:

Does Kofax Capture have a Retry or Refresh functionality in the event of a network or operation failure?

Answer / Solution:

Yes. When file operations fail, they are retried every 0.5 seconds for a total retry time of 2 minutes. If failover takes longer at a particular site, users can configure these parameters by updating the ACConfig.XML file in the Ascent Capture server files folder, Config sub folder as shown below. The ReliableFileSystem element must be added as a direct child of the ACConfig element.

<ACConfig>
    <ReliableFileSystem>
        <Retry MaxRetrySeconds="120" MilliSecondsBetweenTries="500" MinimumRetries="1" />
    </ReliableFileSystem>
</ACConfig>

The above specifies that Ascent Capture will retry at least once every ½ second for up to 2 minutes.

The file system Retry works as follows:

  • Retry time can be configured in case a typical failover takes longer than the default 2 minutes.
  • Config setting changes require application restart.
  • The retry time is measured from the time of the first failure.
  • Retry logic is not based on specific error numbers because they can vary:
    • If the operation is not on a specific file, then it always tries until the retry time expires.
    • If the file does not exist and the drive does exist, then it tries MinimumRetries more times.
    • If the file does not exist and the drive does not exist, then it tries until the retry time expires .
    • If the file exists, then if it is in use, then it tries until the retry time expires.
    • If the file exists and is not in use, then it retries MinimumRetries more times.

The following table discusses the Retry element's attributes:

Attribute Data Type Description

MaxRetrySeconds

Int32

This value can be from 0 seconds to 86400 seconds (24 hours) (inclusive).

The specified value indicates the total time spent retrying a failed file operation starting from the time the operation failed. Note that no matter what this setting is (even if it is 0), failed file operations will be retried at least one time. This provides more robust application behavior when there are intermittent network errors.

Note that the time spent retrying may be longer than specified by the amount of time it takes for the file operation to fail twice.

If this value is missing, a value of 120 seconds (2 minutes) is used.

Sites that have a particularly long fail over cycle should increase this value to be longer than the time required to fail over the file system resource. Note that a value larger than 300 seconds (5 minutes) is not recommended because users will not tolerate such a long delay.

Sites that desire immediate errors when a disk resource is down (as in prior Ascent Capture versions) should set this value to 0.

MilliSecondsBetweenTries

Int32

This value can be from 0 milliseconds to 43,200,000 milliseconds (12 hours) (inclusive).

The specified value indicates the time to pause between retrying failed file operations.

The default value is 500 milliseconds (0.5 second).

If the value is greater than MaxRetrySeconds * 1000, then the smaller value is used.

MinimumRetries

Int32

Minimum number of retries to attempt (overriding the MaxRetrySeconds parameter).

Applies to:

Product Version
CAPTURE 10.0
  10.1
  10.2
  11.0
  • Was this article helpful?