Skip to main content
Sign in

Creating an extended integration for RFPIO users

  • November 13, 2024 14:08
  • Updated

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

  1. Adding the credentials
  2. Setting the RFPIO subdomain as a global variable
  3. Creating the user integration
  4. Creating custom mappings
  5. Creating workflows
    1. Creating user workflows using the API block
      1. Get user details
      2. Activate user
      3. Deactivate user
      4. Add user

Before you start

For the integration with Oomnitza, best practice is to 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 key.
  5. For the value, enter the full URL excluding the leading https://, using the format subdomain.rfpio.com, where subdomain is your RFPIO subdomain. For example, if your RFPIO subdomain is mycompany, then enter mycompany.rfpio.com as the value.
  6. Save your changes.

Adding the credentials

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

  1. In Oomnitza, click Configuration > Security > Credentials.
  2. Click Add new credential (+).
  3. Search for the integration, and then click the forward button > to select the integration.
  4. Add your API key.
  5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

  1. Add the information details.
  2. Click the AUTHORIZATION tab.
  3. Ensure that API Key is selected as the Authorization type.
  4. Ensure that the Token Name is Authorization 
  5. Enter Bearer followed by a space and the API Key in the API Key field. For example,Bearer l35xxxxxxxxxxxxxxxxsae05.
  6. Ensure that Add to Header is selected.
  7. Save your changes.

Next

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

Creating the user integration

  1. In Oomnitza, click Configuration > Integrations > Overview.
  2. Click Block view block_view.PNG.
  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

  1. Click Edit edit_black_pencil_icon.svg.
  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 edit_black_pencil_icon.svg.
  2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit edit_black_pencil_icon.svg.

 cog_red_dot_small_icon.svg Selecting Edit integration to add rules for syncing data. small_blue_link.svg Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field  add_grey_rectangel_icon.svg on the mapping page. 
small_blue_link.svg Creating custom API fields. 

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 to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
  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. Ensure that the Username is mapped to the:
    1. Username field on the Oomnitza side (required for integration).
    2. Email field on the Oomnitza side (required for integration).
  4. Select the Role field on the Oomnitza mapping side.
  5. Choose a suitable role from the list (a defined role is necessary for the integration)
  6. Assign a sync key to a unique field, such as the Email.
  7. Click UPDATE.

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

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

small_blue_link.svg If you selected Cloud as the installation type when creating the integration, see Running an extended integration

small_blue_link.svg 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

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 RFPIO in the Select Preset search field. Select your preset of choice and for every preset enter the following information in the Configure section:

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, click Configuration > Data model > Field Configuration and select Users from the list. 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, click Configuration > Data model > Field Configuration and then select Users from the list. See Creating Custom Fields in Oomnitza.

Tip
Yo modify the presets refer to the RFPIO API Documentation.

articles_icon.svg Reference articles for workflows

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.

Related articles

Comments

0 comments

Please sign in to leave a comment.