Creating a basic integration

Complete the following steps to create a basic integration

1. Before you start
2. General setup instructions
   1. Download the source code for the Oomnitza connector
   2. Install the requirements
   3. Generate the configuration file
   4. Edit the configuration file
3. Map vendor fields to Oomnitza fields
4. Run the connector
5. Getting your results

Before you start

To stream data into Oomnitza, complete these tasks:

1. Review the system requirements. 
2. Download and install Python. Best practice is to create a virtual environment. A virtual environment is created on top of the existing Python installation and can be isolated from the packages in the base environment, so only those explicitly installed in the virtual environment are available.

Installing the connector

GitHub: Getting started

Optional: Create a docker container

Run the Oomnitza integration in a Docker container to create a consistent and reproducible environment for running Python applications. Docker containers provide isolation, portability, and scalability, making it easier to deploy the integration in different environments and handle changes in demand. In addition, running the integration in a container is a more secure way to run code, ensuring that it is not affected by the host system. See Containerized Environment Setup.

Restrictions

• Self-signed certificates are not supported. Attempting to use a URL with a self-signed certificate will result in an [SSL: CERTIFICATE_VERIFY_FAILED] error. To ensure the security of data exchanges between Oomnitza and external servers, integrations can only establish connections with servers that have trusted certificates issued by recognized Certificate Authorities (CAs). Best practice is to either switch to a CA-issued certificate or add the server's self-signed certificate to the trust store.
• SaaS users aren't synced. For more advanced features, such as extracting key user information from your SaaS platforms, creating filters, triggering integration runs, setting schedules, and troubleshooting directly from the Oomnitza UI switch to extended integrations. See Extended integrations overview.

General setup instructions

Download the source code for the Oomnitza connector

1. In Oomnitza, click Configuration > Integrations and click Block view
2. In the Basic section for Asset or User Integrations, click the vendor tile
3. Download the source code and place it in a directory, such as C:\oomnitza_connector 

You can also download the source code on the Oomnitza Connector page on GitHub.

Install the requirements

In the directory you created, install the required Python dependencies stored in the requirements.txt file using pip install -r requirements.txt

Tip
Run pip install --upgrade pip before installing and use the new version of pip

Generate the configuration file

In the same directory, runpython connector.py generate-ini to generate theconfig.inifile. For further information read the Connector Configs section in the Getting started document.

Tip
Run python connector.py --help to see all available command line options.

Edit the configuration file

You must modify the following sections in the configuration file:

• The Oomnitza section
• The vendor section

Before you edit the configuration file, you must retrieve the following information:   

• Your Oomnitza token which can be created in Configuration > Security > API tokens.
• Your vendor credentials. 

1. Open the generated configuration file in an editor.
2. Modify the Oomnitza section by entering the URL of your Oomnitza instance and the API token you generated in Oomnitza.
   

   Oomnitza configuration settings 
   [oomnitza]
url= https://<name_of_instance>.oomnitza.com 
api token = <my_Oomnitza_token> 

3. Modify the vendor section with the required information and credentials specific to your integration.
   

   [dell_asset_order_status]
   enable = True
   client_id = *****
   client_secret = *****
   is_dp_id = False
   is_po_numbers = True
   is_order_no_country_code = False
   values = ["PO123", "PO432"]
   country_code = ["GB", "FR", "IN"]

4. You can delete all the other configurations you do not need from the list, i.e. Kace, Jasper, etc.
5. Save your changes.

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:

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

Run the connector

To upload the vendor information to Oomnitza, run the connector.

Run the connector in test mode to ensure that the mapped information is uploaded to Oomnitza:

python connector.py upload dell_asset_order_status --testmode

When you are confident that you are uploading the information that you mapped, run the connector again in normal mode:

python connector.py upload dell_asset_order_status

Getting your results

1. Click Configuration > Integrations and click Block view
2. Choose your vendor integration from the Basic Integrations section.
3. Click SYNC SESSIONS.
4. Go to the Assets or Users page and review the information that is uploaded.

Schedule
To find out how to schedule the integration, contact Support or see Installing the connector.

Additional information 

 Integration errors