extractKV

This API will extract the document level fields for the corresponding Key Value pattern provided using input XML. This API will take the HOCR file as input. If the Key Value pattern is not found in the HOCR file then it will create the empty document level fields.

Request Method POST

Input Parameters

Along these parameters hocrFileName string parameter is also to be supplied containing the name of the HOCR file uploaded.

Web Service URL: http://{serverName}:{port}/dcma/rest/extractKV

CheckList:

• For using Advance KV user should have admin access to fetch the accurate value of Length, Width, Xoffset and Yoffset. Before using AdvancedKV, please test the image with Ephesoft Admin Screen and note the values of Length, Width, Xoffset, Yoffset and LocationType for the particular KeyValue pattern.
• If AdvancedKV is true than NoOfWords is not use and all other parameters is used.
• If AdvancedKV is false than NoOfWords, KeyPattern, ValuePattern and LocationType will work.

Format for XML:

<ExtractKVParams>

<Params>

<AdvancedKV>true</AdvancedKV>

<LocationType>BOTTOM_LEFT</LocationType>

<NoOfWords>0</NoOfWords>

<KeyPattern>Invoice</KeyPattern>

<ValuePattern> [a-zA-Z]{10,15}</ValuePattern>

<KVFetchValue>ALL</KVFetchValue>

<Multiplier>1</Multiplier>

<Length>384</Length>

<Width>251</Width>

<Xoffset>284</Xoffset>

<Yoffset>105</Yoffset>

<Weight>0.1</Weight>

<KeyFuzziness>0.2</KeyFuzziness>

</Params>

</ExtractKVParams>

 

Sample client code using apache commons http client:-

private static void extractKV() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/extractKV";
		PostMethod mPost = new PostMethod(url);
		// Adding XML for the input.
		File f1 = new File("C:\\sample\\ExtractKVParam.xml");
		// Adding HOCR for processing.
		File f2 = new File("C:\\sample\\US-Invoice_HOCR.xml");
		Part[] parts = new Part[3];
		try {
			parts[0] = new FilePart(f1.getName(), f1);
			parts[1] = new FilePart(f2.getName(), f2);
			parts[2] = new StringPart("hocrFileName", f2.getName());
			MultipartRequestEntity entity = new MultipartRequestEntity(parts, mPost.getParams());
			mPost.setRequestEntity(entity);
			int statusCode = client.executeMethod(mPost);
			if (statusCode == 200) {
				System.out.println("Web service executed successfully.");
				String responseBody = mPost.getResponseBodyAsString();
				// Generating result as responseBody.
				System.out.println(statusCode + " *** " + responseBody);
			} else if (statusCode == 403) {
				System.out.println("Invalid username/password.");
			} else {
				System.out.println(mPost.getResponseBodyAsString());
			}
		} catch (FileNotFoundException e) {
			System.err.println("File not found for processing.");
		} catch (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (mPost != null) {
				mPost.releaseConnection();
			}
		}
	}	}