Creating an extended integration for BambooHR users (OAuth)

Sync employee information from BambooHR with Oomnitza.

Before you start

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 

Get the information you need to complete the integration

To help you complete these steps, review Getting started with the API.

The redirect URL for Oomnitza is:
 https://generic-oauth2-proxy.oomnitza.com/oauth2/redirect_url 

1. Log into the BambooHR developer portal.
2. Create an application  to get your client ID and secret.
3. Implement an OAuth flow.
4. Specify scopes.

Adding your subdomain as a global variable

Add the value as a global variable so that when you create workflows that use presets the variable is automatically added. See Adding global settings.

The name of the variable is BambooHR.domain. Let's say your BambooHR URL is https://oomnitza.bamboohr.com, you enter oomnitza as the subdomain. 

What you need to add the integration and credentials

Domain

Your BambooHR domain. See the OAuth section in Getting started with the API.

Client ID and secret

To find out how to generate OAuth credentials and retrieve your client ID and secret, see Getting started with the API.   

Scopes

Enter a space separated list of scopes. By default, the following scopes are added: email openid employee employee:contact employee_directory sensitive_employee:address.

Learn more about scopes ▼

openid

Authenticates the user and returns an ID token.

email

Returns employee's email address.

employee

Returns general employee data.

employee:contact

Returns employee's contact information.

employee_directory

Returns employee's name, job title, department.

sensitive_employee_address

Returns employee's address.

offline_access

Enables a refresh token to be returned.

Adding 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.

Creating the integration

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. User records and SaaS user records are retrieved. User records are displayed on the People page and SaaS user records can be accessed when you open the SaaS application record on the SaaS page and click the Users tab. In addition to retrieving information about the SaaS application such as usernames, you also retrieve key information such as the user's SaaS role and last activity which will enable you to reduce costs by monitoring SaaS usage and removing users who aren't using the SaaS application. To maintain data hygiene, you can enable the deactivate feature.
• Software SaaS Selection. Link the vendor application to the Oomnitza Software Catalog which is a repository of supported vendor applications and services. If an entry for the vendor application is not shown in the list, it means that the vendor application has not been added to the SaaS page in Oomnitza and linked to the catalog. See SaaS details overview. You can ignore this field because the vendor application is automatically linked to the catalog when the integration is saved.

Important
Now that user information can be retrieved and users deactivated when the integration is run, you can deactivate or remove the workflows that were added to retrieve SaaS user information and deactivate SaaS users. (The block that is used to complete these actions in workflows is the SaaS User Role Retrieval block.)

When you enable the Deactivate feature, the following actions are completed when the integration runs:

• If a user record is missing from the data source - the vendor application - or if the record is marked as inactive in the data source, the user record is deactivated in Oomnitza.
• If a user record was deactivated and is now available in the data source, for example, the user logs into the SaaS application, the user record becomes active in Oomnitza. 

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 to Oomnitza

You can map the following fields to Oomnitza

Address 1
Address 2
Best Email
Can Upload Photo
City
Connector Sync Time
Country
Department
Display Name
Division
Employee ID
Facebook URL
First Name
Full Name
Gender
Home Email
Home Phone
Instagram URL
Job Title Name
Last Name
LinkedIn URL
Location
Middle Name
Mobile Phone
Photo URL
Pinterest URL
Preferred Name
Skype Username
State
Status
Supervisor
Supervisor Email
Twitter URL
Work Email
Work Phone
Work Phone Extension
Zipcode

Click SMART MAPPING to get a head start in mapping the fields. To map other fields, you can click the down arrow in the fields that you want to map to Oomnitza. Select Add new Oomnitza field. Replace the name with a user-friendly name, and click CREATE.

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.

Creating a sync field

1. Choose a field that has unique values such as Employee ID.
2. Click the down arrow .
3. Select Add new Oomnitza field from the list.
4. Add a user friendly name.
5. Select the Unique checkbox.
6. Click CREATE.  

Result

You can select the field to sync records.

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

After you launch the integration, you can test it. In the sidebar, click Test Run .