4.4 Configuring the caching locators in clusters (caching using TCP only)

The AEM forms installer creates a default configuration of the TCP locators that is ready to use without modification. You can move the locators to any computer on your network and run them on that computer. The locators do not have to reside on a computer that is a member of the AEM forms cluster. You can also create additional failover locators to support high availability in your cluster. (See 4.4.2 Install TCP locators )

You can also modify the TCP locators to use a port other than the default port (22345). (See 4.4.3 Modify the default locator port (Windows) or 4.4.4 Modify the default locator port (UNIX) .)

1. Log on to the computer where you installed AEM forms and navigate to the [aem_forms root] /lib/ caching directory.

2. Copy the caching directory and its contents to the computer on which you want to run the locators.

   You can start TCP locator from default location. You should copy the caching directory to another location, only if:

   • You want to run TCP locator on a machine that does not have AEM forms.

   • You do not want to start TCP locator from default location.

   Note: Do not run TCP locators on all the nodes of the AEM forms Cluster. It is good practice to run minimum two locators. One TCP locator serves as a primary locator and other TCP locator serves as a secondary locator to handle failover issues. You can add more than two TCP locators as backup locators but it is not mandatory.

1. Open the startlocator.bat file in a text editor. The startlocator file for a default installation is on the computer where you installed AEM forms, in the [aem_forms root] /lib/caching directory.

2. Change the default port number (22345) to your preferred port number in the following properties:

       set port=22345 

   The port number can be any available port between 1025 and 65535.

   Note: Ensure that the port number that is configured here matches the port number that is configured in the JVM argument of each node of the AEM forms cluster.The port number can be any available port between 1025 and 65535.

3. If you are using more than one locator for failover, assign all of such locators to JVM argument -Dlocators listed at the end of the startlocator.bat file.

   -Dlocators=localhost[22345]

4. (Computers with multiple network cards only) If the computer hosting the locator has multiple network cards, set the following properties in the script:

   set bindaddr=<bind IP address>

   Where <bind IP address> is the IP address that the locator will listen on. You must specify the <bind IP address> for the JVM argument adobe.cache.cluster-locators on each node in your AEM forms cluster.

   Note: If you do not specify the bind address and the bind port in the startlocator script, you will be prompted to input these values when you execute the script. However, for IPv6, you must specify the bind address and the bind port in the startlocator script itself.

5. Save the edited file.

6. Repeat steps 1 to 4 on any additional locators for your AEM forms cluster.

1. Open the startlocator.sh file in a text editor. The startlocator file for a default installation is located on the computer where you installed AEM forms, in the [aem_forms root] /lib/caching directory.

2. Change the default port number (22345) to your preferred port number in the following properties:

       GF_PORT=22345 

   The port number can be any available port between 1025 and 65535.

   Important: Ensure that the port number that is configured here matches the port number that is configured in the JVM argument of each node of the AEM forms cluster.

3. If you are using more than one locator for failover, assign all of such locators to JVM argument -Dlocators listed at the end of the startlocator.sh file.

   -Dlocators=localhost[22345]

4. ( Computers with multiple network cards only ) If the computer hosting the locators has multiple network cards, modify the following argument:

           GF_BIND_ADDRESS="<bind IP address>"

   Where <bind IP address> is the IP address that the locator will listen on. You must specify the <bind IP address> for the JVM argument adobe.cache.cluster-locators on each node in your AEM forms cluster.

   Note: For IPv6, it is recommended that you specify the bind address and the bind port in the startlocator script itself.

5. Save the edited file.

6. Repeat steps on any additional locators for your AEM forms cluster.

To use TCP-based caching for AEM forms Cluster using TCP locator, you must start the TCP locators before you start your cluster. If the TCP locators are not running when you start the members of the AEM forms cluster, the AEM forms cluster will not function.

1. On the computer where the TCP locators are installed, navigate to the caching directory. For a default installation, the TCP locators are installed on the computer where you installed AEM forms, in the [aem_forms root] /lib/caching directory.

2. (IPv6 only) Modify startlocator.bat (Windows) or startlocator.sh (UNIX) and add the following JVM arguments:

           -Djava.net.preferIPv6Stack=true 
           -Djava.net.preferIPv6Addresses=true

3. Run the appropriate file:

   • (Windows) startlocator.bat

   • (UNIX) startlocator.sh

4. Repeat above steps on any additional locators for your AEM forms cluster.

1. On the computer where the TCP locators are installed, navigate to the caching directory. For a default installation, the TCP locators are installed on the computer where you installed AEM forms, in the [aem_forms root] /lib/caching directory.

2. Run the appropriate file:

   • (Windows) stoplocator.bat

   • (UNIX) stoplocator.sh

3. Repeat steps 1to 2 on any additional locators for your AEM forms cluster.