...

Currently, the Filesystem Connector is configured using context parameters in a file named filesystem.xml. 

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:

1. • Saved on the local drive in a directory called Submissions.
   • Individual file names will be retained.
   • Attachments in the submisison will be saved.
   • Documents of each submission will be saved under a separate folder
   • Add any form fields preceded by the prefix mmk. in the Doc Action Url to the generated metadata file.

   • Add the suffix "_desc.txt" to the metadata file for

eachsubmission

2. • each submission.
     

     Code Block
     <Context unpackWAR="false" path="/

file

3. • filesystem" swallowOutput="true" unloadDelay="40000"> <Parameter name="connector.file.root.dir" value="C:\Submissions" 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.dir.submission" value="true" override="false"/> <Parameter name="connector.file.metadata.prefix" value="mmk." override="false"/> <Parameter name="connector.file.descriptor.suffix" value="_desc.txt" override="false"/> </Context>

     
     

4. Start .

5. 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 diestination 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.

6. Browse http://localhost:8082/filesystem/health (replace localhost:8082 with your frevvo server host:port) to check the status of the connector. If the connector is up and running, you will see { "status" : "UP" }.

7. Modify your form/flow to use the File Connector via the Doc Action wizrd wizard:

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

   2. Click on the what happens to my data? icon.

   3. Click to open the POST data to your web application wizard

   4. Add  http://localhost:8082/filesystem/submission (replace localhost:8082 with your frevvo server host:port) in the URL property.

   5. Select PDF in the Send Snapshot dropdown. 

   6. The Send Data checkbox is checked by default. Uncheck it if you do not want to save the .xml file
   7. Save your form/flow.
      
      
      
8. Test and submit the form/flow.

9. The submission documents will be found in the directory specified by the connector.file.root.dir parameter or in uniquely named folders under that depending on your configuration.

How to Customize the Submission Folder Name

You can append the submission.dir Url parameter to the Doc Action Url to customize the submission folder name. submission folder name. This will work even if you have not configured the connector.file.dir.submission context parameter in your filesystem.xml file. The Url would look like this:

...

Generating Metadata

Importing the submissions into your ECM requires the generation of metadata. To do this you will need to:

1. Provide the submission metadata as name-value query parameters to the DOC Doc Action URL.
2. Create a descriptor file named file-descriptor.ftl in your <frevvo-home>\tomcat\lib directory. The file MUST be named file-descriptor.ftl

Submission Metadata as name-value query parameters to the

...

Doc Action URL.

Metadata to be put in the file-descriptor.ftl file is specified by adding name-value query parameters to the DOC Doc Action URL in your form/flow. The 'value' can be a templatized string referencing a form field. The name should be prefixed so that it can be distinguished from the form field. The default prefix is md. Parameters preceded by the configured prefix are used for metadata generation.
This will be added to the generated metadata file.

The prefix can be changed using the connector.file.metadata.prefix configuration parameter. The prefix It will be removed from the actual metadata.

The following example of the DOC Doc action Url  passes the name parameter with a value from a field in a form called Name to the descriptor file. The default prefix md is used to distinguish the metadata from the form field in the Url:

...

The metadata descriptor file template generate generates a descriptor file every submission using the template and the query parameters appended to the Doc URl. If a query parameter name is referenced in the descriptor, then it is replaced with its value in the metadata file. This file will vary depending on the ECM that you are using.

...

1. Create a file descriptor template file and name it file-descriptor.ftl.

2. The file-descriptor.ftl should be located in the classpath  - if you are using the tomcat bundle, it should be located in the <frevvo-home>\tomcat\lib directory.

3. The content of the file-descriptor-.ftl file uses freemarker template language v2.3.23. syntax. The input to the template is identified by the variable 'params'. This contains a map of parameter name and parameter value(s). The value is a sequence/array since a parameter can be multi-valued. If there is metadata that remains constant it should be added to the file-descriptor.ftl template.
   
   Here is one exampleexample that can be used with Docushare Enterpise Content System:

   Code Block

   <#compress> <#escape x as x?xml> <?xml version="1.0" encoding="UTF-8"?> <Records>tomcat bundle <Record> <Field id="LF__User" length="-1" type="string"> <Value>administrator</Value> </Field> <#list params?keys as key> <#assign values = (params[key]?size > 1)> <#assign doc = key?switch('submission.file.name',true,false)> <Field id="${doc?then('LF__Document',key)}" length="-1" type="${doc?then('document','string')}"> <#if values><Values></#if> <#list params[key] as value><Value>${value}</Value></#list> <#if values></Values></#if> </Field> </#list> </Record> </Records> </#escape> </#compress>

   In the above sample:

   1. LF-User is an example of metadata that is constant for all submissions
   2. Full paths to all the submission files will be included in the metadata file if you put the submission.file.name parameter in the template.
   3. Value refers to a single parameter while Values designates a multi-valued parameter
      
      
4. The descriptor filename in the submission directory is the identifier, followed by a configurable suffix. The suffix plays an important part in isolating the file. The default suffix is '.xml'. The suffix can be changed using the connector.file.descriptor.suffix context parameter. Here is what the file looks like in the submission directory when the file suffix is configured to be _desc.txt:
   

   
   
   

5. The values from the specified query parameters will be included in the generated metadata file. For Example; if you have fields called Name and state in your form/flow that you want to include in your metadata file and have configured the connector.file.descriptor.suffix context parameter to have a value of mmk, your Doc Action Url should look like this:

   Code Block
   http://localhost:8082/filesystem/submission?submission.dir={Name}&mmk.name={Name}&mmk.state={State}

   The metadata file would look like this:
   

...

If the destination for saving submissions that you have specified cannot be reached, your tenant admin will receive an Doc Post Failure notification email reporting an HTTP Status error - 404. Check the connector.file.root.dir parameter in the file.xml file and the Url in the POST data to your web application wizard.

...