Overview

CMIS Import feature downloads files from CMIS server and process them as batches in Ephesoft Application. Using CMIS import user can monitor the CMIS server using a cron-job which checks the specified folder for a new file after the specified interval of time. Along with the document, its properties are also downloaded in an XML format. Users can write their own custom scripts to access these properties in the batch that is being executed.

Batch is created for every file downloaded file from the CMIS server and execute it on the Ephesoft Application.

Format Of Downloaded XML (containing document properties)

<CmisImport>

<Properties>

<Property>

<Name>Description</Name>

<Value/>

</Property>

<Property>

<Name>Title</Name>

<Value>BI1E_documentDOC2.pdf</Value>

</Property>

...

</Properties>

</CmisImport>

CMIS Import feature downloads the file having valid file extension and having cmis property configured in the Property column which have the value mention in the Value column. After downloading the file from CMIS server our application updates that property value using new value configured in the New Value property.

E.g.

CMIS server contains 15 documents but 10 of them are valid as per our confgured file extensions. User has configured the Property as “cm:author” and its configured value is “Ephesoft”.

It means that only those documents out of 10 documents which satisfy the cmis property “cm:author” = “Ephesoft” will be downloaded by the application and downloaded document’s cmis property “cm:author” will be updated to New configured Value.

Configuration

User can specify the CMIS server configuration in the batch class.

C:\Users\anika2078\Desktop\2.png

Configurable property Type of value Value options Description
Server URL String NA For example : http://{Server_ip}:{port_number}/alfresco/service/cmis for Alfresco 3.x with CMIS 1.0

http://{Server_ip}:{port_number}/alfresco/cmisatom for Alfresco 4.x with CMIS 1.0

http://<hostname>:<port>/alfresco/api/-default-/public/cmis/versions/1.1/atom for Alfresco 4.2d to Alfresco 5.x used with CMIS 1.1

http://<hostname>:<port>/alfresco/api/-default-/public/cmis/versions/1.0/atom for Alfresco 4.2d to Alfresco 5.x used with CMIS 1.0

Username String NA User name for authentication to the specified for CMIS server.
Password String NA Password for authentication to the specified for CMIS server. Password is not visible to user.
Repository ID String NA CMIS server repository ID.
File Extension String Read only Supported file extensions which will get downloaded. We are supporting only pdf and tiff files.
Folder String NA Folder name on the CMIS server from where files need to be downloaded.
Property String NA This property is used to specify the cmis property which should be used to download file from CMIS server. Valid documents containing this property with the specified value mentioned below will be marked for selection.

e.g. cmis:name, cm:description, cm:title, cm:author

Value String NA This property contains the value for the property mentioned above. This key value pair decides which document will get downloaded.
New Value String NA This specifed the new value to be updated after downloading file the cmis server of the specified cmis property. This is to ensure that same document doesn’t get downloaded again.
CMIS Version List of values
  • 1.1
  • 1.0
This property identifies the version of CMIS used by uploaded documents for repository connection.

If any field of CMIS Import configuration is not valid that field will be shown in red color.

Cron job expression

For cron job expression which specify the interval at which CMIS server need to be monitored, user needs to update property cmisImport.cronxpression available in {Application}\WEB-INF\classes\META-INF\dcma-cmis-import\cmis-import.properties properties file.

cmisImport.cronxpression=0 0/15 * ? * *

Default value for this property is set to every 15 mins.

Disabling/Enabling CMIS import functionality

For enabling/disabling CMIS import functionality user can uncomment/comment the following line in {Application}\applicationContext.xml

<import resource=”classpath:/META-INF/applicationContext-dcma-cmis-import.xml” />

Default: CMIS import is disabled.

Screenshots for Configuration

Screenshot for CMIS folder:

Screenshot for CMIS document:

Screenshot for CMIS properties:

Screenshot for CMIS repository information:

Using Alfresco version before 4.2d:

To use Alfresco before 4.2d Repositories for Ephesoft v4.0.x.y (prior to v4.0.3.0), user needs to apply a HOT-FIX. Steps to change to this version are as follows:

1. Stop the Ephesoft server.

2. Remove following listed JARs from [EphesoftInstallationDirectory]\Application\WEB-INF\lib\*:

a. chemistry-opencmis-client-api-0.10.0.jar

b. chemistry-opencmis-client-bindings-0.10.0.jar

c. chemistry-opencmis-client-impl-0.10.0.jar

d. chemistry-opencmis-commons-api-0.10.0.jar

e. chemistry-opencmis-commons-impl-0.10.0.jar

d. alfresco-opencmis-extension-1.0.jar

3. Paste following jar files from the HOT-FIX at [EphesoftInstallationDirectory]\Application\WEB-INF\lib\*:
a. chemistry-opencmis-client-api-0.6.0.jar

b. chemistry-opencmis-client-bindings-0.6.0.jar

c. chemistry-opencmis-client-impl-0.6.0.jar

d. chemistry-opencmis-commons-api-0.6.0.jar

e. chemistry-opencmis-commons-impl-0.6.0.jar

f. alfresco-opencmis-extension-0.2.jar

g. dcma-cmis-import*.jar
4. Restart the Ephesoft server.

Troubleshooting

S no. Error message Possible root cause
1 Unable to connect to the server Invalid configuration being used for making connection to the cmis server.
2 Error while generating cmis properties xml
  • Either {Ephesoft Application} doesn’t have access to write the properties on the disk or
  • Either Ephesoft was unable to connect to network path while writing the file.

Was this article helpful to you?

Engineering

Comments are closed.