The Acoustic Exchange Toolkit provides a way for locally installed applications, also called On Premise applications, to interact with Acoustic Exchange.
Acoustic Exchange creates a structure that supports dynamic relationships between independent software applications that register with Acoustic Exchange. Each Acoustic Exchange participating application can provide different types of marketing data and different ways to identify individual customers. The Acoustic Exchange Toolkit installs behind your corporate firewall to securely connect your local applications and databases to Acoustic Exchange APIs and the ecosystem.
You can use the Acoustic Exchange Toolkit to perform the following actions.
- A. Upload audience data from a local application to Acoustic Exchange. The application appears in Acoustic Exchange as an audience source endpoint (audience producer).
- B. Download event data from Acoustic Exchange to a local application. The application appears in Acoustic Exchange as an event subscriber (event consumer) endpoint.
- C. Download audience data from Acoustic Exchange to a local application. The application appears in Acoustic Exchange as an audience destination (audience consumer).
- Acoustic Exchange user account, including credentials to log in to the Acoustic Exchange UI.
- An endpoint-level Acoustic Exchange authentication key.
- A URL to call external Acoustic Exchange APIs. Contact Acoustic Exchange support for the address that your account requires.
- Administrative access to install and configure files on the server where you install the Acoustic Exchange Toolkit. Contact your local system administrator for the required address and privileges.
- Administrative access to the database where you want to import event data. Contact your database administrator for the required address and privileges.
- Acoustic Exchange Toolkit installation and configuration
- Encrypting the Acoustic Exchange Toolkit configurations
- Connecting the Acoustic Exchange Toolkit through a proxy server
- Downloading and importing event data for event destination endpoints
- Creating and uploading audience data as an audience source endpoint
- Downloading audience data for an audience destination endpoint
When to use the Acoustic Exchange toolkit
Acoustic Exchange users can apply the Acoustic Exchange Toolkit to integrate their business solution with Acoustic Exchange when the solution includes software that an Acoustic Exchange customer installs in their local environment.
Installing the Acoustic Exchange Toolkit is an alternative to opening your corporate firewalls to allow Acoustic Exchange to pull data from a data source application or to push data to a data consumer application. The Acoustic Exchange Toolkit installs behind your corporate firewall to communicate securely with Acoustic Exchange over HTTPS.
Use the Acoustic Exchange toolkit if a locally installed business solution can provide audience data as a file that can be uploaded to Acoustic Exchange. For example, owners of IBM Campaign can run flowcharts that generate output as a CSV file. The toolkit enables the flowchart output to appear in Acoustic Exchange as an available audience. You can schedule the Acoustic Exchange Toolkit to run periodically so that Acoustic Exchange users always have access to updated audience data.
If a locally installed application is a destination for audience data, use the Acoustic Exchange Toolkit to provide data when it is available in Acoustic Exchange. You can configure the toolkit to run as a scheduled job to automatically check for new audience data.
If a locally installed business solution accepts event data as an event subscriber, use the Acoustic Exchange Toolkit to download the event data and add it to a local database. The Acoustic Exchange Toolkit provides a sample mapping file that you can use to specify how the event data is stored in the database. For example, you might use the imported event data for custom reporting, analysis, and retargeting.
General requirements for the Acoustic Exchange Toolkit
Installing and operating the Acoustic Exchange Toolkit requires access to the Acoustic Exchange user interface, Acoustic Exchange authentication keys, and administrative access to various systems that are related to the applications that register with Acoustic Exchange.
Before you begin, confirm that you have established the required access privileges and logins.
To establish access to Acoustic Exchange, use the Acoustic Exchange UI and collaborate with the Acoustic Exchange Provisioning team.
To establish access to resources that are associated with the locally installed data producer or consumer application, contact the local system
Acoustic Exchange access requirements
To access Acoustic Exchange, we can create and provision an Acoustic Exchange account on your behalf. Acoustic Exchange depends on authentication keys to ensure that you can access only the endpoints that are registered for your account.
To request that Acoustic Exchange to create and provision your Acoustic Exchange account, contact the Acoustic Exchange Account Provisioning team by email at firstname.lastname@example.org or request access to Acoustic Exchange at https://www-01.ibm.com/marketing/iwm/iwm/web/signup.do?source=ibm-ubxprovision.
Your fully provisioned account includes the following elements.
Acoustic Exchange authentication key requirements
The Acoustic Exchange Toolkit calls various Acoustic Exchange APIs. Each call must include an endpoint-level authentication key that is specific to your account.
You must provide the authentication key in the configuration properties for your installation of the Acoustic Exchange Toolkit.
You can find your endpoint-level authentication key in the Endpoint details menu on the Endpoints tab in the Acoustic Exchange user UI. You must have a valid login to Acoustic Exchange to access the Endpoints tab.
Local access requirements
Installing and operating the Acoustic Exchange Toolkit requires access to various systems in your local network environment. Establishing this access typically requires network or database administrative privileges.
Before you begin, confirm that you have established the following access privileges and logins.
Resources and support for the Acoustic Exchange Toolkit
Acoustic Exchange provides various resources to support the Acoustic Exchange Toolkit. You can take advantage of installed, online, and educational resources. Acoustic Exchange developerWorks is the home for the binary source files that are required to install the Acoustic Exchange Toolkit.
Source files for the Acoustic Exchange Toolkit
Acoustic Exchange provides the Acoustic Exchange Toolkit as a downloadable file archive that you can access on Acoustic Exchange developerWorks.
To download the Acoustic Exchange Toolkit, go to
Documentation and training for Acoustic Exchange
To learn more about how to use Acoustic Exchange to meet your business requirements, you can review product documentation and training resources that Acoustic Exchange has developed for Acoustic Exchange.
View the general Acoustic Exchange product documentation in the Knowledge Center. In the Knowledge Center, > Acoustic Exchange.
For tutorials that are specific to the Acoustic Exchange Toolkit, see the following links.
View a series of educational videos that serve as an Introduction.
Troubleshooting and support
If you are having a problem with Acoustic Exchange, we provide different ways to help you to resolve the issue, depending on how you are accessing Acoustic Exchange.
All Acoustic Exchange users can access the Forum. You can post your question, review questions and answers that fellow users have posted, or make a suggestion of your own. Acoustic Exchange subject matter experts routinely monitor the forum to contribute their own insights and experience to the discussion.
To access the Forum, go to https://developer.ibm.com/answers/topics/ubx/
Acoustic Exchange users who have registered at least one Acoustic Exchange endpoint in Acoustic Exchange are considered registered users. As a registered user, not only can you access the Forum, but you are also entitled to assistance from Support.
For issue tracking from ticket creation to resolution, visit the Client Success Portal, which provides complete insight into the status of your inquiries. Find the Client Success Portal at https://support.ibmcloud.com.
To learn more about support for cloud-based services like Acoustic Exchange, see the Software as a Service (SaaS) Support Handbook. Find the handbook at http://www.ibm.com/software/support/acceleratedvalue/SaaS_Handbook_V18.pdf.
To become a registered Acoustic Exchange user, register one Acoustic Exchange endpoint in your Acoustic Exchange environment. Go to the Endpoints tab and click Register new endpoint. For more information about registering an endpoint, see Registering endpoints.
Logging for the Acoustic Exchange Toolkit
You can access the log files for the Acoustic Exchange Toolkit in the
Event files that are processed successfully are stored by default in the
Event files that the Acoustic Exchange Toolkit is not able to process are stored in the
dataError directory. If you encounter problems during event data import, review the condition and structure of the files in the
%CU_HOME%/AppData/downloads/dataError folder to determine a course of action.