Creating a vendor extended integration locally

Vendor extended integrations are pre-configured integrations that are easy to set up and ready to use. This makes them a great option for quickly and easily connecting Oomnitza with the applications you use. 

In this article, we will show you how to create a vendor-extended integration and store your credentials on your server. 

Before you start

Refer to Installing a basic integration and complete steps 1 to 3, depending on your operating system.

1. Download and the required dependencies. 
2. Download and install the Oomnitza basic integration.
3. Generate theconfig.inifile that will be used to store Oomnitza credentials.

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.

Retrieve integration credentials and verify permissions

Make sure to obtain your organization's login credentials for the respective integration. This could include your Client ID and Secret, API token, or Username and Password.

When you view integrations in Oomnitza, links are provided to the articles on your vendor applications. These articles are also located in our help center:
1. Click Integrations.
2. Enter the name of the vendor application as the search keyword.
3. Review the information that you must provide to connect to the vendor application.

Restrictions

• AWS or OAuth credentials are not supported. To use these authentication methods, you must select Cloud as the installation type when creating an extended integration. See Creating a vendor extended integration in the cloud
• 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.

Tip
If a vendor integration is not part of our current offering, you can create a custom extended integration. See Custom extended integration

Procedure

Complete the following steps to create a vendor integration locally.

1. Create the integration
2. Add the integration details
3. Schedule the integration
4. Complete the mappings
5. Launch the integration

Create the integration

1. In Oomnitza, click Configuration > Integrations and click Block view
2. On the Integrations page, scroll down to the Extended section for user or asset integrations.
3. Click NEW INTEGRATION.
4. Search for the integration in the sidebar or use the Search.
5. Click ADD.

Add the integration details

Procedure
To review or update the details of the integration, click the pencil:

1. Click Edit.
2. Optional. Change the name of the extended integration.
3. Extended integrations for users only. From the User Selection list, choose one of the following options:
   1. Select User only to add user records to the User object. 
   2. Select User plus SaaS user to add user records to the User object and the SaaS object. The benefit of adding SaaS user records is that you can run a SaaS user workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that you can retrieve about SaaS users depends on the availability of SaaS user workflows for the integration. 
   If you have already added records to the SaaS object from a previous integration, you are prompted to select it from the Software SaaS Selection list.
4. For installation type, ensure that Local is selected.
5. For integration preferences, choose one of the following options:
   1. Create & update. This allows for updating existing records and creating new ones.
   2. Create only. This only creates new records.
   3. Update Only. This only updates existing records.
6. Enter the name of the integration user.

Schedule the integration

By default, Oomnitza syncs with applications every day. Ensure that the sync occurs when your system isn't busy.

1. Click Edit
2. Make your changes.
3. Click Update.

Complete the mappings

To map the fields to Oomnitza, click the pencil.

Complete these actions:

1. Click Smart Mapping to automatically map the fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. You can create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, complete the following steps:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza field.
   3. Change the name of the field.
   4. Select the Unique checkbox if you want to use this custom field as the sync key.
   5. Click CREATE.
3. Select a sync key, such as a Serial Number or Email. The field must have unique values.
4. Click UPDATE.

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 avail of complete additional actions on the mapping page, such as filtering the values that are mapped and creating new mapping fields.  Mapping extended integrations

Launch the integration

Click Launch in the sidebar to activate your integration.

Next steps

Run the integration