Integration details

Add information about the integration and add the Web Service URL to return asset or user information.

• Adding asset integrations
• Adding user integrations

Review the integration list response
Before you enable the Details feature, review the information that is returned.  To do this, you must complete and save the Integration section and Credential details section.  When you've done this, expand the Response section, and click Review response .  A list of the fields and their values that are retrieved by the API request and that can be mapped to Oomnitza are displayed. If all the information that you need is returned and if the information isn't nested in an object, you don't need to enable the Details feature.

Adding asset integrations

1. Click Edit integration details .
2. Enter the name of the integration.
3. Optional. Select the Software checkbox to retrieve the desktop software that is installed on devices. Additional configuration might be required in the Advanced Software Configuration section.
4. Select the Details checkbox. If the Web Service URL does not return all the information that is required in a flat file, that is the information is not nested in an object, you don't need to select the Details checkbox as an additional API request is not required. Otherwise, you must select the Details checkbox.
5. Select the SaaS application.
6. Choose one of the following options as the installation type:
   1. Select Local if you want to store credentials locally.
   2. Select Cloud if you want to store credentials in the Oomnitza cloud for your instance.
7. For integration preferences, choose one of the following options:
   1. Create & Update. Add and update records.
   2. Create only. Add records.
   3. Update only. Update records.
8. Select an integration user. Best practice is to create a dedicated user account. See Creating integration users.

9. Select the name or names of the integration contacts.  Integration contacts will receive an in-app notification and an email:

   • When the integration fails

   • When the integration fails to complete within 24 hours

   • When the scheduled integration fails to run

10. Enter the Web Service URL. If the request returns a list, such as a list of equipment IDs, you must select the Details checkbox and configure the Advanced Detail Configuration section.
11. Optional. Add headers and query parameters.
    1. Add headers. You can add headers and parameters to configure post and get requests. For example, you can add a header to specify the format of the content received such as Content-Type: application/json.
    2. Add parameters.  Filter the response to retrieve or update specific records.
12. Select the pagination type. The default is No Pagination. Learn more about pagination
13. Enter a link to external documentation or logo.
14. Enter notes.
15. Save your changes.

Adding user integrations

To retrieve SaaS user information and use the deactivate SaaS user feature, you must select User plus SaaS user from the User Selection list and select the SaaS application.

The deactivate feature automatically deactivates user records in Oomnitza when:

• A user's record is not retrieved when the sync completes
• The vendor application has marked the user record as inactive

Note
A user's record is reactivated if the user subsequently logs into the SaaS application or the SaaS application reactivates the SaaS user. 

1. Click Edit integration details .
2. Enter the name of the integration.
3. Select User or User plus SaaS user from the User Selection list.
4. Select the SaaS application.
5. By default, the Deactivate SaaS user feature is enabled.
6. Choose one of the following options as the installation type:
   1. Select Local if you want to store credentials locally.
   2. Select Cloud if you want to store credentials in the Oomnitza cloud for your instance.
7. For integration preferences, choose one of the following options:
   1. Create & Update. Add and update records.
   2. Create only. Add records.
   3. Update only. Update records.
8. Select an integration user. Best practice is to create a dedicated user account. See Creating integration users.

9. Select the name or names of the integration contacts.  Integration contacts will receive an in-app notification and an email:

   • When the integration fails

   • When the integration fails to complete within 24 hours

   • When the scheduled integration fails to run

10. Enter the Web Service URL. If the request returns a list, such as a list of user IDs, you must select the Details checkbox and configure the Advanced Detail Configuration. You can add an additional API request to return the  information that you need.
11. Enter the external address of the server to send the API request to.
12. Optional. Add headers and query parameters.
    1. Add headers. You can add headers and parameters to configure post and get requests. For example, you can add a header to specify the format of the content received such as Content-Type: application/json.
    2. Add parameters.  Filter the response to retrieve or update specific records.
13. Select the pagination type. The default is No Pagination. Learn more about pagination
14. Enter a link to external documentation or logo.
15. Enter notes.
16. Save your changes. 

Next: Adding credentials