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: http://{serverName}:{port}/dcma/rest/exportBatchClass

CheckList:-

1. Identifier should be a valid batch class identifier.

Sample client code using apache commons http client:-

private static void exportBatchClass() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/exportBatchClass";
		PostMethod mPost = new PostMethod(url);
		String batchClassIdentifier = "BC4";
		mPost.addParameter("identifier", batchClassIdentifier);
		mPost.addParameter("lucene-search-classification-sample", "true");
		mPost.addParameter("image-classification-sample", "false");
		int statusCode;
		try {
			statusCode = client.executeMethod(mPost);
			if (statusCode == 200) {
				System.out.println("Batch class exported successfully");
				InputStream in = mPost.getResponseBodyAsStream();
				File f = new File("C:\\sample\\serverOutput.zip");
				FileOutputStream fos = new FileOutputStream(f);
				try {
					byte[] buf = new byte[1024];
					int len = in.read(buf);
					while (len > 0) {
						fos.write(buf, 0, len);
						len = in.read(buf);
					}
				} finally {
					if (fos != null) {
						fos.close();
					}
				}
			} 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();
			}
		}
	}

This API returns s list of all the batch classes accessible by the authenticated user.

Request Method GET

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

Sample client code using apache commons http client:-

private static void getBatchClassList() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/getBatchClassList";
		GetMethod mGet = new GetMethod(url);
		int statusCode;
		try {
			statusCode = client.executeMethod(mGet);
			if (statusCode == 200) {
				System.out.println("Web service executed successfully.");
				String responseBody = mGet.getResponseBodyAsString();
				System.out.println(statusCode + " *** " + responseBody);
			} else if (statusCode == 403) {
				System.out.println("Invalid username/password.");
			} else {
				System.out.println(mGet.getResponseBodyAsString());
			}
		} catch (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (mGet != null) {
				mGet.releaseConnection();
			}
		}
	}

This API is used to get the roles specified for the particular batch class with name given in the input parameter.

Request Method GET

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

CheckList:-

1. Identifier should be a valid batch class identifier.

Sample client code using apache commons http client:-

private static void getRoles() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/getRoles/BC1";
		GetMethod mGet = new GetMethod(url);
		int statusCode;
		try {
			statusCode = client.executeMethod(mGet);
			if (statusCode == 200) {
				System.out.println("Web service executed successfully.");
				String responseBody = mGet.getResponseBodyAsString();
				System.out.println(statusCode + " *** " + responseBody);
			} else if (statusCode == 403) {
				System.out.println("Invalid username/password.");
			} else {
				System.out.println(mGet.getResponseBodyAsString());
			}
		} catch (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (mGet != null) {
				mGet.releaseConnection();
			}
		}
	}

This API is used for uploading a new batch to a watch folder for a given batch class. It executes the new batch with supplied tif, tiff or pdf files. User need to be authorized to execute a batch for a particular batch class otherwise an error message would be generated. All the files would be copied to the unc folder of the requested batch class with the folder name supplied by the user as input.

Request Method POST

Web Service URL: http://{serverName}:{port}/dcma/rest/uploadBatch/{batchClassIdentifier}/{batchInstanceName}

Input: A valid tif/tiff file.

CheckList:-

1. The value for batchClassIdentifier is compulsory and should be valid with permissions to the user to run the batch on it.
2. The value for batchInstanceName is mandatory and if left empty then it will send an error.

Sample client code using apache commons http client:-

private static void uploadBatch() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/uploadBatch/BC4/US_Invoice_sample";
		PostMethod mPost = new PostMethod(url);
		// adding image file for processing
		File file1 = new File("C:\\sample\\US-Invoice.tif");
		Part[] parts = new Part[1];
		try {
			parts[0] = new FilePart(file1.getName(), file1);
			MultipartRequestEntity entity = new MultipartRequestEntity(parts, mPost.getParams());
			mPost.setRequestEntity(entity);
			int statusCode = client.executeMethod(mPost);
			String responseBody = mPost.getResponseBodyAsString();
			// Generating result as responseBody.
			System.out.println(statusCode + "***" + responseBody);
			if (statusCode == 200) {
				System.out.println("Web service executed successfully.");
			} 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();
			}
		}
	}

How to Page?

Topic #9721 : How To Add Support For additional File types in Folder-Import

Applicable Ephesoft versions: 3.1 and up

Ephesoft can process the following file types:

 
  But in order to process them a few settings alterations are required.

Instructions:
 
1. Navigate to the Ephesoft/Application/WEB-INF/classes/META-INF Folder
 

 
2. Open the property file named “folder-monitor.properties” in a text editor as admin.
 

 
3. On line 2 of the properties add the supported file extensions you would like Ephesoft to handle.
 

 
4. Restart Ephesoft.
 
 
< Back | How To Main Page

This API will create the new document type for the specified batch class supplied as an input.

Request Method POST

Web Service URL:

http://{serverName}:{port}/dcma/rest/batchClass/documentTypeCreator

Input Parameters:

Check List:-

1. documentTypeName should be unique and non-empty.
2. minConfidenceThreshold should be a value between 0 and 100.
3. formProcessingProjectFile should be a name of pre-existing RSP/ZON file.
4. batchClassIdentifier should be an identity of pre-existing Batch Class.

Sample Input XML:

<?xml version="1.0" encoding="UTF-8"?>

<WebServiceParams>

<Params>

<Param>

<Name>documentTypeName</Name>

<Value>MyDocument</Value>

</Param>

<Param>

<Name>documentTypeDescription</Name>

<Value>Abcd</Value>

</Param>

<Param>

<Name>minConfidenceThreshold</Name>

<Value>100</Value>

</Param>

<Param>

<Name>firstPageProjectFile</Name>

<Value>FPR.rsp</Value>

</Param>

<Param>

<Name>batchClassIdentifier</Name>

<Value>BC4</Value>

</Param>

<Param>

<Name>hidden</Name>

<Value>FALSE</Value>

</Param>

</Params>

</WebServiceParams>

Note: Values highlighted in blue should be replaced with corresponding values while executing the Web service for copying an existing batch Class.

Sample client code using apache commons http client:-

private static void createDocumentType() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/batchClass/documentTypeCreator";
		PostMethod mPost = new PostMethod(url);
		// Adding Input XML file for processing
		File file = new File("C:\\sample\\sample.xml");
		Part[] parts = new Part[1];
		try {
			parts[0] = new FilePart(file.getName(), file);
			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();
			}
		}
	}

This API will upload files for learning for a particular document type in a batch class to

• Shared Folder\ [BatchClassID]\lucene-search-classification-sample folder

[Document-Type] _First_Page
[Document-Type] _Middle_Page
[Document-Type] _Last_Page

• image-classification-sample folder [Application-Installed-Path]\Shared Folder\ [BatchClassID]\image-classification-sample folder

[Document-Type] _First_Page
[Document-Type] _Middle_Page
[Document-Type] _Last_Page

• Both (image-classifiation and lucene) depending upon input parameters supplied.

This Web Service API can upload files (tif/tiff) for multiple document type of a batch class. Only files will be uploaded to the respective folders.

The upload instruction will be in the form of specific xml format.

Request Method POST

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

Input Parameters: Input parameters are a XML file and tiff file/files

XML file Input parameters

Other than above parameters specified in xml files, user need to upload a complete and accurate XML with other learning files (tif/tiff files).

Sample XML file format:

<upload_learning_files>

<batch_class_id>BC5</batch_class_id>

<doc_type>

<doc_type_name>US Invoice</doc_type_name>

<learning_type>Both</learning_type>

<page_type_first>

<files_to_be_uploaded>

<file_name>US-Invoice.tif</file_name>

</files_to_be_uploaded>

</page_type_first>

<page_type_middle>

<files_to_be_uploaded>

<file_name>US-Invoice2.tif</file_name>

</files_to_be_uploaded>

</page_type_middle>

<page_type_last>

<files_to_be_uploaded>

<file_name>US-Invoice3.tif</file_name>

</files_to_be_uploaded>

</page_type_last>

</doc_type>

</upload_learning_files>

Check List:-

Before uploading following points need to ensured first:

• XML and other required learning files are attached with the request.
• Name of learning files mentioned in the XML must match with the file name uploaded with the request.
• XML format must be same as it shown in Sample XML format. Rearrangement of the xml is not allowed.
• batch_class_id, doc_type_name, learning_type, are mandatory information and must need to be specified. User cannot omit these fields.
• If user don’t upload file for particular page type(first, middle and last). He can omit the whole block. (Starting from page_type_first, page_type_middle or page_type_last ).
• All the upload information need to be uploaded in single XML file. User cannot split information across different XML and then upload all of them. Only 1 xml will be allowed at a time.
• In a xml file there needs to be single batch_class_id, but there can be multiple <doc_type>. Inside a doc_type there can only one doc_type_name, learning_type , page_type_first, page_type_middle, page_type_last block.
• If learning files for a particular page folder(ex. First page) are getting uploaded in a single file Zip folder need to follow a specific structure. {zipfileName.zip} à {zipFileName folder} à{file1, file 2, file3 and so on}. Zip file name and first folder name inside zip file needs to be same.

Sample client code using apache commons http client:-

private static void uploadLearningFile() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/batchClass/uploadLearningFile";
		PostMethod mPost = new PostMethod(url);
		// Adding Input XML file for processing
		File file = new File("C:\\sample\\sample.xml");
		File file1 = new File("C:\\sample\\US-Invoice.tif");
		File file2 = new File("C:\\sample\\US-Invoice2.tif");
		File file3 = new File("C:\\sample\\US-Invoice3.tif");

		Part[] parts = new Part[4];
		try {
			parts[0] = new FilePart(file.getName(), file);
			parts[1] = new FilePart(file1.getName(), file1);
			parts[2] = new FilePart(file2.getName(), file2);
			parts[3] = new FilePart(file2.getName(), file3);

			MultipartRequestEntity entity = new MultipartRequestEntity(parts, mPost.getParams());
			mPost.setRequestEntity(entity);
			// send post request to server
			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 (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (mPost != null) {
				mPost.releaseConnection();
			}
		}
	}

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.

Request Method: GET

Web Service URL: [http://{serverName}:{port}/dcma/rest/runBatchInstance/{batchInstanceIdentifier}]

Input Parameters for the Web Service are as follows:

Note: Value highlighted in the curly braces in input URL should be replaces with corresponding values.Module name should end with _module.

Sample client code using apache commons http client:-

private static void runBatchInstance() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/runBatchInstance/BI4";
		GetMethod getMethod = new GetMethod(url);
		int statusCode;
		try {
			statusCode = client.executeMethod(getMethod);
			if (statusCode == 200) {
				System.out.println("Web service executed successfully.");
				String responseBody = getMethod.getResponseBodyAsString();
				System.out.println(statusCode + " *** " + responseBody);
			} else if (statusCode == 403) {
				System.out.println("Invalid username/password.");
			} else {
				System.out.println(getMethod.getResponseBodyAsString());
			}
		} catch (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (getMethod != null) {
				getMethod.releaseConnection();
			}
		}
	}	

This API extracts the value of document level fields present in the given document type from the image provided. The extraction of the pages will be done based on the project processing file mapped to the first, second, third and last page. For Windows a default page processing file is picked by default in case no file is mapped against the documents in the batch class. In case of Linux if no files are mapped against the pages, no extraction is performed. Backward compatibility has been enabled where the web service will allow old set of input parameters as well as the modified ones. With old set of input parameter extraction will be performed on the input image according to the RSP/ZON file depending upon the environment being Windows or Linux respectively.

Request Method POST

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

Example- http://localhost:8080/dcma/rest/extractFixedForm

Input Parameters                                                                                                                                

Input parameters to the Web Service API would be two files

• Tiff/PNG (single page or multipage)
• XML file, with document type and batch class identifier as parameters.

Sample XML

<WebServiceParams>

<Params>

<Param>

<Name>batchClassIdentifier</Name>

<Value>BC8</Value>

</Param>

<Param>

<Name>docType</Name>

<Value>US Invoice</Value>

</Param>

</Params>

</WebServiceParams>

Alternate (old) Input Parameters

Alternate Input parameters to the Web Service API would be three files

• Tiff/PNG (single page or multipage)
• XML file, with colorSwitch and projectFile as parameters.
• Page processing file

Sample XML

<WebServiceParams>

<Params>

<Param>

<Name>colorSwitch</Name>

<Value>OFF</Value>

</Param>

<Param>

<Name>projectFile</Name>

<Value>US_INVOICE.rsp</Value>

</Param>

</Params>

</WebServiceParams>

CheckList:

• If colorSwitch is ON then image should be PNG.
• If colorSwitch is OFF then image should be Tif/Tiff.
• For Linux Operating System, the color switch is set to OFF, by default.
• In case the color switch is ON and the uploaded image is a Tiff, it is internally converted into a PNG for processing.

Sample client code using apache commons http client for the first set of input parameters:-

private static void extractFixedForm() {
		HttpClient client = new HttpClient();
		String url = " http://localhost:8080/dcma/rest/extractFixedForm ";
		PostMethod mPost = new PostMethod(url);
		// adding file for sending
		File file1 = new File("C:\\sample\\US-Invoice.tif");
		File file2 = new File("C:\\sample\\fixedForm.xml");
		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.");
				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();
			}
		}
	}

Applies to: v4.0.3.0

Following are the known bugs:

1. On Fuzzy DB Plugin Configuration Screen user can enter confidence threshold more than 100.00
2. On Ephesoft upgrade from 3.x to 4.x Fuzzy DB and DB Export settings are not copied.
3. When Batch Class Tree Navigation Panel is collapsed, then user is unable to open Document Type/Index field/Tables using double click or Ctrl + k shortcut or Open button.
4. Fuzzy DB Mapping Configuration: When user resets a mapping from a document type then mappings in other document type with same index field name is also deleted.
5. Minor UI issues on Internet Explorer Version 11.

Overview
Web service API to query the current running status of the web service. This web service is only useful with initiateOcrClassifyExtract web service. Using this web service the user can figure out the completed state of the ocrClassifyExtract web service request. On running the initiateOcrClassifyExtract web service, a numeric token is returned. The checkWSStatus web service uses this token to determine the current operational state. The various states a web service can be into are
• SPLIT_COMPLETED
• OCRing_COMPLETED
• CLASSIFICATION_COMPLETED

Input Parameters
Input parameters to the Web Service API would be a valid numeric token. ocrToken

Output Parameters
The outputs to the web service varies as follows.
When the initiateOcrClassifyExtract web service is performing split, OCR or classification results would be SPLIT_COMPLETED, OCRing_COMPLETED and CLASSIFICATION_COMPLETED respectively. When the web service completes the extraction, the result is a valid xml file with extracted fields and values.

Service Request : GET

Web Service URL
http://:8080/dcma/rest/checkWSStatus

Example-
http://localhost:8080/dcma/rest/checkWSStatus

Sample client code using apache commons http client:-

private static void checkWSStatus ()  {
HttpClient client = new HttpClient();
String url = ” http://localhost:8080/dcma/rest/checkWSStatus?ocrToken=1233232323 “;
GetMethod getMethod = new GetMethod(url);
int statusCode; try { statusCode = client.executeMethod(getMethod);
if (statusCode == 200) {
System.out.println(“Web service executed successfully.”);
String responseBody = getMethod.getResponseBodyAsString();
System.out.println(statusCode + ” *** ” + responseBody);
}
else if (statusCode == 403) {
System.out.println(“Invalid username/password.”);
}
else {
System.out.println(getMethod.getResponseBodyAsString());
}

}
catch (HttpException e) {
e.printStackTrace();
}
catch (IOException e) {
e.printStackTrace();
}
finally {
if (getMethod != null)
{
getMethod.releaseConnection();
}
}
}

* – All versions of CentOS 6.x or lower will not be supported due to Compliance issues with the Nuance OCR engine.

4030_Performance_Reports

These are the details on the batch.xml schema.

Known Issues Articles

Known Issue#: 9590

Topic/Category: DB Export

Ephesoft version(s) Affected: All

Issue:

A generic error log of MS SQL database “Data truncation” is logged. This error tells then Ephesoft is trying to insert longer string then defined for the column. Please refer below error logs:

//——

Caused by: com.ephesoft.dcma.core.DCMAException: DB Export Plugin: Problem occured in exporting batch document level fields to database Error occured in executing query

at com.ephesoft.dcma.dbexport.service.DbExportServiceImpl.dbExport(DbExportServiceImpl.java:55)

at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)

at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)

at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)

at java.lang.reflect.Method.invoke(Method.java:606)

at org.springframework.aop.support.AopUtils.invokeJoinpointUsingReflection(AopUtils.java:318)

at org.springframework.aop.framework.ReflectiveMethodInvocation.invokeJoinpoint(ReflectiveMethodInvocation.java:183)

at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:150)

at org.springframework.aop.aspectj.AspectJAfterThrowingAdvice.invoke(AspectJAfterThrowingAdvice.java:55)

at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172)

at org.springframework.aop.interceptor.ExposeInvocationInterceptor.invoke(ExposeInvocationInterceptor.java:90)

at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172)

at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:202)

at com.sun.proxy.$Proxy150.dbExport(Unknown Source)

at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)

at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)

at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)

at java.lang.reflect.Method.invoke(Method.java:606)

at org.activiti.engine.impl.javax.el.BeanELResolver.invoke(BeanELResolver.java:483)

… 102 more

Caused by: com.ephesoft.dcma.core.exception.DCMAApplicationException: DB Export Plugin: Problem occured in exporting batch document level fields to database Error occured in executing query

at com.ephesoft.dcma.dbexport.DbExporter.exportBatchToDb(DbExporter.java:89)

at com.ephesoft.dcma.dbexport.service.DbExportServiceImpl.dbExport(DbExportServiceImpl.java:51)

… 120 more

Caused by: com.ephesoft.dcma.core.exception.DCMAApplicationException: Error occured in executing query

at com.ephesoft.dcma.dbexport.util.DBExportUtil.insertItems(DBExportUtil.java:539)

at com.ephesoft.dcma.dbexport.DbExporter.exportBatchToDB(DbExporter.java:102)

at com.ephesoft.dcma.dbexport.DbExporter.exportBatchToDb(DbExporter.java:83)

… 121 more

Caused by: java.sql.DataTruncation: Data truncation

at net.sourceforge.jtds.jdbc.SQLDiagnostic.addDiagnostic(SQLDiagnostic.java:382)

at net.sourceforge.jtds.jdbc.TdsCore.tdsErrorToken(TdsCore.java:2820)

at net.sourceforge.jtds.jdbc.TdsCore.nextToken(TdsCore.java:2258)

at net.sourceforge.jtds.jdbc.TdsCore.getMoreResults(TdsCore.java:632)

at net.sourceforge.jtds.jdbc.JtdsStatement.processResults(JtdsStatement.java:584)

at net.sourceforge.jtds.jdbc.JtdsStatement.executeSQL(JtdsStatement.java:546)

at net.sourceforge.jtds.jdbc.JtdsStatement.executeImpl(JtdsStatement.java:723)

at net.sourceforge.jtds.jdbc.JtdsStatement.executeUpdate(JtdsStatement.java:1166)

at net.sourceforge.jtds.jdbc.JtdsStatement.executeUpdate(JtdsStatement.java:1119)

at com.ephesoft.dcma.dbexport.util.DBExportUtil.exportToDB(DBExportUtil.java:553)

at com.ephesoft.dcma.dbexport.util.DBExportUtil.insertItems(DBExportUtil.java:526)

… 123 more

Root Cause:

Database table mapped to batch class BC5 for DB export Export_Invoice_line_Items contains column Description whose length is limited to 50 characters

Solution:

Alter the table length to fit the string being exported.

Updates:

Ex: 1/1/14 – Patch was provided for v3.1.2.5, Permanent solution will be included in v3.1.2.6 or higher

< Back| Known Issues Main Page | Next Known Issue #? >

KB Articles

KB Article # 9538

Topic/Category: Validation

Issue: Two Levels of Ephesoft Validation

Detail:

When deploying a multi-server Ephesoft cluster, there are a few Best Practices recommendations.

Prerequisites:

1. Database
   1. When creating an Ephesoft cluster, it is recommended that you first install MSSQL or MySQL on a server which will not be a processing server or a UI server. This minimizes the running processes, utilized RAM, I/O reads and writes, and network requests send to this server.
   2. Currently we support failover databases with the MSSQL always on availability feature. We recommend you run a second server which hosts the redundant databases for ephesoft so that you minimize single points of failure in case of hardware or OS issues.
   3. We recommend weekly database backups. Ephesoft must be stopped for the backups to occur.
2. SharedFolders
   1. It is recommended that you install the SharedFolders on a separate machine from any of the processing or UI servers. This is to minimize I/O read and writes, along with minimizing network requests to the server and drive hosting the SharedFolders.
   2. We also recommend weekly backups of the SharedFolders when the databases are backed. Ephesoft must be stopped for the backups to occur.
   3. If possible, RAID shares are preferred.
3. Workflows and other configurations
   1. By default, in Ephesoft 4.0 based versions, the pickup service is set to run on only one server at a time in the cluster. This prevents two machines from requesting the same batch class. The cron schedule for this no longer has to be scheduled.
   2. It is recommended to set the email import service to run on a UI server to minimize CPU utilization, I/O reads and writes, and network traffic on the processing servers so that they can focus on the Ephesoft workflow.
   3. “clean error job” executing on each server in a multi-server environment at same time can cause deadlock issues. We would recommend to schedule this in such a way that at no time it is executing simultaneously on multiple servers.
      Following changes would be required to do so:     
           Property File: <Application Directory>/WEB-INF/classes/META-INF/dcma-workflows.properties
           Property: dcma.clean.error.job.cronjob.expression
           Value:  
               0 0/30 * ? * * on server 1
               0 5/30 * ? * * on server 2
               0 15/30 * ? * * on server 3 … and so on

How to Page?

Topic #9721 : How To Add Support For additional File types in Folder-Import

Applicable Ephesoft versions: 3.1 and up

Ephesoft can process the following file types:

 
  But in order to process them a few settings alterations are required.

Instructions:
 
1. Navigate to the Ephesoft/Application/WEB-INF/classes/META-INF Folder
 

 
2. Open the property file named “folder-monitor.properties” in a text editor as admin.
 

 
3. On line 2 of the properties add the supported file extensions you would like Ephesoft to handle.
 

 
4. Restart Ephesoft.
 
 
< Back | How To Main Page

Topic #1 : Add Filebound Export Plugin in 4.0.x

Applicable Ephesoft versions: 4.0.x

In the 4.0 release of Ephesoft, the FileBound Export Plugin was removed. In order to add it manually to the workflow, you will need to follow the instructions below.

Associated Download:  dcma-filebound.zip

Instructions:

1. Stop Ephesoft server
2. Extract the dcma-filebound.zip content at a temporary location.
3. Go to [Ephesoft_home]\Application\WEB-INF\classes\META-INF\* directory.
4. Copy extracted directory dcma-filebound to META-INF folder.Structure of META-INF folder will be like:—META-INF—–|—–dcma-filebound—–

   |— applicationContext.xml

   |— dcma-filebound.properties

   |— filebound-field-lookup.properties

   |— init-testdata.sql

5. Run below query in Ephesoft database :For MySQL :UPDATE plugin SET is_deleted=b’0′ WHERE  plugin_name=’FILEBOUND_EXPORT’;

    

   For MS SQL:

   UPDATE plugin SET is_deleted=’0′ WHERE  plugin_name=’FILEBOUND_EXPORT’;

6. Start Ephesoft Service

File bound export plugin will be added to available plugins list.

< Back | How To Main Page| Next How To Article #? >