Windows - Installing the Oomnitza Connector

This document details how to download and install the Oomnitza Connector on a Windows 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. Part 1: Installing Python 2.7
  2. Part 2: Installing the Oomnitza Connector
  3. Part 3: Preparing the Config File (And Field Mapping)
  4. Part 4: Running the Oomnitza Connector
  5. Part 5: Scheduling the Connector

Part 1: Installing Python 2.7

This section details how to setup the necessary prerequisites on Windows for the Oomnitza Connector.

  1. Download and install Python 2.7
    1. https://www.python.org/ftp/python/2.7.14/python-2.7.14.msi
    2. NOTE: Make sure Path installation is included
  2. Launch the Command Prompt as an Administrator
  3. Download and install the last stable pywin32 release from the page https://github.com/mhammond/pywin32/releases. Follow the instructions from the release download page to choose the proper binary

NOTE: There is a known compatibility issue with virtualenv and Anaconda. If Anaconda is pre-installed, alternative steps may be required.

Part 2: Installing the Oomnitza Connector

Now that the necessary prerequisites have been installed, we may proceed to setup a directory for the connector, and install the python packages.

  1. Create a working directory for the Oomnitza Connector
C:\>  mkdir oomnitza
C:\>  cd oomnitza
C:\oomnitza>  mkdir connector
  1. Download the Oomnitza Connector package
    1. Download: https://github.com/Oomnitza/oomnitza-connector/archive/master.zip
    2. Extract the zip contents of inner folder “oomnitza-connector-master” to C:\oomnitza\connector> directory created in previous step.
  2. Install the remaining connector python dependencies
    1. C:\oomnitza>  cd connector
    2. C:\oomnitza>  pip install -r requirements.txt

Part 3: Preparing the Config File (And Field Mapping)

With the Oomnitza Connector setup with all requirements installed, we may proceed to generate and setup the config.ini file.

NOTE: If you already have a config.ini file, you may skip this section and simply place your existing config.ini in the root directory (in this example, C:\oomnitza\connector)

  1. Generate the config.ini file
    1. C:\oomnitza\connector>  python connector.py generate-ini
  1. Set the config.ini values or migrate an existing GUI config.ini
    1. Learn more about setting up the config.ini file here: https://github.com/Oomnitza/oomnitza-connector/blob/master/README.md#connector-configs
    2. Oomnitza and third party system mappings and credentials must be configured. The mappings should be completed via drag-and-drop from the WebUI (System Settings -> Connectors)

Part 4: Running the Oomnitza Connector

  1. Run the connector, confirm it is working:
    1. C:\oomnitza\connector>  python connector.py upload [connector]
    2. NOTE: replace [connector] with an enabled connector, e.g. casper, okta, onelogin, ldap, etc.

Example:

python connector.py upload ldap --ini=/path/to/first.ini
python connector.py upload ldap --ini=/path/to/second.ini

Part 5: Scheduling the Connector

This final section details how to schedule the Oomnitza Connector for regular synchronization on a daily basis.

Setup the scheduled task. On windows, you will utilize the Task Scheduler.

  1. Select ‘Daily’ -- Recur every: 1 days
  2. You may modify the time as desired.
  3. Action: Start a program
  4. Program/script:  enter the following:
    C:\Python27\python.exe 
  5. Arguments: enter the following:
    C:\oomnitza\connector\connector.py upload [connector]
    Note: [connector] should be replaced with desired/configured one
    1. Launch Task Scheduler
    2. Click Action -> Create Task from the menu
    3. Enter “Oomnitza Connector” for the Name
    4. Provide an optional description of the enabled connectors.
    5. Click on ‘Triggers’ tab and then click ‘New…’ button
    6. Click on ‘Actions’ tab and then click ‘New…’ button
  6. Test run the Scheduled Task
    1. Find the “Oomnitza Connector” task in the list
    2. Right-click on it and select “Run”
    3. Check the info.log in the C:\oomnitza\connector directory, or verify via Event Viewer or via changes in Oomnitza.
  7. The connector is now setup and scheduled to run on a recurring basis!
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk