How to work with Amazon AWS S3 as a cloud storage location with file integrations
How do you setup an S3 cloud location and an integration that monitors it in BarTender?
The cloud storage settings are stored within the system database. You will need to have a system database set up to do this. Please see How to set up your system database if you do not have one.
Setting up the storage account
After creating the file integration of your choice. Set up the cloud storage location. This can be done right in the Integration under the File Detection header or in the Admin Console under the Cloud Storage header.
In the integration builder
In the Administration Console
Click on the + to add a new storage type. Choose Amazon S3 from the list
The Account Name can be anything you want it to be as long as it doesn't contain any non-alphanumeric characters and isn't named the same as another account. Spaces are permitted. This will form the base URL which cannot be changed.
The ID Key and Secret Key will come from Amazon itself. Insert both here and click OK to save the information.
Setting up the scan directory
When you select the location as the S3 account you set up, BarTender will automatically fill in the first part of the URL. This shouldn't be modified.
Once this is set, you can piece the folder URL together using the S3 bucket name and direct path to the scan folder, using a URL-style location:
How it works
When BarTender reaches out to Amazon's servers, it uses the bucket_name and the regional-identifier to piece together the actual URL used to reach the S3. Broken down, here are all the pieces
- amazon://AmazonS3 - amazon: is the protocol where AmazonS3 is the name of the storage account mentioned earlier in this guide (without spaces). Since my account is named "Amazon S3", my address becomes "AmazonS3". Change "AmazonS3" to the name of your account as needed.
- regional-identifier - this is an identifier used by Amazon to note which regional server is hosting the bucket. For example, a West coast US bucket might be us-west-2. This identifier is required for the Integration to be able to reach the bucket and scan folder. You can find your identifier from Amazon.
- bucket_name - name of the S3 bucket where the scan folder is located
- remaining address - this is the folder structure within the bucket that points to the folder being scanned.
More Information (Optional)
INTERNAL NOTE: As per dev, the regional-identifier in the URL is required. They have no intention of resolving the URL without it, so it must be included in the scan folder directory. Please see this Jira for more information: https://seagull/jira/browse/BUG-2287