This document outlines integrating your Netcore CE dashboard with Amazon S3 for seamless data export and analysis. This integration allows you to export campaign, journey, and on-site messages related to performance reports directly to your designated Amazon S3 bucket. This guide helps you configure your S3 bucket on the Netcore CE dashboard and use the reports to analyze further your ongoing campaigns, journeys, and on-site messages.

To set up and use the S3 bucket, you need to go through the following three major phases:

1. Prerequisites
2. Setup using IAM Policy Method
3. Setup using Access Key Method
4. Use of the activated connection
   1. Campaign Report export
   2. Journey Report export
   3. On-site messages

Prerequisites

Ensure the following prerequisites are fulfilled to enable this integration.

1. Creation of a S3 bucket (on the AWS platform)
   1. Login to your AWS Console and search for AWS S3 , which takes you to the Bucket page.
   2. Click Create Bucket and provide details for Bucket Name, AWS S3 Bucket Region.
   3. Navigate here, to get your Access Key and Secret Key.
   4. Click Create Bucket and a success message appears.
2. You can follow either of the two methods to configure your S3 bucket:
   1. IAM Policy Method
   2. Access Key Method

IAM Policy Method

Activation of the Integration

1. Log into the Netcore CE dashboard and navigate to Settings.
2. Click Integration > Cloud Storage Platform > Amazon S3. The integration modal opens up.
3. Click Add Integrate and provide Connection Name.
4. Enter the Bucket Name as specified in your AWS S3 setup.
5. Specify the Bucket Path using the following naming convention, "bucket name/folder name/subfolder name."
6. Select the Region from the dropdown menu, such as us-west-2, in-2, in-1, and so on.
7. Select the email addresses from the dropdown menu in the Alert Email field. These email addresses receive notifications if issues arise during the ongoing export process.
8. Select the IAM Policy button; relevant credentials appear below.
   1. Copy the policy code snippet provided.
9. Navigate to AWS Console and select the bucket from the Bucket page.
10. Navigate to Permissions > Bucket policy .
11. Click Edit under the Bucket Policy section and enter the copied policy code snippet.
12. Click Save changes to update the policy.
13. Click the Activate button, and a test file is sent to the S3 bucket configured on the dashboard.

📘

Note

When the file is successfully sent, the integration is activated immediately. If it fails, AWS sends an error response that is displayed on the Netcore CE dashboard, helping the user understand the issue and adjust the credentials.

Access Key Method

To fetch the Access Key, you need to follow the steps on the AWS console before entering them on the Netcore CE dashboard:

Set-up on the AWS Console:

1. Navigate to AWS Console > S3.
2. Select the bucket you wish to configure. Click on your bucket list and click Security Credentials.
3. Navigate to Users > Add User.
4. In the Add User section, enter your User name and select the Programmatic access checkbox. Click Next: Permissions, and the Set Permission appears.
5. Click Create Group > Create policy When you click it, the Create Policy page opens in a new tab.
6. Click the JSON tab and then paste the code snippet provided below:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::sample-bucket"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject"
            ],
            "Resource": [
                "arn:aws:s3:::sample-bucket/*"
            ]
        }
    ]
}

🚧

Warning

Replace all instances of sample-bucket with the actual bucket name you created.

7. Click Next: Tags > Next: Review, and the Create Policy page appears.
8. Include a policy name in this section and click Create policy.
9. Navigate to the Create Group tab and search for the policy you created. Assign this new policy to the new group. A success message appears on your S3 console.
10. Navigate to Create Group and search for the policy name you provided in Step 8.
    1. Assign this policy to the new group.
    2. Click Create Group, and the page to add users appears.
11. Click Next: Tags > Next: Review > Create User.

👍

Success!

The Access Key and Secret Key to your S3 bucket are now visible.

You can download these credentials as a .csv file on your device or note them down and have them ready when configuring the S3 bucket on the Netcore CE Dashboard.

Set-up on the Netcore CE dashboard:

1. Log into the Netcore CE dashboard and navigate to Settings.
2. Click Integration > Cloud Storage Platform > Amazon S3. The integration modal opens up.
3. Click Add Integrate and provide Connection Name.
4. Enter the Bucket Name as specified in your AWS S3 setup.
5. Specify the Bucket Path using the following naming convention: "bucketname/foldername".
6. Select the Region. Choose the appropriate region from the dropdown menu. Examples: us-west-2, in-2, in-1, and so on.
7. Select the email addresses from the dropdown menu in the Alert Email field. These email addresses receive notifications if issues arise during the ongoing export process.
8. Select the Access Key button, and relevant details appear below
   1. Enter the Access Key
   2. Enter the Secret Key
9. Click the Activate button, and a test file will be sent to the S3 bucket configured on the dashboard.

📘

Note

When the file is successfully sent, the integration is activated immediately. If it fails, AWS sends an error response that is displayed on the Netcore CE dashboard, helping the user understand the issue and adjust the credentials.

Use of the Activated Integration

Campaign Report Export

1. Log in to the Netcore CE dashboard and navigate to Campaigns. Then click the Download Reports icon.
2. Select the specifications for the data to be exported.
3. Choose AWS S3 from the dropdown menu.
4. Select the Connection Name from the list or create a new connection.
5. Select the export frequency (Daily, Weekly, Monthly).

Journey Report Export

1. Log into the Netcore CE dashboard and navigate to Engage > Journeys.
2. Click the Download reports icon.
3. Select the specifications for the data to be exported.
4. Choose S3 from the dropdown menu.
5. Select the Connection Name from the list or create a new connection.
6. Select the export frequency (Daily, Weekly, Monthly).

On-site Messages

1. Log into the Netcore CE dashboard and navigate to Engage > On-site Messages.
2. Click the Download reports icon.
3. Select the specifications for the data to be exported.
4. Choose S3 from the dropdown menu.
5. Select the Connection Name from the list or create a new connection.
6. Select the export frequency (Daily, Weekly, Monthly).

Editing of integration

1. Log into the Netcore CE dashboard.
2. Navigate to the Settings > Integration > Connected.
3. Find the active connection.
4. Click on the three dots and select View.
5. You can edit the emails from the Alert Emails list in the View Section.
6. Click Save.

Deactivation of Integration

1. Log into the Netcore CE dashboard.
2. Navigate to the Settings > Integration > Connected.
3. Find the active connection to be deactivated.
4. Click Deactivate.

📘

Note

The user is warned that the ongoing exports will be stopped if the connection is deactivated or deleted, with a list of the ongoing exports.

Reactivation of Integration

1. Log into the Netcore CE dashboard.
2. Navigate to the Settings > Integration > Connected.
3. Find the deactivated connection to be reactivated.
4. Click Reactivate. The status changes to Activated.

Frequently Asked Questions

Q. How to get the Bucket Name?

A. In the AWS Console, open the S3 section. Here, a list of your buckets is present and when you click on your bucket, the name of this bucket is mentioned at the top. Another method to find out the bucket name is to go to the Properties section of your bucket. Look for the S3 ARN here, and in the link arn:aws:s3:::sample-bucket, the instance sample-bucket will be your bucket name.

Q. How to enter the Bucket Path?

A. To enter the Bucket Path, use the following nomenclature: bucket name/folder name/subfolder name and enter the relevant information under each section, if applicable.