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 choose to run the Filesystem connector in the same container where 

   

    is running:

   1. Stop 

      

      .

   2. Download the file connector zipflile from here. 

   3. Be sure to change the port number in the appropriate file for the container you are using. For example, if you are using the frevvo tomcat bundle, the change should be made in the <frevvo-home>/tomcat/conf/server.xml file. 

   4. The port number change is also applicable to any outgoing HTTP requests to the Filesystem connector. 

   5. Extract the filesystem.war file to the appropriate location for the container you are using. For example, if you are using the frevvo tomcat bundle, the connector should be located in the <frevvo-home>\tomcat\webapps directory.

4. Configure the Filesystem Connector

In-house Customers using the frevvo Tomcat bundle

The Filesystem connector can be installed 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 

To install the Filesystem connector in the same tomcat as

1. Stop

   .

2. Download the file connector zipflile from here. 

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

4. Configure the Filesystem Connector

Configuring the Filesystem connector

The Filesystem Connector is configured using context parameters in a file named filesystem.xml.

Follow these steps to configure the Filesystem connector:

1. Create a file named filesystem.xml. Move it to <frevvo-home>\frevvo\tomcat\conf\Catalina\localhost directory when it is completed. Refer to the table below for the configurable parameters that can be included in the filesystem.xml content:

   Here is an example of the filesystem.xml. When executed,

   submissions will be:

   • Saved on the local drive in a directory called 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.

     <Context unpackWAR="false" path="/filesystem" swallowOutput="true" unloadDelay="40000"> <Parameter name="connector.file.root.dir" value="C:\" override="false"/> <Parameter name="connector.file.name.keep" value="true" override="false"/> <Parameter name="connector.file.ignore.attachments" value="false" override="false"/> <Parameter name="connector.file.descriptor.suffix" value="_desc.txt" override="false"/> </Context>

      

2. Start

   . If you are running

   v7.0, remember to start the Insight server first.

3. 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, 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

4. 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/Flows with the Save to File System wizard

Saving files to a local or remote location is easily done with the Save to File System wizard if generating metadata is not required. Let's begin with a very simple example. Here are the requirements:

1. You have created a small form that has a Name, Address, City, State and Zip Code fields. A mapped W - 4 PDF is included in the form. The Save PDF property is selected and the PDF Name property is configured with the template {Name}.

2. You want to store the submission files for this form in a directory on your local machine named Submissions. 

3. You want to create a sub directory for each submission under the Submissions directory. The name of the sub directory is created from the value entered into the Name field on the form

4. You want to save the form/flow PDF, any mapped PDFs associated with the form, an xml file and any attachments uploaded to the form in the subdirectory. 

5. Follow these steps to fulfill the requirements by using the doc action Save to Filesystem wizard

   1. Login as a 

      designer.

   2. Edit your form/flow in the appropriate designer.

   3. Click on the

      what happens to my data? icon.
      
      
      
      
      

   4. Click Save to FileSystem to display the wizard.
      
      

6. To fulfill the requirements listed above, we only need to fill in the URL, Submission Directory and File sections of the wizard. Here is an explanation of the fields:
    

   1. The URL: this is the URL to the location where you installed the Filesystem Connector. Be sure to include the /filesystem/submission in the URL after you change the server and port.

      1. In-house: The location of the Filesystem connector is set for the installation using the frevvo.filesystem.connector.url parameter in the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file. It defaults to http://localhost:8082/filesystem in the tomcat build. The <localhost:8082> in the default URL can be changed to the <server:port> where you installed the Filesystem connector in your environment. This is a required field. The value entered here overrides the value in the frevvo.xml file.

      2. Cloud customers will see the placeholder http(s)://host:port/filesystem/submission - enter the https url to the location where you installed your 

         Filesystem Connector.
         

          

   2. Submissions Directory - Enter a relative path from the root directory specified by the connector.file.root.dir parameter in the configuration file created above. Control templates are allowed in this field. You can use a control template to store submissions in subdirectories. The template, {Name}, will populate the Template field. Copy the template from the Template field and add it to the Submissions Directory path after the forward or backward slash. Note the forward or backward slash can be used to create subfolders.
      
      Examples

   •  if the value of the connector.file.root.dir parameter in the configuration file is "c:\" then entering Submissions in the Submission Directory field in the wizard saves the files in the local directory c:\Submissions.
      

   1. File Section - One or more types of submission content can be specified by checking the Send Snapshot, Files, Gen Forms and Data checkboxes:

      1. Select the snapshot format to be sent by selecting a choice form the Send Snapshot dropdown. The format choices are PDF, PNG or JPEG.

      2. Check the Files checkbox to send any file attachments uploaded to the form.

      3. Check the Gen Forms checkbox to send the mapped W - 4 PDF.

      4. Check the Data checkbox to send the form XML document for the form.
         

         
         
         

7. Click the Submit button.

8. Click the

   save and exit icon to save your changes.

9. Create some submissions by clicking the

   Test button, filling in the form and clicking submit.

10. The results of 3 submissions are shown in the image.