Setting Up FileHub

Derick Larson
Platform Admins

FileHub Install

  1. Download FileHub from the following link
  2. Place in your tomcat webapps directory
  3. After the war file deploys, you can access it at: http://server:port/kinetic-filehub
  4. Log in as admin|admin (user|password)

Optionally, you can configure the data directory(XXX-link) to store configuration information outside the webapp. This makes upgrades much easier.

Setup Options

Setup for Filehub is fairly quick. There are three options to think about and two of them can be left as the default. All of these settings are on the Setup tab in the console.

filehub setup tab

The first is something that should be changed immediately: the Configurator User and Password. These values have a default that is documented publicly and they need to be secure within your network.

The Log Level and the Log file size are normally left at their default values, unless you are doing some troubleshooting.

Troubleshooting

Normal troubleshooting for FileHub is focused on reviewing the logs. In the upper right corner of the console, there are links for the the most current log, and all the zipped logs.

The current log opens in a new tab of your browser (based on browser settings), and the most recent information is at the bottom. You can get archived information (the application archives 9 previous files in a rolling process) by selecting the All Logs option. The All logs option also includes a file with environment information. This is often helpful for troubleshooting and is also displayed on the Environment tab.

Configure a Filestore

Filestores are instances of Filehub adapters that are configured to point to a specific datastore. Multiple filestores can be created in Kinetic Filehub to expose different filestores with different access credentials.

These steps create a local filestore.

  1. From the Filestores tab of the admin console click the Add Filestore button.
  2. Select the Local filestore adapter.
  3. Configure the common filestore properties (used by all filestores):
  4. Name is a friendly label used to list filestores in the admin console (example: "My Filestore").
  5. Slug is a unique identifier used by integrating applications to select which filestore to connect to (example: "my-filestore").
  6. Configure the adapter specific properties (other adapters will have different properties):
  7. Directory specifies the fully qualified path to where file should be read and written to (example: "/Users/wally/filestore" or "C:\Users\wally\filestore").
  8. Click the Save button.

Here is an example of a completed Local Filestore: completed local filestore

Access Keys

Some applications require an access key (key and secret) to interact with Filestores. Access keys allow applications (like Request) to trust a filestoreand allow information to be submitted and retrieved easily. This is an optional feature.

keysecret before

After creating the filestore, click on the 'Add Access Key' button to create an Access Key.

keysecret values

The Key and Secret are shared with other applications to authenticate and help share information (See below under Link to Request)

Available Adapters

Filestore Adapters are implemented as Java .jar files that can be deployed with the Kinetic Filehub web application .war file. The following adapters are included with the Kinetic Filehub web application, but additional adapters can be added to interact with other file storage solutions. Additionally, the source code for all of the adapters included with Kinetic Filehub are available from the Kinetic Community github organization: https://github.com/KineticCommunity

BMC® Remedy® Ars Adapter

The Filehub BMC® Remedy® Ars Adapter provides the functionality necessary for Kinetic Filehub to read and write files into Ars entry file fields.

Cloud Adapter

The Filehub Cloud Adapter provides the functionality necessary for Kinetic Filehub to read and write files into common cloud services such as Amazon S3, Microsoft Azure, and Openstack Swift.

Local Adapter

The Filehub Local Adapter provides the functionality necessary for Kinetic Filehub to read and write files into local directories. These directories may correspond to storage attached to the webserver or to shared storage mounted by the webserver.

Microsoft SharePoint Adapter

The Filehub Microsoft SharePoint Adapter provides the functionality necessary for Kinetic Filehub to read and write files into a Microsoft SharePoint Document folder.

Link to Kinetic Platform

Setting up FileHub to talk with the Kinetic Platform is done at the Space level.

filehub-request

Here is where you put the Slug from the filestore, and the Filehub URL.

You also need the key and secret from the filestore to enable the application to have access to save and display files (attachments) within the application.