Live Forms Latest - This documentation is for Live Forms 8.1. v8.1 is a Cloud Only release. Not for you? Earlier documentation is available too.

Versions Compared

Key

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

...

Follow these steps to configure the Filesystem connector:

  1. You may notice the following property listed in the 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. The Change the <localhost:8082> in the default URL can be changed to the <server:port> where you installed the Filesystem connector in your environment.

    2. Uncomment the property by deleting the # that precedes it, if necessary.

      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:

    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_desc.txt

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

    Frevvoproduct
    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.ignore.attachments=false
      connector.file.descriptor.suffix=_desc.txt
      


  3. Start
    Frevvoproduct
    . If you are running
    Frevvoproduct
    v7.0+, remember to start the Insight server first.
  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" }

...