This topic shows you how to run jExperience on a local environment. To run jExperience you:
Install JDK 8 (see Oracle Java SE Downloads) and set the JAVA_HOME
variable (see Oracle's Installing the JDK Software and Setting JAVA_HOME documentation). Note that JDK 11 is also supported but JDK 8 is the preferred version for compatibility reasons.
You can find the Elasticsearch prerequisites here: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html
To install and configure Elasticsearch:
config/elasticsearch.yml
file and change thecluster.name
property to your own cluster name. It's important to use a dedicated cluster name because Elasticsearch will automatically try to connect with other servers on the same network, leading to conflicts between each local environment. For example, you can change the property value to myclustername
.
cluster.name: myclusternameNote: The pound sign (#) comments out properties in the file. Remember to remove the pound sign when you specify the cluster name.
./bin/elasticsearch
Install jCustomer and create a properties file that specifies your Elasticsearch cluster name.
To install jCustomer:
jcustomer-1.5.4/etc
folder.unomi.custom.system.properties
.org.apache.unomi.elasticsearch.cluster.name=<yourClusterName>
where <yourClusterName>
is the cluster name that you specified for Elasticsearch earlier. For example:
org.apache.unomi.elasticsearch.cluster.name=myclustername
etc
directory.etc
directory without unzipping it. The import can take about 15 minutes and runs in the background.
./bin/karaf
unomi:start
Wait for startup to complete. This step is not necessary on future server startups. The jCustomer bundles (packages) will start automatically.If your server does not have access to internet, download the module from the Jahia store and deploy it to your Jahia server. If the server on which your Jahia Enterprise Distribution is running can access the internet, follow the steps below.
To enable jExperience modules:
jExperience
in the Search module by keyword field.Started
.Once the jExperience module is started, it requires a configuration file to connect to jCustomer.
To configure the jExperience connection to jCustomer:
digital-factory-data/karaf/etc
subfolder. For example, navigate to:
Jahia-8.0.0.0/digital-factory-data/karaf/etc
org.jahia.modules.jexperience.settings-global.cfg
. Either create a file from scratch or download this sample file. # Mandatory connection properties are: jexperience.jCustomerURL=https://localhost:9443 jexperience.jCustomerPassword=karaf jexperience.jCustomerUsername=karaf # Optional properties and there default value: # Trust all certificate jexperience.jCustomerTrustAllCertificates=true # Use public addresses for admin jexperience.jCustomerUsePublicAddressesForAdmin=false # Unomi KEY jexperience.jCustomerKey=670c26d1cc413346c3b2fd9ce65dab41
The configuration reloads without restarting the Jahia server.