Overview
Amazon S3 delivery allows Report Builder reports to be delivered directly to an Amazon S3 bucket.
This is achieved by:
- Creating an Amazon S3 credential in Credential Manager.
- Selecting that Amazon S3 credential as the report delivery destination in Report Builder.
Once configured, Convertr will generate the report and automatically deliver it to the specified Amazon S3 bucket.
Prerequisites
Before configuring Amazon S3 delivery:
- Amazon S3 delivery must be enabled for your enterprise.
- Your enterprise must be configured for Amazon S3 delivery by Convertr.
If your enterprise has not yet been configured, please contact the Convertr Support team.
As part of the initial setup, Convertr will:
- Enable Amazon S3 delivery for your enterprise.
- Generate the Role ARN required for report delivery.
Once this has been completed, you will be able to configure Amazon S3 credentials within Credential Manager and use them in Report Builder.
You will also need the following information from AWS:
- Bucket Name
- AWS Region
This document explains how to configure Amazon S3 credentials within the platform and use them to deliver reports generated by Report Builder to your Amazon S3 bucket.
Step 1: Creating an Amazon S3 Credential
Navigate to:
Enterprise → Credential Manager
Select Add and choose: Type = S3
The following Amazon S3-specific fields will be displayed.
| Field | Description |
|---|---|
| Name | Friendly name used when selecting the credential in Report Builder |
| Bucket Name | Amazon S3 bucket where reports will be delivered |
| Region | AWS Region where the bucket is located |
| Role ARN | Generated automatically by Convertr during enterprise setup |
Naming Recommendations
The Name field is used when selecting the Amazon S3 destination in Report Builder.
We recommend using meaningful names such as:
- S3 Reporting - Revenue Reports
- S3 Reporting - Daily Reports
- S3 Reporting - Marketing Reports
This makes it easier for report creators to select the correct destination.
Finding the Required Values in AWS
Bucket Name
Sign in to the AWS Management Console and navigate to Amazon S3.
Select the bucket that should receive the reports and copy the bucket name.
Within the bucket’s permissions, ensure that it is configured to allow Convertr to write to it.
If the bucket is encrypted with the customer's own encryption key, ensure that the key is also set to allow the same Role ARN, else deliveries will fail. There’s no additional configuration required for buckets using standard S3 encryption.
AWS Region
Within the AWS Management Console, navigate to your S3 bucket.
The Region where the bucket is hosted can be found in the bucket details.
Supported Regions
The following regions are currently available.
| Region Code | AWS Region |
|---|---|
| af-south-1 | Africa (Cape Town) |
| ap-east-1 | Asia Pacific (Hong Kong) |
| ap-east-2 | Asia Pacific (Taipei) |
| ap-northeast-1 | Asia Pacific (Tokyo) |
| ap-northeast-2 | Asia Pacific (Seoul) |
| ap-northeast-3 | Asia Pacific (Osaka) |
| ap-south-1 | Asia Pacific (Mumbai) |
| ap-south-2 | Asia Pacific (Hyderabad) |
| ap-southeast-1 | Asia Pacific (Singapore) |
| ap-southeast-2 | Asia Pacific (Sydney) |
| ap-southeast-3 | Asia Pacific (Jakarta) |
| ap-southeast-4 | Asia Pacific (Melbourne) |
| ap-southeast-5 | Asia Pacific (Malaysia) |
| ap-southeast-6 | Asia Pacific (New Zealand) |
| ap-southeast-7 | Asia Pacific (Thailand) |
| ca-central-1 | Canada (Central) |
| ca-west-1 | Canada West (Calgary) |
| eu-central-1 | Europe (Frankfurt) |
| eu-central-2 | Europe (Zurich) |
| eu-north-1 | Europe (Stockholm) |
| eu-south-1 | Europe (Milan) |
| eu-south-2 | Europe (Spain) |
| eu-west-1 | Europe (Ireland) |
| eu-west-2 | Europe (London) |
| eu-west-3 | Europe (Paris) |
| il-central-1 | Israel (Tel Aviv) |
| me-central-1 | Middle East (UAE) |
| me-south-1 | Middle East (Bahrain) |
| mx-central-1 | Mexico (Central) |
| sa-east-1 | South America (São Paulo) |
| us-east-1 | US East (N. Virginia) |
| us-east-2 | US East (Ohio) |
| us-west-1 | US West (N. California) |
| us-west-2 | US West (Oregon) |
Step 2: Configure Amazon S3 Delivery in Report Builder
Create or edit a report in Report Builder and navigate to the Delivery step.
A new delivery option is available: S3
Select the S3 radio button and the following fields will appear.
| Field | Description |
|---|---|
| S3 Bucket | Select an Amazon S3 credential configured in Credential Manager |
| Path | Optional folder path within the bucket |
Selecting an Amazon S3 Destination
The S3 dropdown displays all credentials configured with Type as 'S3' within Credential Manager.
Select the credential corresponding to the bucket where the report should be delivered.
Optional Path
The Path field can be used to organise reports into folders within the bucket.
Examples:
- lead-data/
- campaign-data/
- monthly-reports/
If no path is specified, reports will be delivered to the root of the configured bucket.
Viewing Delivered Reports in Amazon S3
Sign in to the AWS Management Console and navigate to: Amazon S3 → Your Bucket
If a folder path was configured, navigate to that folder.
Generated report files will be available within the bucket.
Troubleshooting
S3 Option Does Not Appear in Report Builder
The S3 delivery option is only available when Amazon S3 delivery has been enabled for your enterprise.
If Amazon S3 delivery has not been enabled, the Amazon S3 radio button will not be visible.
Enterprise Has Not Been Configured
If your enterprise has not yet been configured for Amazon S3 delivery, you will see the setup banner when creating an Amazon S3 credential.
Please contact the Convertr Support team to complete the initial setup.
The Role ARN is not available
If the Role ARN field is empty and you see the following message:
This usually indicates that the enterprise AWS S3 provisioning has not completed successfully.
Please contact the Convertr Support team, who will verify the enterprise configuration and complete any required setup.
Once provisioning has been completed, the Role ARN field will automatically be populated and you can continue configuring the Amazon S3 credential.
No Amazon S3 Credentials Available
If no Amazon S3 credentials have been configured, the Amazon S3 credential dropdown will be empty.
Create an Amazon S3 credential within Credential Manager before configuring report delivery.
Amazon S3 Delivery Is Disabled After Reports Have Been Configured
If S3 delivery is later disabled for the enterprise:
- S3 will no longer appear as a delivery option in Report Builder.
- Existing S3 delivery configurations will automatically revert to Download delivery.
- Future report executions will no longer attempt S3 delivery.
S3 Credential Is Deleted
Reports that reference the deleted credential will no longer be able to deliver files to Amazon S3 and an error will be logged in the 'Last Error' column informing that the credentials are not configured.
A valid S3 credential must be selected before report delivery can resume.
Reports Are Not Appearing in Amazon S3
Verify:
- Bucket Name
- AWS Region
- That the S3 credential has been configured correctly.
- That your enterprise has completed the required Amazon S3 setup.
- That the Amazon S3 bucket permissions have been configured correctly.
Incorrect configuration or insufficient permissions may prevent successful delivery.