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
- Part 1: Installing Python 3.7
- Part 2: Installing the Oomnitza Connector
- Part 3: Preparing the Config File (And Field Mapping)
- Part 4: Running the Oomnitza Connector
- Part 5: Scheduling the Connector
Part 1: Installing Python 3.7
This section details how to setup the necessary prerequisites on Windows for the Oomnitza Connector.
- Download and install Python 3.7
- https://www.python.org/downloads/release/python-376/
- NOTE: Make sure Path installation is included
- Launch the Command Prompt as an Administrator
- 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.
- Create a working directory for the Oomnitza Connector
C:\> mkdir oomnitza
C:\> cd oomnitza
C:\oomnitza> mkdir connector
- Download the Oomnitza Connector package
- Download: https://github.com/Oomnitza/oomnitza-connector/archive/master.zip
- Extract the zip contents of inner folder “oomnitza-connector-master” to C:\oomnitza\connector> directory created in previous step.
- Install the remaining connector python dependencies
- C:\oomnitza> cd connector
- 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)
- Generate the config.ini file
- C:\oomnitza\connector> python connector.py generate-ini
- Set the config.ini values or migrate an existing GUI config.ini
- Learn more about setting up the config.ini file here: https://github.com/Oomnitza/oomnitza-connector/blob/master/README.md#connector-configs
- 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
- Run the connector, confirm it is working:
- C:\oomnitza\connector> python connector.py upload [connector]
- 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.
- Select ‘Daily’ -- Recur every: 1 days
- You may modify the time as desired.
- Action: Start a program
- Program/script: enter the following:
C:\Python37\python.exe - Arguments: enter the following:
C:\oomnitza\connector\connector.py upload [connector]
Note: [connector] should be replaced with desired/configured one- Launch Task Scheduler
- Click Action -> Create Task from the menu
- Enter “Oomnitza Connector” for the Name
- Provide an optional description of the enabled connectors.
- Click on ‘Triggers’ tab and then click ‘New…’ button
- Click on ‘Actions’ tab and then click ‘New…’ button
- Test run the Scheduled Task
- Find the “Oomnitza Connector” task in the list
- Right-click on it and select “Run”
- Check the info.log in the C:\oomnitza\connector directory, or verify via Event Viewer or via changes in Oomnitza.
- The connector is now setup and scheduled to run on a recurring basis!
Comments
0 comments
Please sign in to leave a comment.