Mapping extended integrations

Contents

1. How to map fields
2. How to create fields
3. Filtering integration results
4. Creating custom API fields
5. Creating custom Jinja2 fields
6. Restricting access to users
7. Adding predefined fields

Oomnitza's mapping screen is used in integrations to allow Oomnitza admins to define how data is imported into Oomnitza. You can view the mappings section by navigating to Configuration>Integrations and selecting an existing integration or creating a new one. 

Mapping fields

Use the mapping section to map integration fields to Oomnitza fields. 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.

 

Creating fields

You can also create new fields by clicking the down arrow on the field you wish to map. Select Add new Oomnitza users field or Add new Oomnitza assets field to add a new field.

Filtering 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're given the following options:

• Restore archived records: Restores archived assets when an asset is matched.
• 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 objects are updated depending on the conditions that are executed.

Creating custom API fields

Specifying an API path

While Oomnitza tries to supply the latest up-to-date integration fields, due to changes to the source systems API, or the presence of custom data, you may need to create your own custom API fields. These can be added by selecting "+" at the top of the integration mappings:

From here, you'll need to supply a field name and the JSON path. The system is made to be flexible and will recognize paths that are enclosed or not enclosed in double-curly brackets (e.g. {{custom_field}}) or custom_field) or nested fields that use either dot, or bracket notation (e.g. {{profile["custom_field"]}} or profile.custm_field

For example, if the data coming from the source system appears as so:

{
    "profile": {
        "field_1": "value 1",
        "field_2": "value 2"
    },
    "status": "value 3"
}

You can access the data in the following ways:

value 1: profile.field_1

value 2: {{profile["field_2"]}}

value 3: status

For any questions or help creating custom mappings for your extended connectors, please reach out to [e-mail].

Hardcoding values

The Add new field feature is also very useful for hardcoding certain values on the Oomnitza side. While you technically can also do this by following the steps in Adding default field values, you can also define it as a new integration field and map it to an Oomnitza field. In the example below, a new field called Role is created and the default value is hardcoded to {{"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, i.e. users in Oomnitza where the Role field is empty. 

Concatenate values

You can also 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. 

Creating custom Jinja2 fields

Oomnitza's Extended Connectors allow the use of 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 field to the current time. For detailed information, refer to Working with Jinja2.

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

Adding 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 the Role has been predefined, it will appear in the Predefined list in the integrations overview screen.

You should know
Users need to have an employee role defined in order to access Oomnitza. 

Fig: Creating a predefined field.

Fig: Reviewing a predefined field