Acoustic Exchange provides an integration with SFTP as an event consumer to share data with any application in the Acoustic Exchange ecosystem.
SFTP offers scalability, data availability, security, and performance. This means SFTP customers can store and protect any amount of data for a range of use cases, such as websites, mobile applications, backup and restore, archive, enterprise applications, IoT devices, and big data analytics.
When it is combined with Exchange and the Exchange ecosystem, any number of business use cases can be addressed. For example, you could store customer relationship management data in SFTP and share that data through Exchange to an analytics platform to gain insight into those interactions.
The integration between Exchange and SFTP multi-step process that is composed of:
- Configuring your SFTP Endpoint for the integration.
- Consuming event data into the SFTP location.
- Registering the "SFTP - Event Consumer" endpoint in Exchange.
- Subscribing to an event.
- An active SFTP Domain/Server
Register your endpoint
To upload exchange data to your SFTP server through Acoustic Exchange, you must register your SFTP server as an endpoint with Acoustic Exchange for use in your Acoustic Exchange account. You must have a valid license and access credentials for products and solutions that you register.
Register the endpoint with the endpoint registration wizard on the Endpoints tab or through the navigation menu.
The SFTP server can deploy business solutions on one or more servers or data centers. You must specify a deployment when you register your SFTP server as an Acoustic Exchange endpoint for your account.
Use the registration wizard to provide required address and credential information about your organization and Acoustic Exchange account.
Acoustic Exchange accepts the address and credential information as permission from you that the endpoint provider can interact with Exchange on your behalf. During the registration process, you must provide the user credentials that the endpoint provider requires.
- On the Endpoints tab in Acoustic Exchange, select Register new endpoint.
- Select "SFTP - Event Consumer" as the endpoint that you want to register and click Next.
- Provide the information that the endpoint provider requires as part of the registration request. To register the endpoint, you will need to provide your:
- SFTP Domain Name
- SFTP Port
- SFTP User ID
- SFTP Password
- Optional: Specify the upload folder.
By default, the endpoint assumes all files should be uploaded at the root level of the SFTP server. If you wanted to upload data files in a different directory, you can redirect the endpoint to it by defining the SFTP folder path ex. /root or /root/upload
- Optional: If your business needs require it, enter an Endpoint alias for your endpoint. An endpoint alias is a designation that differentiates one endpoint from another. Defining an endpoint alias is useful in cases where you have multiple endpoints with the same configuration but have different purposes. If you do not define an endpoint alias, one is generated for you.
- Optional: Enter a description for the endpoint. By entering a description for the endpoint, you can provide better insight to the purpose or goal of the endpoint. Again, this is useful when you have multiple endpoints of similar configuration, but different purpose. If you do not define an endpoint description, then Acoustic Exchange uses the default endpoint description.
- Click Register.
If you entered registration information into the registration wizard, Acoustic Exchange transmits the information to the endpoint provider so that the provider can complete the registration. The endpoint displays on the Endpoints tab as Pending. When Acoustic Exchange and the endpoint provider complete the registration, the endpoint status changes to Active.
Note: If the registration did not complete successfully, the endpoint status is Failed. Contact Acoustic Exchange Support for assistance.
When will Acoustic Exchange push event data from to SFTP server?
Acoustic Exchange Push data to your SFTP server when there is any new event data that has not been shared. If there is new event data, Exchange pushes it to SFTP in real time.
The event files are then moved to upload Folder in your SFTP server in eventbatch .json format.