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

...

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

  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.

...

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.

...