Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor

The Filesystem Connector saves frevvo submissions to local or remote file systems (Windows, Linux). You can:

...

  1. If you use the frevvo 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 want to install the Filesystem Connector in the frevvo In-House tomcat bundle, follow these easy steps: (You don't have to use the frevvo 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 the <frevvo-home>\tomcat\frevvo directory.
      4. Configure the Filesystem Connector
  4. Start frevvo by clicking on the startup.(bat,sh) file for your operating system in the <frevvo-home> directory. It is also possible to configure frevvo as a Windows service

In-house Customers with an existing frevvo tomcat bundle installation

...

  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.

      Code Block
      # 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, frevvo 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.

      Warning

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


      Code Block
      # File Connector settings
      frevvo.filesystem.connector.url=http://localhost:8082/filesystem
      connector.file.root.dir=C:/
      connector.file.name.keep=true 
      connector.file.descriptor.suffix=_desc.txt
      connector.file.metadata.subdir=metadataFile/
      


  3. Start the Insight server first, then start frevvo.  
  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

      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.


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

...

  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 subdirectory for each submission under the Submissions directory. The name of the subdirectory is created from the value entered into the Name field on the form
  4. You want to save the form/workflow PDF, any mapped PDFs associated with the form, an xml file and any attachments uploaded to the form in the subdirectory. 

...