Templates - AWS S3 Inbound Configuration

Rebekah Garner
Rebekah Garner
  • Updated

Overview

Administrators can configure a bucket in their organization’s AWS S3 account specific for Claravine file import, allowing users to drop a file in the bucket and automatically import the data to Claravine as a dataset. Claravine can be configured to recognize a File Prefix and import the file data that matches the Template Name (i.e. us/submissions/Email will only bring in the file data dropped into the US folder that starts with Email as a submission into the Email template).

 

The organization must make sure the User has the following permission in their Policy:

  • Action:s3:PutObject to designate the bucket manually on the template
  • Action:s3:ListBucket to select the bucket from a dropdown menu on the template.

For more information about how to assign the s3:ListBucket permission, please refer to AWS S3 Actions documentation

Below is a sample of the JSON policy allowing all files sent to a specific folder within the designated S3 bucket:

{

  "Version": "2012-10-17",

  "Statement": [

      {

          "Sid": "VisualEditor0",

          "Effect": "Allow",

          "Action": [

              "s3:PutObject",

              "s3:ListBucket"

          ],

          "Resource": [

             "arn:aws:s3:::this-is-your-bucket/this-is-your-folder/*",

             "arn:aws:s3:::this-is-your-bucket/this-is-your-folder/",

             "arn:aws:s3:::this-is-your-bucket"

          ]

      }

  ]

}



AWS S3 Inbound Configuration


To configure a template for automated, inbound dataset:

  1. Configure the AWS S3  integration with Claravine in the connected Account menu if you have not already.

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

  3. Click Step 3 - Connect.


  4. Click  to add a new Inbound integration.


  5. Click S3 Inbound Integration.
         The S3 Inbound configuration section displays.


    If you see the Permission warning and you followed the policy steps above, switch the radio button to "Manual Bucket Entry".
  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.

  8. Select the Region. This is the region where your bucket is stored.

  9. Select either Manual Bucket Entry or List Buckets based on the S3 user permissions.

  10. If Manual Bucket Entry is selected and you are mapping to a Folder in your S3 bucket, enter the S3 Bucket (required) and File Prefix (optional).
      1. Enter  the S3 bucket name exactly how it appears in AWS.
      2. If applicable, enter the filename path with the trailing slash (e.g. ProductListingv1/), you can append Claravine dynamic values for the Template Name, Submitted By, and Submitted At elements. 

mceclip0.png

  1. If List Bucket Entry is selected, select the S3 Bucket (required) from the drop-down menu and enter the File Prefix (optional).
      1. If applicable, enter the filename path with the trailing slash (e.g. ProductListingv1/), you can append Claravine dynamic values for the Template Name, Submitted By, and Submitted At elements.

mceclip1.png

  1. Click Save to save the template.

 

 

Things to Know

 

Work closely with your Claravine Customer Success Manager to test a small file to confirm configuration is correct.

 

Users must use the downloaded Template File from Claravine and update it with any changes to the template configuration. See the user instructions to Import File Via AWS S3 or SFTP Knowledge Base article.

 

Imported files must be in CSV UTF-8 format.

 

If the Administrator has designated a File Prefix for the file name, ensure the users know the correct file name requirements.

 

All governance and restrictions applied to the template fields will apply to the data being imported.

 

Currently Claravine cannot provide alerts of failed imports because the file is being imported from a third party. Ensure users check the Submissions page in Claravine to confirm their data has been received and processed. Any inaccuracies to the data, file, or format will result in a failed submission.

Comments

0 comments

Article is closed for comments.