Creating an extended integration for SAP Litmos users – oomnitza

Let Oomnitza be your single source of truth!

You'll get complete visibility of your users as data from Litmos is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Litmos in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

Configurable dashboards and list views of key user information
Configurable reports to share information about users with your colleagues and management
Workflows for retrieving SaaS user roles and deactivating SaaS users in Oomnitza

Navigation

Add credentials

Create the user integration

Create workflows

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

To stream Litmos user data into Oomnitza, you must add your API connection credentials to the Oomnitza vault.

Each request to the SAP Litmos API requires an API Key in the request header.

Locate your Litmos API key

Information
You need to know which environment you run your application in because each environment has a specific URL. See the Making requests section in Overview developer API.

Add credentials to the vault in Oomnitza

To authorize connections between Oomnitza and Litmos, complete these steps:

Log into Oomnitza.
Click Settings > Credentials, and then click Add new credential (+).
Add the information details.
Click the AUTHORIZATION tab.
As authorization type, select API Key.
Enter apikey as the token name.
Enter the API key.
Ensure that Add to Header is selected.
Click CREATE.

You use the credentials that you added to create and customize your with Oomnitza.

Create the user integration

Info and connect details

From the menu, click Settings.
Click Integrations List View .
On the Integrations page, scroll down to the Extended section for User Integrations.
Click NEW INTEGRATION.
In the New User Integration sidebar, click Litmos.
Click APPLY next to SAP Litmos User Load, and then click NEXT twice.

Connect page

Best practice
To ensure that only live user records are streamed to Oomnitza, choose Update only as your integration preference. When you run the integration, you can check the error logs to see which user records weren't uploaded and why they weren't uploaded. You can then decide whether to upload the user records that were skipped by changing your integration preference to create and upload. See Access error logs.

Enter a descriptive name for the integration such as Litmos Users. That'll be the name of the user integration that is shown on the Integrations page.
From the User Selection list, select User plus SaaS User.
From the installation type list, select Cloud.
From the Credentials list, select your credentials.
From the Integration Preferences list, select Update only.
Enter the name of the user of the integration.
Enter the base API URL.
- The API base URL for US is https://api.litmos.com/v1.svc
- The API base URL for EU is https://api.litmoseu.com/v1.svc
- The API base URL for AU is https://api.litmos.com.au/v1.svc
Click Next.

Mappings

Map the Litmos fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

Click SMART MAPPINGS.
Create custom mappings to map the Litmos fields that you want to add to Oomnitza:
1. Click the down arrow on the field that you want to map.
2. Select Add new Oomnitza user field.
3. Change the name of the field. For example, you can change the name of the Id field to Litmos ID.
4. Click CREATE.
Assign an Oomnitza role to the users such as Employee.
Assign a sync key to one of the fields such as the email field.
Click NEXT.

Custom Litmos to Oomnitza mappings

The following Litmos fields can be mapped to Oomnitza:

Access Level
Active?
Connector Sync Time
Email
Family name
First name
Id
Username

Want to map more fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

When you've completed mapping the Litmos to Oomnitza fields, click NEXT.

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

Configure your schedule.
Click FINISH.

Result

A new tile is created for the integration on the Integrations page.

What to do next

If you want to see the information that is collected now, click the tile on the Integrations page and click RUN.

Figure: Mock-up for illustration purposes

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings.

Create workflows

You can use the SaaS User Role Retrieval block to retrieve SaaS user roles and to deactivate users.

From the menu, select Software.
Click Workflow and select SaaS Users.
Click Add workflow (+). The Begin and End blocks are automatically added to the canvas.
Enter the name of the workflow and a description.
Edit the Begin block.
- Create a schedule for running the workflow.
- Use a rule to identify the SaaS software
- Add rules to trigger the workflow. For example, you can add a rule to deactivate users who haven't logged in for a number of days.
From the Integrations section, drag and drop the SaaS User Role Retrieval block onto the canvas.
Edit the SaaS User Role Retrieval block.
1. To find the preset, type Litmos.
2. Click the right arrow (>) next to Litmos SaaS User Role.
3. Select your credentials. By default, the Deactivate User checkbox is selected.
Connect the workflows.
Validate, save, and launch the workflow.