Installing the Filesystem Connector

Cloud Customers

The Filesystem connector can be installed behind your firewall where it can connect to your back end system in order to read/write data.

1. If you use the Live Forms Cloud hosted server,  you must ensure that the connector is accessible from the frevvo servers. This is done by opening up one of the following ports in your firewall:
   
   

   • HTTP Ports: 80 or 19080

   • HTTPs Ports: 443 or 19443
     
     

   We recommend that you use https and not http. Https is a secure channel.

2. Customers that use firewall white-listing, should make sure the frevvo cloud outgoing server IP 54.86.85.105 (host outgoing.frevvo.com) is added to the list.

3. If you want to install the Filesystem Connector in the frevvo In-House tomcat bundle, follow these easy steps: (You don't have to use the 

   
   application from this bundle).

   1. Review the Supported Platforms list.

   2. Download and install the certified version of the Java Development Kit (JDK) and set the JAVA_HOME environment variable as described here. 

   3. Download the frevvo tomcat bundle

   4. Unzip the frevvo zip file into a location of your choice: e.g. c:\frevvo.   We'll refer to this directory below as <frevvo-home>.

   5. Install the Filesystem connector inside that same tomcat. 

      1. Download the filesystem zipflile 

      2. Extract the filesystem.war to <frevvo-home>\tomcat\webapps directory.

      3. Delete <frevvo-home>\tomcat\webapps\frevvo.war

      4. Configure the Filesystem Connector

4. Start

   
   by clicking on the startup.(bat,sh) file for your operating system in the <frevvo-home> directory. It is also possible to configure Live Forms as a Windows service

In-house Customers with an existing

tomcat bundle installation

The Filesystem connector can be installed in behind your firewall where it can connect to your back end system in order to read/write data. These instructions assume you have an in-house installation of 

 up and running and you are running

and the Filesystem Connector in the same tomcat.

To install the Filesystem connector in the same tomcat as

:

1. Stop

   .

2. Download the filesystem connector zipfile

3. Extract filesystem.war to your <frevvo-home>\tomcat\webapps directory.

4. Configure the Filesystem Connector

5. Start

Upgrading from a previous version

To upgrade a previous version of the Filesystem Connector to the latest version in your existing Tomcat bundle installation:

1. Ensure you have downloaded the supported version of OpenJDK. Check Supported Platforms before beginning.

2. Stop

3. Download the latest version of the Filesystem Connector

4. Extract the filesystem.war to your <frevvo-home>\tomcat\webapps directory.

5. Verify that the Filesystem Connector configuration is correct for the new version. 

6. Proceed to Connect Forms/Workflows with the Save to FileSystem wizard to continue.

Configuring the Filesystem Connector

The Filesystem Connector is configured using properties in the <frevvo-home>\tomcat\conf\frevvo-config.properties file.

Follow these steps to configure the Filesystem connector:

1. Modify the File Connector settings section of the frevvo-config.properties file.

   1. the frevvo.filesystem.connector.url - The location of the Filesystem connector is set for the installation with this property. It defaults to http://localhost:8082/filesystem. Change the <localhost:8082> in the default URL to the <server:port> where you installed the Filesystem connector in your environment.

   2. Uncomment the property by deleting the # that precedes it.

      # File Connector settings frevvo.filesystem.connector.url=http://localhost:8082/filesystem

2. Add these properties to the <frevvo-home>\tomcat\conf\frevvo-config.properties file. You can add them to the existing File Connector settings section or make a new section with a comment as shown in the example below. Refer to the table for a description of the configurable properties:

   Here is an example of the Filesystem Connector properties added to the File Connector settings section of the frevvo-config.properties file. When executed,

   submissions will be:

   • Saved on the local drive in a directory specified in the wizard that is located under the root directory configured here. Ex: C:\Submissions.

   • Individual file names will be retained.

   • Attachments in the submission will be saved.

   • Add the suffix "_desc.txt" to the metadata file for each submission.

     # File Connector settings frevvo.filesystem.connector.url=http://localhost:8082/filesystem connector.file.root.dir=C:/ connector.file.name.keep=true connector.file.ignore.attachments=false connector.file.descriptor.suffix=_desc.txt

      

3. Start the Insight server first, then start

   .  

4. Make sure the directory where you plan to save the submissions is created and and has the appropriate access for the OS you are using. For example:

   1. If you are using Windows, you can map a drive to a server directory (not recommended because Windows mapped drives cannot be reliably accessed from java), or you could use the UNC path i.e. //host-name

   2. If you are using a Unix operating system you could mount a remote filesystem as a directory and use it as your destination directory

5. Browse http://<your server:port>/filesystem/health (replace <your server:port> with your frevvo server:port) to check the status of the connector. If the connector is up and running, you will see { "status" : "UP" }

Connect Forms/Workflows with the Save to File System wizard

 

 

Generating Metadata

The Filesystem Connector saves the submission form xml, attachments and PDFs in the configured location. In addition, a metadata file, which describes the data, is created. This is helpful if your document management system has the capability to import files.

Generating metadata in xml format is the most common use case.