Creating an extended integration for SolarWinds Web Help Desk users

Let Oomnitza be your single source of truth!

The SolarWinds User Load uses the Get Clients API. You'll get visibility of your SolarWinds clients as data from SolarWinds is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and SolarWinds 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 client information
• Configurable reports to share information about clients with your colleagues and management
• Configurable workflows that you can easily create to automate such tasks relating to SolarWinds Web Help Desk as:
  • Managing SolarWinds clients, including creating and updating clients.
  • Retrieving detailed client information, including the client’s last activity, location, and status.

Navigation

Before you start

Creating the user integration

Creating custom mappings

Creating workflows

Creating user workflows with the API block

Get User Details

Update User

Create User

Before you start

You must complete these tasks before you begin the integration:

• Add credentials to the Oomnitza vault
• Add the host name and port number as global variables

Creating the user integration

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

Integration Overview

Before you start

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

Integration preferences:  By default,  Create and Update are selected. To ensure that only live user records are synced with Oomnitza, select Update Only. When you run the integration, you can check the error logs to see the records that weren't uploaded and why they weren't uploaded. Then, you can decide whether to upload the user records that were skipped by changing your integration preference back to Create and Update.
 

User selection: When you select User plus SaaS User and you have multiple instances of the same SaaS, you can choose your SaaS instance from the dropdown. If you have a single instance of the SaaS, your instance is already detected by the system.

Integration details

Procedure
To review or update the integrations details, click the pencil:

1. Update the integration name if necessary. 
2. From the User Selection list, select an option. 
3. For installation type, ensure that Cloud is selected.
4. For integration preferences, select an option.
5. Enter the name of the integration user.

Credential details

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

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.

1. Click the pencil.
2. Configure your schedule.
3. Click Update.

Mappings

To map the fields to Oomnitza, click the pencil.

Creating custom mappings

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

Complete these actions:

1. Click Smart Mapping.
2. Create a custom mapping for the SolarWinds user id that you can use when creating workflows. The user id should contain a username or email, depending on which attribute was configured for Web Web Help Desk client authentication at Setup > Clients > Options > Client Login Attribute in the Web Web Help Desk Administrator Console. Refer to SolarWinds API Documentation: Get User Details. To create a custom mapping, complete the following steps:
   1. Select the down arrow on the Username or Email field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field to Solar Winds User Id.
   4. Click CREATE. 
3. Map the SolarWinds Email field to the Oomnitza Email field and assign a sync key.
4. Click UPDATE.

Note
For all user loads, it is recommended that you map role information to an employee role in Oomnitza. Users need to have an employee role defined in order to access Oomnitza. If the role information is not available from the user load, it is recommended that you select Employee from the Oomnitza Role dropdown list. You have the option to overwrite this at a later point should the role information become available. 

Standard SolarWinds to Oomnitza mappings

The following SolarWinds fields can be mapped to Oomnitza:

Address
Authenticated Email
Authentication Date
Authentication Key
Base D N
City
Color
Connect: Credentials
Connect: Host
Connect: Port
Connector Sync Time
Creation Date
Dashboard Layout
Email
Employment Status
First Name
Last Activity
Last Ip Address
Last Name
Latest Change To Inactive
Locale String
Location Address
notes
Password
Password Cache Date
Phone
Phone2
Secondary Email
State
Ticket C
Username
Zip

Did you know? 
You can define rules for your integration by selecting Edit integration at the top of the screen. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  

You can add new fields to your integration by selecting the + (Add) option. All you need to do is specify the field name and then enter the JSON path, for example {{response.email}}. See Creating custom API fields. 

Launching the integration

Your integration is in Draft mode until all the required mandatory fields are added. Once you have added all of the required fields, we recommend that you complete the following steps

1. Select Launch to activate your integration.
2. Change your Integration preferences to Update only so that no records are imported and do a Test Run.
3. Click Sync Sessions and review the status of the integration. If you encounter any errors, see troubleshooting integrations.
4. When the test run has been completed, change your Integration preferences and click Run Now.

Getting your results
To view the information that is collected about your assets, click Assets. To view the information about software, click the Software tab. To view the information that is collected about your users, click People. 

Related Links

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

Creating workflows

Creating user workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create user workflows with the API block by following the steps in Using the API block. To locate the available presets, enter SolarWinds in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

• Your correct SolarWinds Credentials that you created in Adding the credentials.
• Your hostname and port number should be derived from the global variable you created when Setting the SolarWinds hostname and port number as a global variable. Alternatively, click Set Manually to manually enter your hostname and port number.

The SolarWinds API block workflow comes with the following presets for users:

Get User Details

Update User

Create User

Using the SolarWinds Get User Details preset

The SolarWinds User Details preset allows you to to get a user's details. When you select this preset, you can use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the SolarWinds user id is referenced in the field {{solar_winds_user_id}} that you created in Creating custom mappings. If you did not create this custom mapping, you can replace the value {{solar_winds_user_id}}} in the URL with the correct field or user id. The user id should contain a username or email, depending on which attribute was configured for Web Web Help Desk client authentication at Setup > Clients > Options > Client Login Attribute in the Web Web Help Desk Administrator Console. 
3. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza. Once you have the entire response, you can then map individual JSON values to custom fields. For further information, refer to the Enhanced API Block.

For further information, refer to the SolarWinds API Documentation: Get User Details.

Using the SolarWinds Update User preset

The SolarWinds Update User preset allows you to update a user in SolarWinds Web Help Desk.

When using this preset, the Update to fields are the fields which will be used in the request body. Ensure that these files are populated with the relevant information in Oomnitza.

• Update to First Name. For example, first_name. 
• Update to Last Name. For example, last_name.

When you select this preset,  use the Advanced Mode to configure the message payload by following the steps in Using the SolarWinds Get User Details preset.

Using the SolarWinds Create User preset

The SolarWinds Create User preset allows you to create a user in SolarWinds Web Help Desk. When using this preset, the New fields are the fields which will be used in the request body. Ensure that these files are populated with the relevant information in Oomnitza.

• New Email Address. For example, email. 
• New First Name. For example, first_name.
• New Last Name. For example, last_name. 
• New Phone Number. For example, phone_number.
• New Username. For example, username.

When you select this preset, use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. Modify, update or add fields that will be used in the request payload. For example, you might want to add additional attributes such as a second phone number or location. For information on the fields that are permitted in the request payload, refer to the SolarWinds API documentation: Creating a Client.
3. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For information on creating custom fields, see Creating Custom Fields in Oomnitza. Once you have the entire response, you can then map individual JSON values to custom fields. For further information, refer to the Enhanced API Block.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your users, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.

Did you know
You can also create extended connector integrations for SolarWinds assets.
 Creating an extended integration for SolarWinds Help Desk assets