Mapping extended integrations

The following additional features are available to you when you map extended integrations.

Contents

1. Filter integration results
2. Add new mapping fields
3. Restrict access to users
4. Add predefined fields

Filter integration results

The Connector allows for integration results to be filtered. To add filters to an integration, click the cog icon in the upper left of the mappings page. 

From this panel, you can choose the following options:

• Restore archived records: Restores archived records. 
• Always create/update the record in OOMNITZA: Ensures that records are always created/updated.
• Create/update the record in OOMNITZA if: Allows filters to be applied to the integration, ensuring only certain records are updated depending on the conditions that are specified.

Add new mapping fields

Oomnitza aims to provide the most current integration fields, but changes in the source system's API or the inclusion of custom data may require you to establish your own mapping fields. These can be added by selecting "+" at the top of the integration mappings:

The {{response}} object stores the response body can be accessed by appending the JSON path to the {{response}} value, for example, {{response.field_name}}. The response value can be enclosed in double curly brackets.

Nested fields use dot or bracket notation such as {{response.profile["field_name"]}} or {{response.profile.field_name}}.

For instance, if the source system provides the following data:

{
    "profile": {
        "first_name": "Helen",
        "last_name": "Troy"
    },
    "status": "Active"
}

You can access the first_name using the following formula:

• {{response.profile.first_name}}
• {{response.profile["first_name"]}}

To access the last_name you use:

• {{response.profile.last_name}}
• {{response.profile["last_name"]}}.

And to retrieve statususe:

• {{response.status}}
• {{response["status"]}}

Important
In the unusual circumstance where there is a hyphen in the response, use the following bracket notation: {{response["test-field"]}, otherwise, the workflow will fail to run successfully.

Hardcode values

The Add new field feature is also very useful for hardcoding certain values on the Oomnitza side. In the example below, a new field called Role is created and the default value is hardcoded as {{"Employee"}}.

This new field can then be mapped to an Oomnitza field.

Finally, click the edit integration icon and add a rule to only update the field in Oomnitza if it is empty.

This example can be used for user integrations to create an Employee role for new users in Oomnitza only. That is, users in Oomnitza where the Role field is empty. 

Concatenate values

You can use the Add new field feature to concatenate various paths as well as hardcoded segments to create a custom value. In the example below, the value {{GetUserResponse.GetUserResult.User.UserName}}@mycompanydomain.com prepends the username to @mycompanydomain.com (where mycompanydomainis the name of the company). This field can then be mapped to Oomnitza and will create the email when the integration is run. 

Add custom Jinja code

You can also use the Add new field feature to add Jinja2 templates in order to transform data being retrieved by the connector. In the example below, a custom Jinja2 field is added to the path to set the Last Sync Time field to the current time. 

Restrict access to users

You can restrict access to Oomnitza users from the Mappings sections by selecting True. This prevents any user who is loaded in Oomnitza via the connector from accessing Oomnitza via Single Sign On. When the user is imported, an admin can deselect the Restrict User checkbox for the user in the People tab to reverse this action.  

Add predefined fields

You can create predefined fields for your mapping so that a default value will automatically be populated in a record when the integration is run. In the example below, the value Employee has been selected as a default value from the Oomnitza Role dropdown list. This ensures that each user record that is created will have an Employee role defined. Once a Role is predefined, it will appear in the Predefined fields list on the integrations overview screen

You should know
In order to access Oomnitza, users must have an employee role defined

Fig: Creating a predefined field.

Fig: Reviewing a predefined field

Related Links

Using Jinja2 in Oomnitza