Installing a basic integration on a Windows machine

Download and install the basic integration on a Windows machine. 

Step 1: Prerequisites

1. To download and install Python, open the Python webpage . 
2. When you install python, ensure you select the option to Add Python 3.12 to PATH.
3. Download and install the latest version of Microsoft Visual Studio 2019. You can download the Community edition, which is free and suitable for most development tasks. Make sure you select the Desktop development with C++ workload during installation. It includes the required build tools.
4. Download Python LDAP libraries from the GitHub Python-ldap website or refer to the below attachments. For Python 3.12 use either python_ldap-3.4.4-cp312-cp312-win32.whl or python_ldap-3.4.4-cp312-cp312-win_amd64.whl. The LDAP version is set in the requirements file but can be configured according to your preference.

Note
There is a known compatibility issue with virtualenv and Anaconda. If Anaconda is preinstalled, alternative steps might be required.

Step 2: Download and install the Oomnitza basic integration

After installing Python 3.12 and its prerequisites, you can download and set up the basic integration.

1. Create a working directory for the basic integration:

C:\>  mkdir oomnitza
C:\>  cd oomnitza
C:\oomnitza>  mkdir basic_integration

2. Inside the "oomnitza" directory, create a virtual environment.

C:\oomnitza> python -m venv venv

3. Activate the virtual environment and install pywin32

C:\oomnitza> venv\Scripts\activate
C:\oomnitza> pip install pywin32
C:\oomnitza> cd basic_integration

4. Download the integration package from Oomnitza GitHub Repository and extract its contents into the basic_integration directory within your "oomnitza" folder.

5. Install the required setuptools:

C:\oomnitza\basic_integration> pip install --upgrade pip setuptools wheel

6. Install the required Python LDAP libraries:

C:\oomnitza\basic_integration> pip install python_ldap‑3.12.0‑cp38‑cp38‑win_amd64.whl

7. Install the required Python dependencies:

C:\oomnitza\basic_integration> pip install -r requirements.txt

Note: If you encounter a fatal error C1083 with a message Cannot open include file: 'lber.h': No such file or directory during python-ldap installation, ensure the python-ldap version in requirements.txt matches the whl file version. For example, you should update the requirements file to install python-ldap==3.12.0 for python_ldap-3.4.4-cp312-cp312-win_amd64.whl

Step 3: Prepare the Configuration File

1. Generate the config.ini file:

C:\oomnitza\basic_integration> python connector.py generate-ini

2. Edit the config.ini and enter the integration credentials. For more information refer to the Connector Configs section in the GitHub documentation.

Step 4: Map vendor fields to Oomnitza fields

Map the vendor fields to Oomnitza fields to get the information that you need. For the field mapping, it is recommended to follow these steps in your Oomnitza instance:

1. Click Configuration > Integrations and click Block view 
2. Choose your vendor integration from the Basic Integrations section.
3. Click Mappings.
4. Map the vendor fields to the Oomnitza fields.  
5. Select a sync key, such as a Serial Number or Email. The field must have unique values.
6. Click FINISH.

Note
If you are creating a user integration, both the Username and Email fields must be mapped, and a default Role set. You can select a suitable option from the Role dropdown on the Oomnitza mapping side.

Did you know? 
You can complete additional actions in the configuration file, such as filtering the values that are mapped   Filtering basic integrations

Step 5: Run the Oomnitza basic integration

Execute the integration by running:

C:\oomnitza\basic_integration> python connector.py upload [connector]

Note
Replace [connector] with an enabled basic integration, e.g. meraki_network_devices, or chef

Step 6: Schedule the basic integration

To schedule the Oomnitza basic integration for regular synchronization, use the Task Scheduler:

1. Open Task Scheduler and create a new task named 'basic integration'. Provide an optional description.
2. Under the Triggers tab, set the task to run daily at your preferred time.
3. In the Actions tab, set:
   • Program/script: C:\Python312\python.exe (adjust the path if your Python installation differs)
   • Arguments: C:\oomnitza\basic_integration\connector.py upload [connector] Replace [connector] with your configured integration.

   Note: Ensure that the Windows account running the task has the necessary permissions for the desired services.

4. Test the task by finding it in the list, right-clicking, and selecting Run. Verify the execution through the info.log in the C:\oomnitza\basic_integration directory or via the Event Viewer.