Last Updated on

advancedBarcodeExtraction

Performs barcode extraction on the input document (TIF/TIFF (single and multi-page) or PDF (single and multi-page) using provided input XML file. Advanced Barcode Extraction plugin is fetched from the Batch Class corresponding to the input Batch Class identifier specified in the input XML. The extraction is performed based on configurations of the extraction plugins and rules configured for the particular Batch Class.

Request Type: POST

Request URL: {ProtocolType}://{ServerIP}:{ServerPort}/dcma//rest/advancedBarcodeExtraction

Sample URL: http://<HOSTNAME>:8080/dcma/rest/advancedBarcodeExtraction

 

Body Parameters

Parameter Description Required Notes
XML file File containing parameter tags described below Required This file is used to identify the Batch Class, processed document name and type.
PDF/TIFF File Input document to be processed Required Supported input file types: TIF/TIFF (single and multi-page), PDF (single and multi-page).
The key should be exactly the same as the name of the uploaded file including extension.

 

Parameter Tags in the input XML

Parameter Description Required Notes
batchClassIdentifier String parameter for Batch Class identifier Required Valid identifier of the Batch Class on which advanced barcode extraction will be performed, e.g. BC1.
imageName Input document to be processed Required The title of the document to be processed including extension.
docType The type of document to be processed Required The document type as configured in Ephesoft Transact.

 

Headers

Header Name Description Required
Authorization The access token that will be used to authorize the request. Required

 

Returns
A batch.xml file is returned if input parameters are valid.

CheckList
• Extraction is done only if Extraction module is configured for the particular Batch Class in Ephesoft Transact. The Advanced Barcode Extraction plugin must be present in the particular batch class, with its switch ON.
• Input XML must contain the following parameters as all of these are mandatory:
– batchClassIdentifier
– imageName
– docType

 

Sample Input XML

<WebServiceParams>
<Params>
  <Param>
    <Name>batchClassIdentifier</Name>
    <Value>BCB7</Value>
  </Param>
  <Param>
    <Name>imageName</Name>
    <Value>StandardizedTest.pdf</Value>
  </Param>
 <Param>
       <Name>docType</Name>
       <Value>doc1</Value>
  </Param>
  </Params>
</WebServiceParams>

Sample client code using apache commons http client

private static void advancedBarcodeExtraction() {
                                HttpClient client = new HttpClient();
                                String url = “http://localhost:8080/dcma/rest/advancedBarcodeExtraction“;
                                PostMethod mPost = new PostMethod(url);
                                File file1 = new File(“C:\\sample\\sample.xml”);
                                // adding xml file for taking input
                                File file2 = new File(“C:\\sample\\US-Invoice.tif”);
                                Part[] parts = new Part[2];
                                try {
                                                parts[0] = new FilePart(file1.getName(), file1);
                                                parts[1] = new FilePart(file2.getName(), file2);
                                                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.”);
                                                                System.out.println(mPost.getResponseBodyAsString());
                                                } else if (statusCode == 403) {
                                                                System.out.println(“Invalid username/password.”);
                                                } else {
                                                                System.out.println(mPost.getResponseBodyAsString());
                                                }
                                } catch (HttpException e) {
                                                e.printStackTrace();
                                } catch (IOException e) {
                                                e.printStackTrace();
                                } finally {
                                                if (mPost != null) {
                                                                mPost.releaseConnection();
                                                }
                                }
                }

Was this article helpful to you?

Engineering