jExperience quick install
This topic show you how to run jExperience as a local instance.
Installing the JDK
Install JDK 8 (see http://www.oracle.com/technetwork/java/javase/downloads/index.html) and ensure you set the
JAVA_HOME variable (https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/).
Installing and configuring Elasticsearch
You can find the Elasticsearch prerequisites here: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html
To install and configure Elasticsearch:
- Download and unzip Elasticsearch 5.6.16.
- Edit the
config/elasticsearch.ymlfile and change the
<defineYourClusterName>. For example, rename
- Start Elastic Search:
To install jCustomer:
- Download and unzip jCustomer.
- Add a new text file in the
unomi.custom.system.propertiesand add the property
- (Optional) jCustomer requires an IP database to resolve IP addresses to the user location. The GeoLite2 database can be downloaded from MaxMind here: http://dev.maxmind.com/geoip/geoip2/geolite2/
Simply download the GeoLite2-City.mmdb file into the
- (Optional) jCustomer includes a geocoding service based on the Geonames database that is used to create conditions on countries or cities.
Get the allCountries.zip database from here: allCountries.zip. Download it and put it in the
etcdirectory without unzipping it. The import can take about 15 minutes and runs in the background.
- Start jCustomer using:
- On the first start, you'll need to execute the following command:
- Try accessing https://localhost:9443/cxs/cluster with username karaf and password karaf . If you receive a certificate warning in your browser, accept the warning as it is safe.
- You can try accessing https://localhost:9443/cxs to check the available jCustomer services.
Enabling jExperience modules
If your server does not have access to internet, download the module from the following address: https://store.jahia.com/contents/modules-repository/packages/MarketingFactory.html and deploy it to your Jahia server.
Follow the steps below if the server on which your Jahia - Enterprise Distribution ONLY - is running can access the Internet:
- Go to the Module Management interface of a running Jahia (Enterprise Distribution) instance.
- Click on Available modules and type "jExperience" in the search box.
- Select the Enterprise jExperience Package and click Download.
Configuring jExperience connections to jCustomer
Once the jExperience module is started, it requires a configuration file. You can either create a file from scratch or download this sample file.
- Rename the file name to org.jahia.modules.marketingfactory.settings-global.cfg (replace "-sample" by "-global")
- Edit the following properties (or copy paste the text below):
# Mandatory connection properties are: mf.unomiURL=https://localhost:9443 mf.unomiPassword=karaf mf.unomiUsername=karaf # Optional properties and there default value: # Trust all certificate mf.unomiTrustAllCertificates=true # Use public addresses for admin mf.unomiUsePublicAddressesForAdmin=false # Unomi KEY mf.unomiKey=670c26d1cc413346c3b2fd9ce65dab41
The configuration reloads without restarting the Jahia server.
- To verify that the connection is working:
- Go to Jahia>Edit Mode (on any site where jExperience is enabled)>Site settings>Manage connection to jCustomer.
- Verify that the jCustomer Status: ONLINE.