The UBX Toolkit provides a way for locally installed applications, also called On Premises applications, to interact with IBM Universal Behavior Exchange (UBX).
UBX creates a structure that supports dynamic relationships between independent software applications that register with UBX. Each UBX participating application can provide different types of marketing data and different ways to identify individual customers. The UBX Toolkit installs behind your corporate firewall to securely connect your local applications and databases to UBX APIs and the IBM Watson Customer Engagement ecosystem.
You can use the UBX Toolkit to perform the following actions.
- A. Upload audience data from a local application to UBX. The application appears in UBX as an audience source endpoint (audience producer).
- B. Download event data from UBX to a local application. The application appears in UBX as an event subscriber (event consumer) endpoint.
- C. Download audience data from UBX to a local application. The application appears in UBX as an audience destination (audience consumer).
- UBX user account, including credentials to log in to the UBX user interface.
- An endpoint-level UBX authentication key.
- A URL to call external UBX APIs. Contact IBM for the address that your UBX account requires.
- Administrative access to install and configure files on the server where you install the UBX 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.
- UBX Toolkit installation and configuration
- Encrypting the UBX Toolkit configurations
- Connecting the UBX 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 UBX toolkit
UBX users can apply the UBX Toolkit to integrate their business solution with UBX when the solution includes software that a UBX customer installs in their local environment.
Installing the UBX Toolkit is an alternative to opening your corporate firewalls to allow UBX to pull data from a data source application or to push data to a data consumer application. The UBX Toolkit installs behind your corporate firewall to communicate securely with UBX over HTTPS.
Use the UBX toolkit if a locally installed business solution can provide audience data as a file that can be uploaded to UBX. 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 UBX as an available audience. You can schedule the UBX Toolkit to run periodically so that UBX users always have access to updated audience data.
If a locally installed application is a destination for audience data, use the UBX Toolkit to provide data when it is available in UBX. 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 UBX Toolkit to download the event data and add it to a local database. The UBX 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 UBX Toolkit
Installing and operating the UBX Toolkit requires access to the UBX user interface, UBX authentication keys, and administrative access to various systems that are related to the applications that register with UBX.
Before you begin, confirm that you have established the required access privileges and logins.
To establish access to UBX, use the UBX user interface and collaborate with the UBX Account Provisioning team.
To establish access to resources that are associated with the locally installed data producer or consumer application, contact the local system
UBX access requirements
To access UBX, IBM must create and provision a UBX account on your behalf. UBX depends on authentication keys to ensure that you can access only the endpoints that are registered for your account.
To request that IBM to create and provision your UBX account, contact the UBX Account Provisioning team by email at email@example.com or request access to UBX at https://www-01.ibm.com/marketing/iwm/iwm/web/signup.do?source=ibm-ubxprovision.
Your fully provisioned account includes the following elements.
UBX authentication key requirements
The UBX Toolkit calls various UBX 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 UBX Toolkit.
You can find your endpoint-level authentication key in the Endpoint details menu on the Endpoints tab in the UBX user interface. You must have a valid login to UBX to access the Endpoints tab.
Local access requirements
Installing and operating the UBX 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 UBX Toolkit
IBM provides various resources to support the UBX Toolkit. You can take advantage of installed, online, and educational resources. IBM developerWorks is the home for the binary source files that are required to install the UBX Toolkit.
Source files for the UBX Toolkit
IBM provides the UBX Toolkit as a downloadable file archive that you can access on IBM developerWorks.
To download the UBX Toolkit, go to
Documentation and training for UBX
To learn more about how to use UBX to meet your business requirements, you can review product documentation and training resources that IBM has developed for UBX.
View the general UBX product documentation in the IBM Knowledge Center. In the Knowledge Center, > IBM Universal Behavior Exchange.
For tutorials that are specific to the UBX Toolkit, see the following links.
Visit the IBM Learner portal to view a series of educational videos that serve as an Introduction to IBM Universal Behavior Exchange.
Troubleshooting and support for UBX
If you are having a problem with UBX, IBM provides different ways to help you to resolve the issue, depending on how you are accessing UBX.
All UBX users can access the UBX Forum. You can post your question, review questions and answers that fellow UBX users have posted, or make a suggestion of your own. UBX subject matter experts routinely monitor the forum to contribute their own insights and experience to the discussion.
To access the UBX Forum, go to https://developer.ibm.com/answers/topics/ubx/
UBX users who have registered at least one IBM Commerce endpoint in UBX are considered registered users. As a registered UBX user, not only can you access the UBX Forum, but you are also entitled to assistance from IBM Support and access to the IBM Client Success Portal.
For issue tracking from ticket creation to resolution, visit the IBM Client Success Portal, which provides complete insight into the status of your inquiries. Find the IBM Client Success Portal at https://support.ibmcloud.com.
To learn more about IBM support for cloud-based services like UBX, see the IBM 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 UBX user, simply register one IBM Commerce endpoint in your UBX environment. Go to the Endpoints tab and click Register new endpoint. For more information about registering an endpoint, see Registering endpoints.
Logging for the UBX Toolkit
You can access the log files for the UBX Toolkit in the
Event files that are processed successfully are stored by default in the
Event files that the UBX 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.