Creating an extended integration for Nexthink assets

Sync Nexthink with Oomnitza to gain visibility of devices connecting to Nexthink. The information that you retrieve about devices depends on the list of Nexthink Query Language (NQL) 2 IDs that you enter when you create the integration. 

Before you start

To sync with Oomnitza, you require:

The Nexthink base URL.  The format of the Nexthink base URL is: https://<instance>.api.<region>.nexthink.cloud. In this example, the name of your instance is mycompany, and your region is US: https://mycompany.api.US.nexthink.cloud. See Connectivity requirements.

Adding global variables

Save time when you create integrations and run workflows by adding connection information as global variables.

1. Click Configuration > General > Global Settings.
2. Click Add new variable.
3. Add the key value, which is the name of the variable.
4. Enter the value.
5. Save your changes.

The key value is Nexthink.Domain. The value you enter is your Nexthink URL in this format https://<instance>.api.<region>.nexthink.cloud. Say the name of your instance is mycompany, and the region is US, then your URL is : https://mycompany.api.us.nexthink.cloud.

A list of the NQL (Nexthink Query Language 2) IDs that you want to use to retrieve asset information. Enter a comma-separated list of your NQL 2 IDs. See Execute an NQL V2.

To easily find the records that are uploaded to Oomnitza, it's best practice to create a dedicated user account for each integration. This will make it easier for you to retrieve the records that are uploaded to Oomnitza from the vendor application. 

Creating integration users 

Adding credentials

To add credentials, you require the following information:

• The Nexthink base URL which you already retrieved.
• The Nethink scope.
• The client ID and secret when you created your OAuth credentials in Nexthink. See the section Creating API credentials in API credentials.  

Make life easier and add your credentials to Oomnitza before you create the integration.  

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward arrow > to select the integration.
4. Enter your client credentials and any other additional information.
5. Click Authenticate. You are prompted to log in to authorize your request.
6. Click CREATE.

1. On the INFORMATION tab, use the default name or enter a user intuitive name for the credentials.
2. Select an owner.
3. On the AUTHORIZATION tab, complete the following steps.
   1. Ensure that OAuth 2.0 is selected as authorization type.
   2. Enter the base URL.
   3. Enter your client ID and secret.
   4. Enter the scope.
4. Click CREATE.

1. In Oomnitza, click Configuration> Integrations> Overview.
2. Click Block view .
3. Scroll down to the Extended section for asset integrations.
4. Click NEW INTEGRATION.
5. Select the integration in the sidebar.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

Software data

Depending on the asset integration, an option might be available to ingest desktop software information such as the name and version of the software installed on an asset. To view the software information in Oomnitza, you must have the software module. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Integration details

To review or update the integrations details, click Edit .

When you edit the Integration details section, you can select the name or names of 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, or when the scheduled integration fails to run.

1. Update the integration name.
2. Select an installation type.
3. For integration preferences, select an option.
4. Enter the name of the integration user.  

Credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Select Edit integration to add rules for syncing data. Filtering integration results.  

Click SMART MAPPING.

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Mapping fields

The following fields are automatically retrieved and can be mapped to Oomnitza:

• Connect: Base URL
• Connect: Credentials
• Connect: Query IDs
• Connector: Sync Time

Drag and drop

You can map additional fields to Oomnitza.

1. Drag and drop the fields onto the Add new Oomnitza field area in the Oomnitza column.
2. Rename the field.
3. Make your changes.
4. Save your changes.

To map the fields retrieved from Nexthink, you must add custom fields.

Adding custom fields

To add custom fields, complete these steps:

1. Click the Add integration field .
2. Enter the name of the field.
3. Enter the field path.
4. Save your changes.

See Creating new mapping fields. 

Selecting sync keys

You must select at least one field as the sync key field. To ensure that the sync runs successfully, the field must contain unique values such as the serial number of an asset record or the email address of a user record. Records that do not contain a value for the sync key are skipped.   

See Configuring multiple sync keys.

Test

To test the integration, click the tile in the Saas Management Integration section and click RUN NOW. To check for errors, click Sync Sessions.

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Integration points (presets)

Adding the API block

1. Click Configuration > Workflows.
2. Click Add .
3. Select Assets.
4. Click the Blocks tab.
5. Drag and drop the API block onto the canvas.
6. Click Edit .

Selecting a preset

1. Search for the Nexthink.
2. You can select one of the following presets:
   1. Get remote action details
   2. List remote actions
   3. Trigger remote action

Required information

Depending on the preset that is selected, the following information is required:

Preset	Required
Get remote action details	Credentials. Select the credentials that you added for the integration. Remote action NQL ID.  Domain. If you added the domain as a global variable for the integration, this field will be populated.
List remote actions	Credentials. Select the credentials that you added for the integration. Domain. If you added the domain as a global variable for the integration, this field will be populated.
Trigger remote action	Credentials. Select the credentials that you added for the integration. Domain. If you added the domain as a global variable for the integration, this field will be populated. Remote action ID. Device ID.