Templates - SFTP Outbound Configuration

Claravine can automatically generate an SFTP file with the data from every submission. Administrators can design the file, what data to include in the file, and where to send the data per template.

To add SFTP Outbound to a template:

1. Open the correct Template in the Templates Sub-Navigation menu.
   
   
2. Click Step 3 - Connect.
   
   
   
3. Click  to add a new Outbound integration.
   
   
   
4. Click SFTP.
        The SFTP Outbound configuration section displays.
   
   
   
5. Enter the Integration Name. If no value is entered, Claravine will default the Integration Name to the Template name.
   
   
6. Select the connected SFTP Account. 
    An Administrator must first connect the SFTP Account in the Accounts Sub-Navigation menu of Integrations.
   
   
7. Select the Destination Folder.
   
   
8. Define the Filename. Add text or click the blue Insert button to add, Template, Submitted at, or Submitted By to add those dynamic values in the generated Filename. (Submitted at will return YYYY-MM-DD_HH-MM-SS in UTC).
   We suggest not using the Submission name as the file name. Instead, use the template name, submitted by, submitted at, but not the submission name.  If wanted, the file can contain the submission name within it as a column of data. 
   Special characters in the defined file name may have unintended consequences. Example, if the file name contained a forward slash "/", it might create a new directory in the SFTP environment.
   
   
9. Select the File Type. Options are CSV, XLSX, JSON.
   
   
10. Select the Delimiter. Options are comma (,), semicolon (;), tab, and space.
    
    
11. Check the box to Include Summary Header in the file output, or exclude it to being the file with the field headers. The Summary Header includes:
    1. Date
    2. User Name
    3. Targets
    4. Template
       
       
       
12. File configuration options are Custom or Default Summary.
    
    
    1. Default Summary matches the schema in Step 2 Define and Govern schema.
       
       
       If the visible box is unchecked in the schema, it will not be included in the file.
       
       
    2. Custom allows field-specific changes:
       
       
       
       1. Include or exclude the field from the file
       2. Change the Output Label/column header
       3. Manually drag the tile to change the order
       4. Transform menu: Update all Output Labels to:
          • Replace spaces with underscores
          • Replace underscores with spaces
          • Lowercase
          • Uppercase
       5. Meta Field menu: Add a new meta field to match file output requirements:
          • Template Name
          • Submitter Name
          • Submitter Email
          • Created Date
          • Updated Date
          • Empty
            
            
13. Click Save to save the template.