Over a million developers have joined DZone.

How to Integrate Alfresco With Ephesoft

Check out this great guide to integrating Alfresco and Ephesoft, which can truly help with document and content management.

· Integration Zone

Learn how API management supports better integration in Achieving Enterprise Agility with Microservices and API Management, brought to you in partnership with 3scale

Documents are the foundation of any organization these days. None of us are oblivious to the importance of documents anymore nor to the challenges faced while handling such surge of documents and data. Organizations dealing with big amounts of data in documents are well versed with two software; Ephesoft which is used for document scanning and parsing, and Alfresco for storing and managing the data. Do these two make a great combination, and how do we go about their integration, if at all? Let’s find out.

Image title

Steps to Integrate Alfresco With Ephesoft:

The Content Management Interoperability Services (CMIS) plugin caters to the need of pulling and pushing CMIS compatible documents from repositories like Alfresco, Sharepoint, Nuxeo, etc. So the initiation of Ephesoft and Alfresco integration is done by configuring the CMIS plugin in Ephesoft.

#1 Prepare Ephesoft by Mapping attributes: DLF-Attribute-mapping.properties file needs to be configured in the first step of integration initiation. The DLF-Attribute-mapping.properties file is found at the following location -


The mapping format is given below:

For example if you are mapping invoice data it would be something like this

#2 Preparing Alfresco for Ephesoft: After mapping the attributes in Ephesoft, we need to prepare Alfresco for Ephesoft and save three configuration files in the Alfresco extension directory located at -

< Alfresco installation path>\tomcat\shared\classes\alfresco\extension

The files are enlisted below:

→ ephesoftModel.xml

→ ephesoft-model-context.xml

→ web-client-config-custom.xml (used to configure alfresco web client)


It is the configuration file which contains the parameter mapping. It looks something as follows:

<?xml version="1.0" encoding="UTF-8"?>
<!-- Definition of new Model -->
<!-- The important part here is the name - Note: the use of the my: namespace
  which is defined further on in the document -->
<model name="ephesoft:custommodel" xmlns="http://www.alfresco.org/model/dictionary/1.0">
<!-- Optional meta-data about the model -->   
<description>Example ephesoft custom Model</description>
<!-- Imports are required to allow references to definitions in other models -->   
              <!-- Import Alfresco Dictionary Definitions -->
   <import uri="http://www.alfresco.org/model/dictionary/1.0" prefix="d"/>
   <!-- Import Alfresco Content Domain Model Definitions -->
   <import uri="http://www.alfresco.org/model/content/1.0" prefix="cm"/>
<!-- Introduction of new namespaces defined by this model -->
<!-- NOTE: The following namespace my.new.model should be changed to reflect your own namespace -->
   <namespace uri="custom.model" prefix="ephesoft"/>
   <!-- Definition of new Content Type: Standard Operating Procedure -->
   <type name="ephesoft:ephesoft">
      <title>ephesoft Document Procedure</title>
         <property name="ephesoft:invoiceDate">
         <property name="ephesoft:partNumber">
                            <property name="ephesoft:invoiceTotal">
         <property name="ephesoft:state">
         <property name="ephesoft:city">



   <!-- Definition of new Content Aspect: Image Classification -->
   <aspect name="ephesoft:documentClassification">
      <title>ephesoft Document Classfication</title>
         <property name="ephesoft:size">
         <property name="ephesoft:type">


ephesoft-model-context.xml: This file is used to define any custom configuration between Alfresco and Ephesoft. The ephesoft-model-context.xml, the main file that tells Alfresco to look for ephesoftModel.xml file. It looks like the following:

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
 <!-- Registration of new models -->
 <bean id="extension.dictionaryBootstrap" parent="dictionaryModelBootstrap" 
     <property name="models">

To check the correctness of the configuration we may follow the steps given below:

http:///alfresco/service/cmis, -> Types Collection -> Down which will list all the objects inherited from CMIS document. Once you locate the D:Ephesoft document, then selecting this would display a list of properties, on correct configuration.

id              ephesoft:invoiceTotal
localName       invoiceTotal
localNamespace  http://com.ephesoft.demo/model/content/1.0
displayName     Invoice Total
queryName       ephesoft:invoiceTotal
propertyType    decimal
cardinality     single
updatability    readwrite
inherited       false
required        false
queryable       true
orderable       true
openChoice      false

id              ephesoft:invoiceDate
localName       invoiceDate
localNamespace  http://com.ephesoft.demo/model/content/1.0
displayName     Invoice Date
queryName       ephesoft:invoiceDate
propertyType    datetime
cardinality     single
updatability    readwrite
inherited       false
required        false
queryable       true
orderable       true
openChoice      false

#3 Configuring Ephesoft CMIS Plugin: You can export the batch. By going to http://localhost:8080/dcma/BatchClassManagement.html navigate to document batches in Ephesoft.

Image title

Select the appropriate batch you need to export and click on export from the opened list of actions.

Image title

A new screen pops open.

Image title

After filling the necessary information in the configuration file, click save.

Image title

On an ending note type mismatch is the most common challenge faced during the integration process. So it's preferable to make use of String type in Ephesoft to avoid complications. And there you go, it ensures flawless integration of Alfresco and Ephesoft.

Unleash the power of your APIs with future-proof API management - Create your account and start your free trial today, brought to you in partnership with 3scale.

alfresco,content management,content management system,ecm,integration,document management

The best of DZone straight to your inbox.

Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}