Templates - AWS S3 Outbound Configuration

Rebekah Garner
Rebekah Garner
  • Updated

Claravine can automatically generate a AWS S3 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 AWS S3 Outbound to a template:

  1. If you have not already, configure the integration with Claravine and AWS S3 as a Connect Account.

  2. Open the correct Template in the Templates Sub-Navigation menu.

  3. Click Step 3 - Connect.

  4. Click  to add a new Outbound integration.

  5. Click S3.
         The S3 Outbound configuration section displays.

  6. Enter the Integration Name. If no value is entered, Claravine will default the Integration Name to the Template name.

  7. Select the connected AWS Account.
     An Administrator must first connect the AWS S3 Account in the Accounts Sub-Navigation menu of Integrations.

  8. Select the Region.

  9. Enter or select the Bucket using Manual Bucket Entry or List Buckets.

  10. Check the box to use Server Side Encryption if required. SSE-S3 is the only encryption option. Amazon will encrypt the file before saving it in your select Bucket. The file will then be decrypted when it is downloaded.  SSE-KMS is not available at this time.

  11. Define the Filename. It will default to {{template_name}}{{submitted_at). You can add text, remove text or click +Insert on the right to add additional dynamic values Submitted By and Submission Name, to the generated Filename. (Submitted at will return YYYY-MM-DD_HH-MM-SS in UTC).
     To push the file into a specific folder within the Bucket, enter the file path (e.g. inbox/us/claravine/{submitted_at}) 

     The file in AWS will appear with the file path with underscore delimiters (e.g. inbox_us_claravine_2020-09-09_12:37:52).

  12. Select the File Type. Options are CSV, XLSX, JSON.

  13. Select the Delimiter. Options are comma (,), semicolon (;), tab, and space.

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

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

  1. Click Save to save the template.





Article is closed for comments.