Creating an extended integration for RFPIO users

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and RFPIO 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
• Configurable workflows that you can easily create to automate such tasks as:
  • Getting, adding and activating user details.
  • Deactivating a user.

Navigation

Adding the credentials

Setting the RFPIO subdomain as a global variable

Creating the user integration

Creating custom mappings

Creating workflows

Creating user workflows with the API block

Get User Details

Activate User

Deactivate User

Add User

Before you start

For the integration with Oomnitza, we recommend that you create a dedicated user account.

RFPIO uses API key authentication. To obtain an API key in RFPIO, navigate to Your Account > User Account > RFPIO API Token > Generate API Token and copy your API token.

For further information, refer to the RFPIO API Documentation.

Note
You need to create a free user account and register your email address before you can access the RFPIO API Documentation.

Setting the RFPIO subdomain as a global variable

To save time entering information when you create the user integration and the workflow, you can add the RFPIO subdomain as a global variable in Oomnitza.

1. From the menu, go to Configuration>General.
2. Click Global Settings.
3. Click Add new variable (+). 
4. Enter RFPIO.Subdomain as the variable name.
5. Enter your RFPIO subdomain. If your subdomain ishttps://mycompany.rfpio.comyour subdomain would be: mycompany.
6. Save your changes.

Adding the credentials

To stream RFPIO user data into Oomnitza, complete the following steps:

1. In Oomnitza, go to Configuration>Security>Credentials.
2. Click Add new credential (+).
3. Add the information details.
4. Click the AUTHORIZATION tab.
5. Ensure that API Key is selected as the authorization type.
6. Enter Authorization as the name of the token. 
7. Enter Bearer followed by the API Key in the API Key field. For example,Bearer l35xxxxxxxxxxxxxxxxsae05.
8. Ensure that Add to Header is selected.
9. Save your changes.

Next

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

Creating the user integration

Info and connect details

1. In Oomnitza, go to 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. In the New User Integration sidebar, click RFPIO.
6. Click APPLY next to the RFPIO User Load, and then click NEXT twice.

Connect page

Best practiceTo 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.

On the connect page, complete the following steps to connect the integration:

1. Enter a descriptive name for the integration such as RFPIO User Load. This name will be displayed on the Integrations page once the setup is complete.
2. From the User Selection list, select User plus SaaS User or User only.
3. If you select User plus SaaS User and you have multiple instances of the same SaaS application, select the application from the SaaS Selection list. If you have a single instance of the SaaS application, skip this step.
4. From the installation type list, select Cloud.
5. From the Credentials list, select your credentials that you created in Adding the credentials.
6. From the Integration Preferences list, select Update only.   
7. Enter the name of the user of the integration.
8. Your subdomain should be derived from the global variable you created when Setting the RFPIO subdomain as a global variable. Alternatively, click Set Manually to manually enter your subdomain.
9. Click Next.

Creating custom mappings

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

Complete these actions:

1. Click Smart Mapping.
2. You have the option to create custom mappings to map any field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field.
   4. Click CREATE. 
3. Map the RFPIO Username field to the Oomnitza Email field and assign a sync key.
4. Click NEXT.

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

The following RFPIO fields can be mapped to Oomnitza:

Create Time Stamp
First NameId
Job Title
Language
Last Name
Location
Phone Number
Status
Time Zone
User Role
Username

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

When you've completed mapping the RFPIO 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.

1. Configure your schedule.
2. Click FINISH.

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

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. 

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 Creating user workflows with the API block. To locate the available presets, enter RFPIO 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 RFPIO Credentials that you created in Adding the credentials.
• Your subdomain should be derived from the global variable you created when Setting the RFPIO subdomain as a global variable. Alternatively, click Set Manually to manually enter your subdomain.

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

User Details

Activate User

Deactivate User

Add User

Using the RFPIO Get User Details preset

The RFPIO 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 RFPIO email is referenced in the field {{email}} that you created in Creating custom mappings. If you did not create this custom mapping, you can replace the value {{email}} in the URL with the correct field or user id. 
3. Select the Response tab. For troubleshooting purposes, you can map the Response field  {{response}} to a custom long text Oomnitza field. Once you have the entire response, you can then map to individual JSON values to custom fields. To create a custom field, go to People>Customization in Oomnitza. For further information, see Creating Custom Fields in Oomnitza.

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

Using the RFPIO Activate User preset

The RFPIO Activate User preset allows you to update the status of an RFPIO user to 'ACTIVE'. When you select this preset, you can follow the steps in Using the RFPIO User Details preset to configure the message payload. For further information, refer to the RFPIO API Documentation: Update User Status (Activate).

Using the RFPIO Deactivate User preset

The RFPIO Deactivate User preset allows you to update the status of an RFPIO user to 'DEACTIVATE'. When you select this preset, you can follow the steps in Using the RFPIO User Details preset to configure the message payload. For further information, refer to the RFPIO API Documentation: Update User Status (Deactivate).

Using the RFPIO Add User preset

The RFPIO Add User preset enables you to onboard an RFPIO user. When you select this preset, you need to provide the following details of the new user:

• New First Name
• New Last Name
• New Email

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 information on the fields that are permitted in the request payload, refer to the RFPIO API Documentation: Add User Account. The userName field which appears in the message body should contain the email address of the user.
3. Select the Response tab.
4. For troubleshooting purposes, you can map the Response field  {{response}} to a custom long text Oomnitza field. Once you have the entire response, you can then map to individual JSON values to custom fields. To create a custom field, go to People>Customization in Oomnitza. For further information, see Creating Custom Fields in Oomnitza.

Tip
You can modify or amend any of the above presets by referring to the RFPIO API Documentation.

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:

See  Getting started for more information.