Overview

The purpose of this article is to help an end user in setting up Ephesoft License servers in different modes according to his requirement. In below document while referring to Ephesoft license server, it needs to understand that it is not a separate application that needs to be installed separately then Standard Ephesoft, although it is just a part of standard Ephesoft installation that can be disabled and enabled according to the requirement.

Configuration

Starting from v4.0 Ephesoft comes with default License server failover mechanism. If a user has configured a multi-server environment where some servers are acting as license server and others are configured as license client in such environment Ephesoft License server failover mechanism will take control over all the license servers and ensure that all the licensing request are fulfilled in uninterrupted manner even though if one of the license server went down while other servers are still working. There are two mode in which most of the users uses Ephesoft, i.e. single server and multi-server mode. Following is configuration that needs to be done to configure Ephesoft License servers for both these modes.

Single server (Standalone) mode

In single server mode, user don’t need to configure anything explicitly to run License server. By default Ephesoft comes with enabled License server and client. A user will get a message on login page i.e. currently only one license server is active. Please start at least one more license server to utilize License Server fail over Mechanism. This message is just to make a user aware that current configuration is not running in failover mechanism.

Multi-server mode

After setting up Ephesoft servers in multi-server environment (This is wiki link for an article on Ephesoft multi-server deployment.
http://wiki.ephesoft.com/multi-server-deployment
), user needs to enable License server on one or more servers depending upon whether user wants to run it in Failover enabled mode or not. In both the modes license to be generated should have enough license cores to run all the servers in the cluster up to their maximum potential. How to calculate license cores required for a cluster is mentioned in following portion of the document. Following is the configuration that needs to be done for with or without failover mode.

Without Failover

In without failover mode user just need a single license server having enough License cores to serve all the Ephesoft servers in Ephesoft cluster setup. Following is the steps to configure multi-server environment without failover mechanism.

  1. Install Ephesoft license on one of the server available in Ephesoft multi-server environment. Following wiki link will guide a user on license installation. http://wiki.ephesoft.com/ephesoft-license-installation
  2. Once license is installed on a server keep that server aside and start disabling License server from all other servers. To disable license server please follow the instruction available at the end of this document.
  3. Once license server is disabled on all other servers, start the server having license installed. License server needs to be started first such that when other started getting up, they find license server ready to serve their request.
  4. Once Ephesoft server having license server enabled is up and running, start taking all other server up one by one. Now the cluster is ready to process batches.
  5. In this setup user need to ensure that the Ephesoft server running license server must need to be up always as it is sole license server in the Ephesoft cluster. As soon as this server goes down all Ephesoft servers will stop working due to unavailability of license server.

With Failover

In this mode user needs to have minimum two license servers in a cluster, one license server will serve licensing requests and other license server will act as backup license server and will come into action when a server goes down. Following is the steps to configure multi-server environment with failover mechanism.

  1. Install Ephesoft license on two servers available in Ephesoft cluster. User needs to make sure each license installed on servers have enough capacity to server all the serve available in cluster. Following wiki link will guide a user on license installation. http://wiki.ephesoft.com/ephesoft-license-installation
  2. Once license is installed on two servers keep those servers aside and start disabling License server from all other servers. To disable license server please follow the instruction available at the end of this document.
  3. Once license server is disabled on all other servers, start one of the servers on which license was installed. Once first license server is up, start another license server that will act as backup license server in this case and will come into play when first license goes down. License servers needs to be started first such that when other started getting up, they find license server ready to serve their requests.
  4. Once Ephesoft servers having license server enabled are up and running, start taking all other server up one by one. Now the cluster is ready to process batches.
  5. In this setup user need to ensure that at a time one of the Ephesoft servers running license server must need to be up. If one server goes down immediately failover mechanism come to rescue and switch the license requests to backup license server and backup server will become main active server. With the help of failover mechanism user can take down any server for maintaince without affecting batch processing on Ephesoft cluster.

Above configurations will help an end user in configuring Ephesoft in various modes according to his requirement.

Annual Image Count

Starting from v4.0 a new parameter has been added to Ephesoft licensing which will govern the number of pages that can be processed annually by that License. While generating license a user has to provide information about the number of page he would like to process in a year. Once the number pages processed by Ephesoft exceeds the value mentioned in License, user won’t be able to process any more page with the license. He need to get new license from Ephesoft.

How to calculate the license core required for an Ephesoft cluster.

In a cluster we can have some UI server and some processing server. Starting from v4.0 UI servers will require only 4 license core irrespective of the CPU core of UI servers. Processing server will require license core equal to the number of CPU cores on server. For example if we have 5 machine in a cluster and out of them we have 1 UI server and other 4 are processing server. Out of the 4 processing servers 2 have 8 CPU core machines and 2 have 16 CPU core machine. In such cluster setup a user need to have license of 52 core license (8+8+16+16 = 48 license core for processing servers and 4 license core for UI server)

How to configure an Ephesoft server as UI server.

To configure an Ephesoft server as UI server following steps needs to be followed.

  1. Set property thread.pool_size to 0 (available in dcma-core.properties file under {Appllication_home}\WEB-INF\classes\META-INF\dcma-core\* directory}.
  2. Set property server.instance.max.process.capacity to 0 (available in dcma-workflows.properties file under {Appllication_home}\WEB-INF\classes\META-INF\dcma-workflows\* directory}.

How to enable/disable an Ephesoft License server.

Ephesoft License server run as an independent module under Ephesoft application that can be enabled or disabled as required. To enable/disable Ephesoft license server user need to uncomment/comment following lines from application-context.xml file available under {Application_home}\* directory.

Troubleshooting

Following are few common error messages seen in log file due to improper configuration and execution:

S no. Error message Possible root cause
1 CPU limit exhausted. Can’t allocate more CPUs. The total count of CPU core available in all machine in multi-server environment is greater than count specified in license installed. Get a new license with correct CPU core amount.
2 Invalid license for multi-server environment setup. Either mac id of server was not included or it was entered wrong while generating license. Please verify mac id while generating license.

Was this article helpful to you?

Engineering