Restarting CRX Server without stopping a JBoss Server Instance

Since the release of ES3, the CRX Server comes integrated with the LiveCycle Document Services.(NOTE: SA Installer should be run on an existing LiveCycle Document Services Installation in order to get the benefits of CRX Server and Correspondence Management Solution)

The CRX wars namely, crx-explorer_crx.war and crx-launchpad.war are bundled inside the core EAR, i.e. adobe-livecycle-jboss.ear.

There are times when a restart of the CRX Server is required due to some changes in configuration/settings or issues related to bundle activation.
Since the wars are bundled inside the core ear, the whole of JBoss server instance needs to be restarted to get things done.
This ultimately consumes time and things on the doc-services side also get blocked due to some task pending at CRX end.

Let’s handle the two issues separately,

i. Issues related to Bundle Activation

There is an easy way out where one can just shutdown the CRX server and Restart it again without interfering with the LiveCycle Server Instance.

Go to, http://localhost:8080/lc/system/console/vmstat (Snapshot at the end of the post)
It has two buttons,
a. Restart – Clicking on this will restart all the bundles and the framework.
b. Stop – Clicking on this will stop all the bundles and the framework.
In order to start the framework and the bundles, Just refresh the browser or hit the above mentioned URL again.
The LiveCycle services running under the Jboss server instance won’t be affected at all.

The above settings solves the issue of Bundle Activation because it restarts CRX LaunchPad. But it doesn’t start the whole of CRX due to which changes in repository.xml or bootstrap.properties don’t get reflected.

ii. Changes in Configuration/Settings like repository.xml, bootstrap.properties, etc.

For such changes to get reflected, the best way is to re-deploy the CRX war.
JBoss provides a seamless way of doing that through JMX Console.
a. Go to http://localhost:8080/jmx-console. (For more information on JMX-Console handling I’ll write a separate blog post)
b . Once inside JMX-Console, search for jboss.web.deployment section.
c. Click on the link named war=/crx.
d. Now you can stop and start the war by clicking on the respective “Invoke” buttons to get the settings and configuration reflected. This won’t affect the other LiveCycle Document Services running in parallel.

Bookmark and Share

3 Responses to Restarting CRX Server without stopping a JBoss Server Instance

  1. > Since the release of ES3, the CRX Server comes integrated with the Livecycle Document Services.
    > The CRX wars namely, crx-explorer_crx.war and crx-launchpad.war are bundled inside the core EAR, e.g. adobe-core-jboss.ear.

    Thanks for this post, but I’ve found it a little confusing. I have a turnkey install of LC ES3 but it doesn’t look like CRX was installed. There’s no adobe-core-jboss.ear, just the usual adobe-livecycle-jboss.ear and adobe-livecycle-native-jboss-x86_win32.ear files. I looked within those files and didn’t see any CRX. Additionally, when I went into the jmxconsole I didn’t find a /crx as described in your blog entry.

    I did find a CRX jar file in the CRX directory of the install image with a runnable .jar file, but I didn’t see any way to install this into JBoss.

    What am I missing? Sorry if I’ve overlooked something obvious.

    • apugalia says:

      Rob,
      There are two Installers shipped with ES3.
      a. LiveCycle Doc Services Installer – the one that you have currently installed on your system
      b. LiveCycle SA Installer

      What you see currently is a plain LiveCycle Installer similar to the earlier versions.
      You have to optionally install the SA Installer in order to leverage the benefits of CRX and thereby Correspondence Management Solution.
      This Installer patches the core ear by injecting the CRX wars into the same.
      The Correspondence Management Solution is not supported on JBoss 4.2.1. So, make sure that you’ve selected a higher version of Jboss while upgrading/installing LiveCycle ES3.

      For more information on Correspondence Management Solutions, please go through the following link,
      http://help.adobe.com/en_US/livecycle/10.0/InstallSolution/index.html

      “There’s no adobe-core-jboss.ear, just the usual adobe-livecycle-jboss.ear” –
      If you look into the LiveCycle_Installation\deploy folder, there is a adobe-core-jboss.ear.
      This is the foundation ear which when bundled up with other components during LCM(LiveCycle Configuration Manager) run, gets converted into adobe-livecycle-jboss.ear and gets exported to the JBoss deploy location.
      Thanks for pointing that out, I’ll update the post.

  2. Pingback: Using JMX-Console in Jboss for debugging LiveCycle applications | Apugalia