CopyDocumentType
This Web Service API is used to copy an existing document type for a batch class to create new document type. It takes an XML as input containing information of the batch class, Existing Document type...
View ArticlegetBatchClassForRole
This API is used to fetch all batch class list accessable to the specified user role. Request Method: GET Input Parameters Input Parameter Values Descriptions role This value should not be empty....
View ArticlerestartBatchInstance
This API is used to restart the batch from the specified module. User can restart only those batch instances that are accessible to their role. Request Method: GET Input Parameters Input Parameter...
View ArticleextractKV
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...
View ArticleBatchInstanceList
The API will return a list of all the batch instances with the status given in the input parameter. Only the list of batches will be returned that are accessible by the particular authenticated user....
View ArticleextractFieldFromHocr
This API will extract the KV pattern for the given word in the given input HOCR file. Request Method POST Input Parameters Input Parameter Values Descriptions batchClassIdentifier This should not be...
View ArticleexportBatchClass
This API is used to export the existing batch class. This method will take the batch class identifier and learnt-sample to be exported with the batch class. Request Method POST Web Service URL:...
View ArticleregularRegexExtraction
This API will extract the document level fields for the document type for the specified batch class using regular regex extraction. Request Method POST Input Parameters Input Parameter Values...
View ArticlecommonAPIForExtraction
This API can be utilised to perform extraction from the list of extraction plugins depicted below. Rest of the information for the individual API can be found above. Request Method POST Input for...
View ArticleDevelopers Guide
Ephesoft Script Guide Scripting functionality in Ephesoft is supported where a custom requirement can be handled. Ephesoft includes power to perform custom functionality during different stages of...
View ArticleextractFuzzyDB
This API will create the document level fields for the document type using fuzzy Db based extraction for the specified batch class for HOCR file. Request Method POST Input Parameters Input Parameter...
View ArticleExtractKVForDocumentType
This Web Service API is used to perform Key Value Extraction for the Document type of the specified Batch Class, for the input HOCR XML provided. Request Method POST Input Parameters Input Parameter...
View ArticleclassifyHOCR
This API will classify the input HOCR according to the batch class identifier provided. This API will require the following plugins “SEARCH_CLASSIFICATION_PLUGIN”, “DOCUMENT_ASSEMBLER_PLUGIN” and the...
View ArticleRun Batch Instance
This API is used to run the batch instance from READY_FOR_REVIEW or READY_FOR_VALIDATION module to next phase in workflow. User can restart those batch instances which are accessible by their role....
View ArticlecreateHOCRforBatchClass
Creates HOCR XML for single page/multi-page TIF/TIFF or zip file containing TIF/TIFF or PDF passed as input for a particular Batch Class. This Web Service API requires two inputs: input xml and image...
View ArticleCRON Expressions
Cron Expressions Cron-Expressions are used to configure schedules. Cron-Expressions are strings that are actually made up of seven sub-expressions, that describe individual details of the schedule....
View ArticleclassifyBarcodeImage
This API is used to classify the input barcode image according to the specified batch class. Image file should have barcode and barcode value should be document type which is present in the batch...
View ArticlegetAllModulesWorkflowNameByBatchClass
This API will return the module workflow names and the module names for the specified batch class identifier. Request Method: GET Input Parameters Input Parameter Values Descriptions...
View ArticleDocument Level Field Validation (Script)
Issue: If a field is not being validated because regular expression does not comply with the value, users can override this by simply pressing CTRL+B. But, is there a way to do that with a function...
View Article