TenUp: Prerequisites

The following are the prerequisites for using TenUp.

Loading flat file data only

All of the following information and preparation are necessary before trying to upload data from a flat file using TenUp.

All users must have:
  • Some way to designate the metadata in the file. You can provide metadata in one or more of the following three ways:
    • A table tree containing the information about the target table, including column names and data types. See Table tree in this guide for an example of a table tree. For more detailed information about each table tree tag, see Table Tree in the XML API Reference Manual.
    • A spec tree containing the metadata of the flat file. For more information about spec trees, see Spec tree.
    • Using command line arguments. For more information about command line switches, see the Table metadata section of the TenUp: Switch Reference.
  • A flat file containing the data you want to load.
  • A valid 1010data Insights Platform user ID and password
  • A 1010data Insights Platform destination folder that the user account has permission to write to
Linux or macOS users must have:
  • An installed and configured unixODBC. See the section Install unixODBC (Linux and macOS only) for more information.
    Note: Linux and macOS users must complete this step, even if you are loading only flat file data.

Loading ODBC data

All of the following information and preparation are necessary before trying to upload data from an ODBC-compliant database using TenUp.

All users must have:
  • Connection string information. At a minimum, you'll need of the following pieces of information to connect to a data source and extract data for loading:
    • An ODBC driver
    • Data source user name
    • Data source password
    • Connection strings are often sent in the following format, but this may vary from one data source to another:
      "DSN=[DATA_SOURCE_NAME];UID=[USER_NAME];PWD=[PASSWORD]"
  • A valid query that will extract data from the data source
  • An ODBC client application for testing your DSN configuration
  • A valid 1010data Insights Platform user ID and password
  • The path to a 1010data Insights Platform destination folder that the user account has permission to write to
Linux or macOS users must have:

Most of the items above are self-explanatory, but 1010data strongly recommends that you confirm your data source configuration with a simple ODBC client application before attempting to use TenUp. On Linux and macOS, you can use isql, a free, open-source client application included with unixODBC.

Install unixODBC (Linux and macOS only)

For Linux and macOS users, TenUp links against libodbc.so.2. This is the library associated with UnixODBC version 2.3.1 and up. If you are using an earlier version of UnixODBC, TenUp will return a runtime error.

To install unixODBC on Linux and macOS, first run the following commands from your command line:

$ curl -O ftp://ftp.unixodbc.org/pub/unixODBC/unixODBC-2.3.7.tar.gz
$ tar -xzf unixODBC-2.3.7.tar.gz
$ cd unixODBC-2.3.7/
$ ./configure
$ make
$ sudo make install

This series of commands will download the source files for UnixODBC 2.3.7, compile the source into an executable, and install it on your system.

On many Linux distributions /usr/local/lib (where UnixODBC will install by default) is not searched when loading shared objects. This can cause the following error to occur:

error while loading shared libraries: libodbc.so.2: cannot open shared object file: No such file or directory.

To avoid this error, export the following environment variable:
export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:/usr/local/lib"

To test your ability to connect to the DSN, you can run the following command:

$ isql -v [DATA_SOURCE_NAME]
where DATA_SOURCE_NAME is the DSN for the database you're connecting to.

isql is a remote console for interacting with databases via ODBC. It is useful to test your connection with isql because it requires that the data source has an ODBC driver correctly installed and functioning. This, in turn, is important, because TenUp is only able to extract data from ODBC data sources that have an ODBC driver correctly installed and functioning.