Mac OS X - Installing the Oomnitza Connector

This document details how to download and install the Oomnitza Connector on a Mac OS X machine. For more details on the Oomnitza Connector, check out the readme on github or review our getting started guide on Integrations and the Connector.

Contents

  1. Prerequisites:
  2. Installation:
  3. Scheduling the Connector:

Prerequisites:

The following components must be installed on the Mac OS X machine prior to performing the connector installation steps. By default, some of these components are available out-of-the-box. 

Make sure you check these first, otherwise you may encounter issues later in the process. If you do have to install any of the following, please restart your terminal window before proceeding to installation. 

python 2.7

  1. Run `python --version` in the terminal to confirm it is installed:
    Python 2.7.12 (x86_64)
  2. If the program is not found: https://www.python.org/downloads/mac-osx/

pip

  1. Run `pip --version` in the terminal to confirm it is installed:
    pip 9.0.1 from //lib/python2.7/site-packages (python 2.7)
  2. If the program is not found, run the following command:
    `sudo easy_install pip`

virtualenv

  1. Run `virtualenv --version` in the terminal to confirm it is installed:
    13.1.2
  2. If the program is not found, run the following command:
    `sudo /usr/bin/easy_install virtualenv`

git 

  1. Run `git --version` in the terminal to confirm it is installed:
    git version 2.13.5 (Apple Git-94)
  2. If the program is not found: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Installation:

With the prerequisites in place, installing the Oomnitza Connector is easy. Just open a terminal window and enter the following commands:

cd ~/
mkdir oomnitza
cd oomnitza/
virtualenv .
source bin/activate
git clone https://github.com/Oomnitza/oomnitza-connector connector
cd connector
pip install -r requirements.txt
python connector.py generate-ini
vim config.ini

You may now update the config.ini to enable the desired integrations. For more details regarding each available integration and the configuration settings, please refer to the connector readme: https://github.com/Oomnitza/oomnitza-connector/blob/master/README.md

python connector.py upload casper

There are additional command line arguments that can be utilized: 

--save-data

This will create a directory saved_data/ that will contain a JSON file for each object processed by the connector. This is useful to inspect what is being sent to Oomnitza.

--testmode

This will run the connector synchronization, without sending any data to Oomnitza. This is useful to test the overall process including authorization with systems, and processing of data. 

Scheduling the Connector:

Now that the connector is installed and the first run has completed successfully, the final step is to configure a scheduled job to ensure the synchronization process occurs every day moving forward. Launchd is a common approach on Mac OS X to accomplish this task. 

http://www.launchd.info/ 

It is important that the command is run with the full path to the virtualenv python application and not the system-level python package.

/{YOUR PATH}/oomnitza/bin/python {YOUR PATH}/oomnitza/connector/connector.py upload {connector}
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk