- Set Up the Data Source
- Data Retrieval and Format
- Amazon S3 Connection
- Amazon S3 Server-Side Encryption (SSE)
The Amazon S3 Data Source retrieves data from a file in Amazon S3. This data can then be used to populate a list of options in dropdown or radiobutton questions.
Data sources are usually set up to fetch data on a specified schedule. This allows teams to maintain and update their data through the external service of their choice, minimizing the need to access the web portal.
|Amazon S3 (Simple Storage Service) is an online storage service that allows users to store and retrieve data from anywhere, at any time. "Lifecycle" rules can be set up, making it easy to transfer data to Amazon Glacier for cheaper long-term storage.|
- Create the data source as described here.
- Select Amazon S3 Data Source as the type.
- Select a Name and optionally a Description.
- Set up the data source using the information below.
If this option is selected, users will get a notification from the ProntoForms app after a fetch. It will prompt users to reconcile (send/receive or refresh). This setting is recommended if it is important that users have the most up-to-date data.
- With "push updates" and an automatic fetch set up, some data sources send a notification for each fetch, whether or not the data source has new data.
- If the fetch schedule is hourly, users may get notifications hourly even if the data has not changed.
- Some users may find these notifications annoying or confusing. Consider the fetch frequency carefully if notifications are enabled.
Automatically fetch new data on a schedule:
- If checked, data will be retrieved from Amazon at the Fetch Frequency interval.
- Make sure that the team has a Problem Contact Email Address. If a fetch is unsuccessful for any reason, this address will receive an email with an error message and details. Without this email, it may not be immediately clear that a fetch has failed.
- If unchecked, the data source will not be updated automatically. To retrieve new data from Amazon, the data source will need to be manually updated through the "Fetch New Data" button in the web portal.
Choose Hourly, Daily, Weekly or Monthly. This is how often the data source will fetch new data from S3.
This applies to all fetch frequency options except “Hourly.” Data will be fetched at midnight in the chosen time zone.
- Choose a Data Format (CSV, XML, JSON, or Excel).
- UTF-8 Encoded: If the file to upload is saved with UTF-8 encoding, check this option. If you are not sure if it is, leave this unchecked.
- Trim Whitespace: This option will remove any space, tab, or other "whitespace" characters that may be present at the beginning or end of a data value. This is recommended.
- CSV Delimiter: This option is relevant only when uploading a CSV file. When saving to delimited format from a spreadsheet application, comma is generally used as the separating character, but semi-colon may be used by some applications in some regions.
Configure an AWS Connection or use an existing connection.
If the file is not in a subfolder within the specified bucket, enter "/your_filename_here.csv". If it is within a subfolder, be sure to add it to the file path: "/subfolderName/your_filename_here.csv".
With Amazon S3, objects are organized into "Buckets." The name entered here must be an existing Bucket, otherwise no data will be retrieved.
- If left unchecked, the data source will wait until the specified time and interval to retrieve data for the first time.
- If checked, the first data retrieval will occur immediately after creating the data source.
Amazon Web Services can handle encryption and decryption of your S3 objects for you with Server-Side Encryption (SSE); strong multi-factor encryption using 256-bit Advanced Encryption Standard (AES-256) encrypts your data and there is no need to manage your own encryption keys.
Read more about SSE here:
Decryption happens automatically when data is retrieved from S3. You can specify SSE when uploading your data to Amazon S3.
If uploading to an S3 bucket via REST API:
Just add the
x-amz-server-side-encryption header to the request. Set the value to the encryption algorithm
If manually uploading files to an S3 bucket through the AWS Management Console:
- Once you have selected files to upload, select "Set Details" at the bottom right of the dialog box.
- Check "Use Server-Side Encryption", then proceed to upload as usual.