Upload FTP Data
Uploading data involves transmitting data via FTP or SFTP to Ambition's server.
*Ambition strongly recommends the SFTP protocol given its security benefits.
Where do I find our custom credentials?
What information is needed for FTP Transmission?
What information is needed for SFTP Transmission?
What is Sandbox Mode and how do I enable/disable it?
Important to Note
There is a 15MB file size limit.
Either CSV or JSON formatted files can be uploaded, but a single integration cannot receive both formats.
- CVS file must be a flat file with headers
- JSON must either be flat (unnested) before transmission or flattened with the JSON Transformer within an Ambition FTP integration.
The file must contain the CSV headers or JSON keys that are included in the Data Format.
All data in Ambition must be attributable to a user. If your data exists at a team or organizational level, it must be broken down into user level metrics.
Locate FTP/SFTP Credentials
1. Login to your Ambition instance.
2. Open the left navigation and click Administration > Data > Integrations.
3. Click Edit in line with the appropriate FTP integration.
4. Click on Data Format to find your DATA_FORMAT labeled as File Format.
Required field Names for your file can also be found here.
5. Click on Credentials to find the USERNAME and PASSWORD needed for transmission.
FTP Transmission
You will need to email gethelp@ambition.com with your server's external IP address so that we can create a whitelist rule in our firewall. This IP address should not start with 192.168, 172.16 - 172.31, or 10. as these are private, internal addresses.
There may be up to a two week wait time for IP addresses to be whitelisted.
Generate a file formatted to your defined DATA_FORMAT, either CSV or JSON.
Use an FTP client/service or create a script to transmit the file. You will not need to specify a folder.
Ambition only supports Passive FTP which means you must open restrictions on outbound ports. If your connection is timing out this is most likely the issue.
Example
curl \
-T filename_with_data \
-u USERNAME:PASSWORD \
ftp1.ambition.com:21/
Ensure that you are sending the file to Ambition's root directory / and we will route accordingly.
Seeing records successfully received by Ambition, but no records generated? Ensure that metrics have been created within the integration.
SFTP Transmission
Unlike FTP, no whitelist rule is needed for Ambition's firewall in order to transmit data via SFTP
Generate a file formatted to your defined DATA_FORMAT, either CSV or JSON.
Use an SFTP client/service or create a script to transmit the file. You will not need to specify a folder.
Example
SFTP support is typically not standard, you may need to manually add the protocol to cURL.
|| Notice the filename includes an appended timestamp
curl \
-T filename_with_data_2016081312022312 \
-u USERNAME:PASSWORD \
-k sftp.ambition.com:2222/
Ensure that you are sending the file to Ambition's root directory / and we will route accordingly.
Seeing records successfully received by Ambition, but no records generated? Ensure that metrics have been created within the integration.
Sandbox Mode
What is Sandbox Mode and when should I use it?
Sandbox Mode is on by default when an Integration is first enabled in Ambition, and is notated by a "Sandbox Mode" badge in line with the integration on the Integration Management page.
Sandbox Mode allows for delivery of test and/or production files to an endpoint without impacting the instance as a whole. When an integration is in Sandbox Mode, the metrics created within the integration will not display outside of the integration and bad files will not halt processing.
Sending test files to an integration in "sandbox mode" is not a requirement, but is an optional capability meant to support organizations that would like to test file structures and data delivery methods. Sandbox Mode can be disabled or reenabled at any time.
Sandbox Mode is especially helpful when adding additional integrations to Ambition after you've launched to your end users.
What does Purging Data entail?
When in Sandbox Mode, you will have the option to Purge the integration. Purging the integration entails all processed metric values and processed files will be deleted. Purging allows for any test and/or files with errors to be cleared out before Production Data is sent to Ambition.
Unless an integration is explicitly Purged, any data from test files will contribute to metric values once Sandbox Mode is disabled.
Learn more about Purging data here.
How do I disable/enable Sandbox mode?
1. Open the left navigation and click Administration > Data > Integrations.
2. Click Edit in line with the appropriate FTP integration.
Integrations currently in Sandbox Mode will feature a "Sandbox Mode" badge in line with the integration on the Integration Management page.
3. On the Settings page, locate the Sandbox Mode toggle
While in Sandbox mode, you will have the option to Purge All Data.
To Purge Data:
- Click the Purge All Data button.
- Click Confirm when prompted
To Disable Sandbox Mode:
- Toggle the Sandbox Mode option to Disabled.
- Click Save.
To Enable Sandbox Mode:
- Toggle the Sandbox Mode option to Enabled.
- Click Save.
Comments
0 comments
Article is closed for comments.