FJ2 File Jockey installation guide on IBM WebSphere 2017-04-13T16:10:50+00:00
Guide version 12 dated 13 March 2017 - Author marten.vosmer@lialis.com

Installation guide to install File Jockey on IBM WebSphere for IBM Connections.

File Jockey v 2 supports IBM Connections version 5 and higher and IBM WebSphere 8.5 and higher. File Jockey supports all operating systems where IBM WebSphere can be installed on. File Jockey may also be installed on Apache Tomcat server (not documented yet). Installing File Jockey on JBoss / WildFly is not supported and will give problems.

If you have problems or questions please email us on support@lialis.com.

Installation approach

In this guide we will install File Jockey on a single WebSphere Application Server. File Jockey may also be installed on a clustered WAS setup only if the nodes are located of different servers from (virtual) hardware point of view. If you install File Jockey on a WAS cluster you need to carry out some manual xml file tweaking because of a limitation in the File Jockey administration interface.

Creating and configuring a dedicated WebSphere application server for File Jockey

Register a new WebSphere application server.

wasnew1

Choose default template, generate unique ports, choose confirm and save to create the new server.

Navigate to the Web servers (IHS), select the IHS server and choose Generate Plug-in

wasnew2

Then choose Propagate Plug-in. This will tell the IHS server there is a new WebSphere application server it has to serve.

Final step is to reboot the IHS server.

 

Installing File Jockey on single WebSphere application server located on one node.

In this installation guide File Jockey v2 will be installed on a single WebSphere application server.

wassetup5

IBM Connections 5 runs on a different server.

Installation steps

Deploy the File Jockey WAR file.

Go to the ‘Enterprise applications’ section and press the ‘Install’ button:

Deploy the File Jockey WAR file

Select the WAR file:

Select the FileJockey.war file

Press ‘Next’.

You can install the application via the Fast Path method.

Map the filejockey01 server and the IHS server to the File Jockey application.

wassetup6

Default settings at step 3 Map Virtual Hosts

The context root should be /FileJockey (case sensitive)

The context root should be /FileJockey (case sensitive)

Make sure the application is installed successfully and save directly to the master configuration.

File Jockey Security

I assume you have configured LDAP within IBM WebSphere and application security has been enabled in the Global Security.

Next step is to configure the File Jockey Security rights. Press the ‘FileJockey_war’ link, then the link ‘Security role to user/group mappings’

link 'Security role to user/group mappings'

In this example everybody will be authorized to use File Jockey, but feel free to assign groups or users instead.

And the File Jockey admin page will be authorized for two Admins only

FJInstallwas3

Change the class loader as illustrated below (choose the right class loader!)

Change the class loader

Now you should be able to start the File Jockey application on WebSphere as illustrated below (if you did not forget to start the WAS).

FJInstallwas2

Configure File Jockey

You can access the File Jockey administration page using the URL http(s)://servername/FileJockey/admin/main.jsp (case sensitive) and you should see below screen. Tip, use another browser to access this administration page so you avoid credential problems because you may have already opened the WAS admin console with different credentials which will be passed by the browser to the File Jockey administration page.

FJInstallwas4

 

Please press the Open Configuration button.

For a minimal setup you must enter the following settings.

  • License key (you will have received this key form Lialis). This key is based on the servers computer name
  • HTTP Cache folder, here File Jockey will store its cache
  • HTTP Threads
  • HTTP Cache time
  • Log path

For example:

FJInstallwas5

When all is set save the Configuration and reboot the File Jockey was application.

Please press the Open Repository button.

You will find a few example repositories, feel free to remove them. Make sure there is one repository linking to your IBM Connections environment. Advice, keep the name sort because it will be used in the URL accessing File Jockey. When set save the Repositories and reboot the File Jockey was application.

wassetup3

Please press the button Show Log and check the File Jockey log for errors (if the File Jockey log is empty it did not start properly and you should check the SystemOut.log for errors. Below the SystemOut.log how it should look like when there are no error’s.

[9/22/15 18:39:14:942 UTC] 00000080 SystemOut     O Initializing FileJockey version: 2.0.0[9/22/15 18:39:14:942 UTC] 00000080 SystemOut     O Reading configuration[9/22/15 18:39:14:942 UTC] 00000080 SystemOut     O Using configuration file[9/22/15 18:39:14:957 UTC] 00000080 SystemOut     O Loading configuration[9/22/15 18:39:14:988 UTC] 00000080 SystemOut     O Loggers initialized to level: debug[9/22/15 18:39:14:988 UTC] 00000080 SystemOut     O Starting file userlogging.[9/22/15 18:39:15:113 UTC] 00000080 SystemOut     O FileJockey started[9/22/15 18:39:15:113 UTC] 00000080 ServletWrappe I com.ibm.ws.webcontainer.servlet.ServletWrapper init SRVE0242I: [FileJockey_war] [/FileJockey] [FileJockeyServlet]: Initialization successful.[9/22/15 18:39:15:113 UTC] 00000080 webcontainer  I com.ibm.ws.webcontainer.VirtualHostImpl addWebApplication SRVE0250I: Web Module Lialis FileJockey has been bound to default_host[*:9080,*:80,*:9443,*:5060,*:5061,*:443,10.146.163.173:9080,10.146.163.173:80,10.146.163.173:9443,10.146.163.173:5060,10.146.163.173:5061,10.146.163.173:443,*:9081,*:9082].[9/22/15 18:39:15:144 UTC] 00000080 ApplicationMg A   WSVR0221I: Application started: FileJockey_war

The File Jockey configuration files displayed in the File Jockey Administration page are stored in the Users folder, for example C:\Users\Administrator\.FileJockey

WAS Cluster

If you have installed File Jockey on a WAS cluster you will notice that on one of the WAS servers the File Jockey app will complain about an invalid license key. You have to make sure each server is equipped with the right File Jockey license key which is based on the computer name. The best approach is to manual copy below 3 xml files from the WAS server without the license error to the WAS server with the license error. The edit the configuration.xml and add the correct license key you have received from Lialis.

 

File Jockey URL for WebDAV clients

The URL to access the files stored in IBM Connections is http(s)://serverhostname/FileJockey/root/

This URL can be used on mobile devices, Mac and Windows computers, Please note that Windows 7 computers might need some more attention with regards to Windows patches and security settings. Details on how to setup mobile devices, Mac and Windows computers for File Jockey are described on this page.

 

Changing the File Jockey URL

To change the File Jockey path first you need to open the FileJockey.war file with a zip program. And edit the web.xml file that’s located in the WEB-INF folder.

FileJockey.war opened in 7Zip

The web.xml file contains 2 xml sections that need to be updated. There is the servlet-mapping section with url-pattern tag. By default it will be set to /root/*. This part tells the server what URLs are linked to the File Jockey servlet classes. Changing this to /rt/* will change the File Jockey URL to: http(s)://serverhostname/FileJockey/rt/

Editing the web.xml file

There’s also the security-constraint section with the same url-pattern tag. The value in this tag must be set to the same value as the url-pattern tag in the servlet-mapping section. This section determines the role users need to have before they can make use of File Jockey. If it is not set correctly everybody will have access to File Jockey.

When you’re done, don’t forget to update the web.xml file in the FileJockey.war file.

Next we’ll change the /FileJockey/ part of the URL, which is quite simple. During installation of the FileJockey.war file you’re asked to map the context root for the web modules. As described above, this should normally be set to /FileJockey. But you’re free to set it to anything you like. For example setting this to /fj will result in a File Jockey URL like this: http(s)://serverhostname/fj/rt/

Mapping context root during installation

Self signed certificates

When your Connections server uses self signed  certificates FileJockey will be unable to reach the Connections API the following post will explain how to fix the problem.  Adding self-signed ssl certificate to the java truststore

 

If you have questions, don’t hesitate to contact me!

marten.vosmer@lialis.com