Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column

The Filesystem Connector saves 

Frevvoproduct
submissions to local or remote file systems (Windows, Linux). You can:

  • Save each submission to it’s own folder
  • Save all submissions to the same folder
  • Choose to keep file names or generate a file name
  • Generate metadata for import into your Enterprise Content Management system.

Submission form/flow XML document(s), attachments that are added by the user and the PDF snapshot of your form/flow can be saved in the configured submissions directory.

Note
Signatures are not saved as they are a different content type than attachments.

Using the File Filesystem Connector to save submissions to a shared directory might be an alternative if your forms/flows contain sensitive/secure information that you would rather not send via email or if you want to import the submissions into your Enterprise Content Management system.  

Submissions from 

Frevvoproduct
are posted to the Filesystem Connector using the Doc Action Save to File System wizard.

The Filesystem Connector is available for cloud and in-house 

Frevvoproduct
customers. It can be deployed under any Servlet

Info

frevvo only supports/certifies the Filesystem Connector running in the Apache Tomcat container.

Generation of a metadata file for each submission can imported into a document management system. This is possible with the Save to Filesystem  Filesystem wizard and a descriptor file that provides the instructions in freemarker language.  Once the metadata file is generated, it is the customer's responsibility to import it into the document management system. 

Column
width300px

On This Page:

Table of Contents
maxLevel2

...

The Filesystem connector can be installed in any servlet container 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

    Code Block
    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 want to run install the Filesystem connector in the same container where 
    Frevvoproduct
     is running:
  4. Stop 
    Frevvoproduct
    .
  5. Download the file connector zipflile from here
  6. 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. 
  7. The port number change is also applicable to any outgoing HTTP requests to the Filesystem connector. Connector in the frevvo In-House tomcat bundle, follow these easy steps: (You don't have to use the 
    Frevvoproduct
    application from this bundle).

    1. Review the Supported Platforms list.
    2. Download and install the certified version of the Java Development Kit (JDK) or Java Runtime Environment (JRE) 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
      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
      1. to <frevvo-home>\tomcat\webapps directory.
      2. Configure the Filesystem Connector
  8. Start

    Frevvoproduct
    by clicking on the startup.(bat,sh) file for your operating system in the <frevvo-home>

    \tomcat\webapps directory.Configure the Filesystem Connector

    directory. It is also possible to configure Live Forms as a Windows service

In-house Customers

...

with an existing
Frevvoproduct
tomcat bundle installation

The Filesystem connector can be installed in any servlet container 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 

Frevvoproduct
 up and running and you are using the frevvo Tomcat bundle:

To install the Filesystem connector in the same tomcat as

Frevvoproduct
:

...

  1. Stop
    Frevvoproduct
    .
  2. Download the file connector zipflile from hereFilesystem Connector zipflile
  3. Extract the filesystem.war file to your <frevvo-home>\tomcat\webapps directory. 
  4. Configure the Filesystem Connector

...

  1. Start
    Frevvoproduct

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. Stop

    Frevvoproduct

  2. Download

...

  1. the latest version of the Filesystem Connector

...

  1. Extract the filesystem.war file to replace the existing one in <frevvo-home>\tomcat\webapps.

  2. Start
    Frevvoproduct

...

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

Configuring 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:

    Configuration ParameterDescription
    connector.file.root.dirThis is the location in your file system where the submission docs will be saved.  Set the submissions directory field in the Save to Filesystem wizard as a relative path from the root directory specified by the connector.file.root.dir in the connector deployment configuration. It's value can contain one or more control template strings. For example, if the configuration file contains C:\ for the connector.file.root.dir parameter, enter the name of the directory where you want to save the submissions in the Submissions field in the Save to Filesystem wizard. This will save the submissions in C:\<DIRECTORY NAME>. If not explicitly configured, it defaults to the user home directory. Change the value to reflect the location for your file system.
    connector.file.name.keepThis parameter determines whether the original files names will be retained. If this is set to true, then you either have to make sure that all your files have unique names or else save the documents of each submission under a separate uniquely named folder. If this parameter is not included, or is set to false, submission files will be named with a generated identifier as the prefix suffixed by '_' and a sequence number to make the file name unique. The original filename extension is retained. This is the default behavior. Ex: e454fa08-9a6e-4c54-9743-18f4ba0ad0b4_1.xml instead of form.xml.
    connector.file.dir.submission   This parameter allows you to create a unique new sub-folder for documents of every submission if true.
    connector.file.ignore.attachmentsThis parameter determines whether attachments will be saved or not. If the value is false, attachments will be saved. Change the value to true and attachments will not be saved.
    The submission XML does not store the names of uploaded attachments, instead it points to unique ID that is assigned to each attachment when that submission in created in
    Frevvoproduct
    . This is as-designed.
    connector.file.descriptor.suffixThe metadata descriptor filename is a generic GUID filename, followed by a configurable suffix. The default suffix is '.xml'. Use this parameter to change the suffix.The suffix can make identifying the metadata file easier, particularly if you save the files from all submissions into the same folder.
    Ex: 432e0d1f-d084-4cd4-8bbe-50f6e9bd5ee6.xml

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

    Frevvoproduct
    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.

      Code Block
      <Context unpackWAR="false" path="/filesystem" swallowOutput="true" unloadDelay="40000">
      <Parameter name="spring.main.banner-mode" value="OFF" override="false"/>
      <Parameter name="logging.file" value="${catalina.base}/logs/file-connector.%d{yyyy-MM-dd}.log" override="false"/>
      <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>"false"/>
      <Parameter name="connector.file.descriptor.suffix" value=".xml" override="false"/>
      <JarScanner scanClassPath="false"/>
      </Context>
    Info

    The spring.main.banner-mode, logging.file and JarScanner scanClassPath parameters are needed so the Filesystem Connector log file gets created in the <frevvo-home>\tomcat\logs directory

    Warning

    In a properties file, a backslash is considered as a continuation character when splitting across lines. Escape it with another backslash so it is not treated as such. i.e. C:\\ or use the forward slash i.e. c:/ when specifying the connector.file.root.dir property.

  2. Start
    Frevvoproduct
    . If you are running
    Frevvoproduct
    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

      Warning

      To ensure interoperability across file systems, it is recommended that you follow a good naming standard such as POSIX when creating files and folders. For example, folder names can't contain slashes so a folder named '1/2/15' would not be valid.

  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" }.

    Tip

    If you make a change to the filesystem.xml file, restart

    Frevvoproduct
    for the change to take effect.

...

  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 
      Frevvoproduct
      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 ConnectorBe 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 
        Frevvoproduct
        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.

...

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 can be created. This is helpful if your document management system has the capability to import files.

...

The metadata descriptor file template generates a metadata file for every submission using the map that is generated by the wizard and the template. This file will vary depending on the ECM that Document Management system you are using and your specific requirements.

...

Info

If you are not familiar with the freemarker template language or you do not see an example for the Document Management System that you want to use, contact   Sales to arrange a help session with frevvo Client Services.

...

The Filesystem Connector generates it's own logfile. Typically, the log is first place to look for information when an issue is encountered. Information about the logfile and some common issues with solutions are listed belo

...

below.

Filesystem Connector Logfile

...

  1. Stop
    Frevvoproduct
  2. Create/edit a frevvo-config.properties file in <frevvo-home>\tomcat\conf
  3. Add the logging.level.com.frevvo.connectors.file=DEBUG property to the file. NOTE: the syntax of the property is logging(dot)level(dot)com(dot)frevvo(dot)connectors(dot)<connector name>=DEBUG
  4. Save the file
  5. Restart
    Frevvoproduct


...