Installation and configuration

UBX Toolkit installation and configuration

See it here

Read the story behind it…

Installing the UBX Toolkit is very much a hands-on process for system administrators. There is no automated installer. Instead, the admin needs to run a series of scripts and modify configuration files. This document guides them through the process.

The UBX Toolkit installs on a corporate network behind a security firewall to enable secure communication with Universal Behavior Exchange (UBX). The installation process requires downloading and installing the source files and then configuring secure communication between the corporate network and UBX.

The need for secure communication is critical because the uploaded data could contain personally identifiable customer data. So, it was important that the documentation help the administrator get things right.

Audience: System administrators.

Noteworthy: This tool is aimed at technically sophisticated customers. That meant that we could assume that the user in this case knew how to modify and configure system files.

At the time, I was embedded with the UBX development team. To create the Toolkit documentation, I worked side-by-side with the developer who created the UBX Toolkit. In addition to creating the installation and configuration guide, I worked with the developer to add instructions directly to the configuration files that administrators needed to modify.

Tools:

  • IBM DITA/Oxygen for authoring
  • Adobe Acrobat Pro for reviews

What is UBX?
Universal Behavior Exchange (UBX) is a hosted service that enables separate marketing applications to exchange data about customers (audiences) and their behaviors (events). UBX end users (marketers) can exchange audience and event data between marketing applications without the need for costly software integrations or repeated requests to corporate IT departments.

What is the UBX Toolkit?
The ”toolkit” is a collection of scripts that administrators run to call APIs that prepare, upload, and download data that describe customers (audiences) and their behaviors (events), as provided by various marketing software applications.