› Web services interface for Kofax Monitor › KC Plug-In › TestConversionErrors function

TestConversionErrors function

This function checks for the conversion errors in messages based on input criteria. The input schema is shown below.


input schema of the testconversionerrors function

The input request fields are defined in the following table.

Request fields

Description

ConnectionName

The name of the connection. This field is case-sensitive. Default value is "all".

MinMessageCount

Minimum number of messages to be received by the connection.

TimeRange (in minutes)

The time range for performing the test. Default value is 1440 minutes. Maximum value is 1440 minutes.

PercLimitOfConvErr

Minimum percentage of messages with conversion error for the test to be successful.

Restarting KC Plug-In service will set the message count to 0.

Based on the input criteria, the response is returned. The response schema is shown below.


response schema of the testconversionerrors function

The output response fields are defined in the following table.

Response fields

Description

TotalMsgs

The number of messages received during the specified time range.

CheckedTimeRange

Verified time range. This is same as the time range specified in the request.

NumMsgsWithConvErr

The number of messages with conversion error.

PercWithConvError

The percentage of messages with conversion error.

TestResult

This is the test result. Possible values are Success, Fail or NotEnoughMsgs.

Example: Sample request

Input request: For the test to be successful, at least 20 messages must be received by "Connection1" and the conversion error should be more than 30% in last 150 minutes. 

 <kic:TestConversionErrors>
    <kic:ConnectionName>Connection1</kic:ConnectionName>
    <kic:MinMessageCount>20</kic:MinMessageCount>
    <kic:TimeRange>150</kic:TimeRange>
    <kic:PercLimitOfConvErr>30</kic:PercLimitOfConvErr>
 </kic:TestConversionErrors>

Output response: As per the input criteria, "Connection1" received 20 messages in last 150 minutes and there are five document conversion errors, that is, 25%. Therefore, the criteria user tested is not achieved and the test result is Fail. 

<TestConversionErrorsResponse xmlns="http://www.kofax.com/2011/KIC-ElectronicDocuments">
    <TotalMsgs>20</TotalMsgs>
    <CheckedTimeRange>150</CheckedTimeRange>
    <NumMsgsWithConvErr>5</NumMsgsWithConvErr>
    <PercWithConvError>25</PercWithConvError>
    <TestResult>Fail</TestResult>
</TestConversionErrorsResponse>