Configuring FACT-Finder

This section expects a successful installation and Server Setup and the Tomcat running on port 8080.

As mentioned, the FACT-Finder Framework consists of three linked  web applications. For simplicity, we expect all applications running on the same server. In general, these instructions are valid for other scenarios. Only some paths and details have to be adjusted.

Search Client

Take the search application you ahve received from Omikron and rename it fact-finder.war. Place it in the tomcat/webapps folder. (Example: /var/lib/tomcat8/webapps). Best keep an eye on the Tomcat's catalina.out logfile to stop potential errors. The application creates a generates a fact-finder folder on startup in the directory defined as FACTFINDER_RESOURCES (Example: /opt/factfinder). This is where the initial configuration files are put. Please check the directory has been created correctly.

One of the most important FACT-Finder config files is fff.properties. You can find these under /opt/factfinder/fact-finder/conf/. In it, make these changes:

KeyDescriptionExample Value
server.public.urlDetermines the external URl for reaching the search application. The UI uses it in several places, it is required for linking the applications.http://dev.fact-finder.de/fact-finder
analytics.urlDetermines the URL for reaching the Analytics application to allow inter-system communication.http://localhost:8080/analytics

Once the values have been adjusted, call the search application in your browser via this URL:

http://<Adresse Ihres Servers>:8080/fact-finder/Management.ff

If you see the FACT-Finder login screen, the installation was so far successful. Continue with the next application.

Customising the SMTP Server

The FACT-Finder application is, in some cases, able to send notification e-mails. By default, these are sent via SMTP server. If the application is not connected to the internet or there are problem with sending and receiving mails you can specify a different mailserver via the  mailServer.properties config file. This file is in the same directory as fff.properties (In our example: /opt/factfinder/fact-finder/conf/). In this file, the following customisations can be made:

Configuration Key DescriptionExample ValueStandard Value
mail.transport.protocolessentialProtocol used for mail delivery.smtpsmtp
mail.smtp.localhostessentialLocalhost adressyourDomain.defact-finder.de
mail.smtp.connectiontimeoutessentialConnection timeout for mail server communication in milliseconds120000120000
mail.smtp.timeoutessentialSession timeout for mail server communication in milliseconds600000600000
mail.smtp.hostoptionalMail server address. By default or if not explicitely defined, it is determined by MX-Lookup.mail.yourDomain.com-
mail.smtp.portoptionalMail server port58725
mail.smtp.authoptionalBoolean specification if user data is necessary for the mail server. If set to true, username and password are necessary.truefalse
usernameoptionalUser name for the mail serveruser-
passwordoptionalUser password for the mail serverpassword-
mail.smtp.fromoptionalMail address from which notification messages are sentff-report@yourDomain.comnoreply@fact-finder.de

Analytics

Rename the Analytics application analytics.war and place it in the tomcat/webapps directory. Next, you should see some error messages in catalina.out as the application is not yet cofnigured correctly. During deployment, just like with the search client, a folder should have been created in the FACTFINDER_RESOURCES directory.

In this application specific folder should be a file named application.properties where you can make the following changes:

Configuration Key DescriptionExample ValueStandard Value
ffa.persistence.searchLogDirectoryessential

Path where FACT-Finder Search logfiles are deposited for analysis. Multiple paths can be separated by commas. Read-only access suffices.

/path/to/searchLogs      
  |-- channel_abc            
  	|-- daily
  		|-- ff.20121126.log                
 		 |-- ff.20121126.log.catalog
  |-- channel_def             
  	|-- daily                 
  		|-- ff.20130701.log

/opt/factfinder/fact-finder/logs

When specifying multiple values:

/opt/factfinder/fact-finder1/logs,/opt/factfinder/fact-finder2/logs

-
ffa.persistence.scicLogDirectoryessential

Path where FACT-Finder shopping cart (SCIC) logfiles are deposited for analysis. Multiple paths can be separated by commas. Read-only access suffices

/path/to/scicLogs     
  |-- shoppingcart.2012-12-10.log
  |-- shoppingcart.2012-12-11.log

/opt/factfinder/fact-finder/logs/shoppingcart

When specifying multiple values:

/opt/factfinder/fact-finder1/logs/shoppingcart,/opt/factfinder/fact-finder2/logs/shoppingcart

-
ffa.persistence.jobDirectoryessentialDirectory where FACT-Finder Analytics calculations are cached. You need read and write access./opt/factfinder/analytics/jobs-
ffa.job.maximumIdleTimeoptionalDetermines, when an analysis job counts as timed out, when x milliseconds have passed without interaction. Min value: 1800000 (=30min).172800000

172800000

(=48h)

ffa.job.cleanupEveryoptionalDetermines that Analytics deletes all jobs that have exceeded their maximumIdleTime every x milliseconds. Min value: 60000 (=60s).3600000

3600000

(=1h)

In our example, the file would look like this:

ffa.persistence.searchLogDirectory=/opt/factfinder/fact-finder/logs
ffa.persistence.scicLogDirectory=/opt/factfinder/fact-finder/logs/shoppingcart
ffa.persistence.jobDirectory=/opt/factfinder/analytics/jobs

Once the configurations have been modified, perform a reeploy of the application. You can use, for example, the command touch analytics.war in the tomcat/webapps-directory. The deployment should work without issues and you can access the following URL in your browser:

http://<Adresse Ihres Servers>:8080/analytics/manage/health

If you see a page with the message {"status":"UP"}, FACT-Finder Analytics is ready and we can continue with the last application.

Compressing Logfiles

FACT-Finder Analytics kann ab der Version 7.1 gzip-komprimierte Logdateien verarbeiten. Um Festplattenplatz zu sparen können Sie daher die Logfiles in den Verzeichnissen von ffa.persistence.searchLogDirectory und ffa.persistence.scicLogDirectory zyklisch komprimieren. Bitte beachten Sie jedoch, dass das aktuellste Logfile nicht getroffen ist, da die FACT-Finder Suchanwendungen dort während des Betriebs Informationen reinschreiben.

UI

Rename the UI application fact-finder-ui.war and place it in the tomcat/webapps directory. During deployment, just like with the other applications, a folder should have been created in the FACTFINDER_RESOURCES directory. There you find the configuration file fff-ui.properties, whre you make the following adjustments:

KonfigurationKeyDescription
search application URL

server.url

The URL for the search application's end point.
Authentifizierung
  • authentication.algorithm
  • authentication.mode
  • authentication.prefix
  • authentication.postfix

These values reflect the search application's authentication values. They enable the UI application to login to the search server. The values must be identical with those in the authentication.settings.properties search application configuration file (path: /opt/factfinder/fact-finder/conf/authentication.settings.properties).

In our example, the file looks like this:

server.url=http://localhost:8080/fact-finder/ui/ws/soap/

authentication.algorithm=MD5
authentication.mode=ADVANCED
authentication.prefix=FACT-FINDER
authentication.postfix=FACT-FINDER

Next, you should restart the application and access the following URL. You should see the FACT-Finder login screen and a banner with current news.

http://<Adresse Ihres Servers>:8080/fact-finder-ui/

In that case, use your initial login credentials (user name: admin, password: adminpw). Please change these as soon as possible via the user management page.

In the UI, navigate to  System -> System Information, to check the link between the three applications. If you have done everything correctly, you should see the respectie URLs and version numbers. Should they diverge from your customised settings, click "Reload Configuration" to force a recheck.

If the information is correct, you have correctly integrated the FACT-Finder Framework. It can now be filled with product data.

Page Contents