Adobe Experience Platform S3 Connector
In this article
Overview
Use the Adobe Experience Platform S3 Connector Snap to read files from AWS S3 and write them as JSON or Parquet files into Adobe Experience Platform (AEP). The AWS file that you want to read should have the same structure as the schema specified in the Schema Name field. If you do not have a file configured appropriately, use the File Generator Snap to generate the file and then reference it here.
Prerequisites
- The schema that you want to use with this Snap should exist in Adobe Experience Platform. If you do not have the schema ready, create it using the Adobe Experience Platform user interface before using this Snap.
Limitations and Known Issues
- None.
Snap Input and Output
Input/Output | Type of View | Number of Views | Compatible Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| Each input document contains details that can be used with the Schema Name, Dataset Name, or Connector Object Name fields to read data from AWS S3 and write them into AEP. |
Output | Document |
|
| Each output document lists out the status and other details associated with the AEP write process. |
Snap Settings
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
Label | String | Required. The name for the Snap. Modify this to be more specific, especially if there is more than one of the same Snap in the Pipeline. | Adobe Experience Platform S3 Connector | Write Documents from S3 to AEP |
Schema Name | String | Required. The name of the schema to be used to create the dataset to be written into AEP. This is a suggestible field. Click to view schema suggestions that you can use. | N/A | Snaplogic Demo Experience Event Schema |
Dataset Name | String | Required. The name of the dataset into which you want to write the AWS S3 data. The Snap automatically creates a new dataset if a dataset with the specified name does not exist. This property is expression-enabled. For more information on the expression language, see Understanding Expressions in SnapLogic and Using Expressions. For information on Pipeline Parameters, see Pipeline Properties. | N/A | Adobe Generic Dataset |
Connectors Object Name | String | Required. The URL of the AWS S3 object that you want to read. This property is expression-enabled. For more information on the expression language, see Understanding Expressions in SnapLogic and Using Expressions. For information on Pipeline Parameters, see Pipeline Properties. Protocol required for this Snap: S3://. | s3:// | s3://testing-sl-bucket/xdm/File_Pipeline_3000000.parquet |
String | Required. The schema type that you want to use to create the file that must be written. Click to select from the following options:
The schema type of the source and destination files must be the same. | Parquet | Parquet | |
Batch Monitor Tries | Integer | Required. The number of times you want a batch to be monitored until it is completed. | 360 | 300 |
Snap execution | String | Select one of the three modes in which the Snap executes. Available options are:
| Execute only | Validate and Execute |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Invalid Snap configuration | Property Schema Name is null or missing | Provide a valid schema name. |
Unable to load the private key for the given alias | File not found on <your SnapLogic instance> at <account location> | This error appears when the account doesn't have valid values. Ensure that the keystore path, keystore passphrase, private key alias, and private key passphrase are correct. Also, you must upload the keystore in the Keystore Path that you specify. |
Unable to obtain access token | This message appears when the endpoint account details are incorrect. | Check your Organization ID, Technical Account ID, Client ID, Client Secret Key details and try again. |
Examples
Reading Parquet Documents from S3 and Writing them into AEP
In this example, you retrieve a Parquet document from your AWS S3 account and write it into a target AEP dataset.
For this example, you only need an Adobe Experience Platform S3 Connector Snap. You open the Snap and configure it to retrieve the file that you want from AWS S3 and write it into AEP.
- Configure your Adobe Experience Platform account in the Account tab.
- Click the field adjacent to the Schema Name field and select the schema that you want to use for the file coming in from AWS S3.
- Enter the name of the dataset that you want to create, in the Dataset Name field.
- Enter the URL of the source file in AWS S3, in the Connectors Object Name field.
- Select the Schema Type that you want to use.
- Use the Batch Monitor Tries field to specify the number of times you want the batch to be monitored until it is completed.
- Validate your settings and execute the Pipeline.
If your settings are correct, the Snap executes successfully, and displays details associated with the operation.
Downloads
Snap Pack History
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.