Configure Unica Director to connect to Campaign deployed on Apache Tomcat

About this task

If Unica Campaign is deployed on Tomcat Web Server, please follow below steps to start / stop or get status of Unica Campaign deployment in Tomcat from HCL Unica Director:


1. Configure <TomcatDirectory>/conf/jmxremote.access and jmxremote.password file . Please contact your Tomcat administrator for details .

jmxremote.access: It should provide the access roles for the Tomcat users. User- you should have been provided with access required to get the status like - readonly and readwrite.

Example: Contents of jmxremote.access:

monitorRole readonly

controlRole readwrite

tomcat readwrite

Note : Please ensure you give readwrite permission for controlRole and tomcat

jmxremote.password: It should provide the username and password for the Tomcat user, this file should restrict access to other users other than the user who runs the Director agent.

Example: Contents of jmxremote.password

monitorRole tomcat

controlRole tomcat

tomcat unica*03

2. Add JMXremote configuration(JMX remote access ,JMX password file and JMX port ), JVM argument and JVM Heap size as per the system load and configuration for Unica Campaign application. Please make sure JMXremote port should not conflict with any other application port. Please contact your Tomcat Administrator for details .<JMX_PORT><JMXremote_PORT>  -Djava.rmi.server.hostname=<HOST_NAME>

Here is Sample example which needs to be added in <TomcatDirectory>/bin/

set "CATALINA_OPTS=%CATALINA_OPTS% -Xms2560m -Xmx2560m -XX:MaxPermSize=512m<JMXremote_PORT>$TOMCAT_HOME/conf/jmxremote.password$TOMCAT_HOME/conf/jmxremote.access<JMXremote_PORT> -Djava.rmi.server.hostname=<HOST_NAME>"

set "JAVA_OPTS=%JAVA_OPTS% -DUNICA_PLATFORM_CACHE_ENABLED=true -Dclient.encoding.override=UTF-8

Note : If you don't want to use Autentication for Tomcat Webserver then you have to set JMX remote authenticate option value as false.

E.g :

3. Please replace "localhost" with fully qualified hostname (eg. in server.xml in following places :


a) <Host name="" appBase="webapps" unpackWARs="true" autoDeploy="true">

b) <Engine name="Catalina" defaultHost="">

4. Create a directory with fully qualified host name under $TOMCAT_HOME/conf/Catalina/ . Copy campaign.xml from $TOMCAT_HOME/conf/Catalina/localhost/ to $TOMCAT_HOME/conf/Catalina/<fully_qualified_host_name>/campaign.xml



5. Restart the Tomcat web application server so your changes take effect.

Configuring Tomcat WebServer in HCL Unica Director:


  1. In the Environment Page of Unica Director Configure Web Server as Tomcat by providing full Qualitified host name , applicaiton name ,agent port , Campaign Home and Web Server details which inclues Server Type and JMX port . Below is an example:

    E.g :

    *SERVER HOST - Fully qualified name with domain E.g :


    *AGENT PORT - 1112

    *AGENT ON HTTPS - False

    *CAMPAIGN HOME - C:\HCL\MarketingSoftware11\Campaign


    *Server type - Tomcat

    *Tomcat JMX Port - 9080

  2. Go to Health Check ->Application Deployment. You can now get the Status of the Unica Campaign Application / start or stop Unica Campaign Application deployed on the Tomcat Server.

    Note: Starting / stopping Unica Campaign Application status can be checked in the Job queue.

    Status will be shown in Application Deployment with a Green(Running) or Red icon (Stopped) with TimeStamp.