Creating an extended integration for Microsoft Power BI users

Sync Microsoft Power BI with Oomnitza to gain visibility of user data. The user information that is retrieved depends on the the table that is queried when you create the integration.

Before you start

To sync with Oomnitza, you require:

The Group ID. Group IDs are like Workspace IDs and are used to distinguish one workspace from another. See Get Groups. 

The Dataset ID. A dataset ID is used to identify a specific dataset in a group. See Datasets - Get datasets in group. 

The Table Name. The name of the table that you want to query. Push datasets - datasets GetTables.

Creating an integration user

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 your OAuth credentials to Oomnitza

Review Authorization request to retrieve your OAuth credentials in Microsoft Power BI.

To add credentials, you require the following information:

• Client ID
• Client Secret
• Tenant ID
• Resource

Ensure that the account that is used to create the credentials has the appropriate scopes such as Dataset.ReadWrite.All or Dataset.Read.All.

Learn more about Microsoft resource owner grant in Adding Microsoft OAuth credentials to Oomnitza.

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. In Oomnitza, click Configuration > Integrations > Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

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

• User only. Add user records.
• User plus SaaS user. Add user and SaaS user records. 

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration. 

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.

Editing the integration details

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. Click Edit .
2. Make your changes.

Editing the 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.  
 

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: Credentials
• Connect: Dataset ID
• Connect: Group ID
• Connector: Sync Time
• Connect: Table Name

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.

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.

About adding field path values

The row syntax for Microsoft Power BI is as follows:

 table_name[column] : value 

Example

To map the field to Oomnitza, you must reference the table_name[column].

Field path example

Use the following format. Use OPENSQAUREBRAC_<string>_CLOSESQAUREBRAC_ to escape square brackets [ ].

{% if DSA_BYU_PATHWAY_ABC_DEVICE_INFO_OPENSQAUREBRAC_MNM_ITSM_ID_CLOSESQAUREBRAC_
%}{{DSA_BYU_PATHWAY_ABC_DEVICE_INFO_OPENSQAUREBRAC_MNM_ITSM_ID_CLOSESQAUREBRAC_}}{%else%}{%endif%}

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