Mapping extended connectors – oomnitza

Navigation

Oomnitza's mapping screen is used in imports and connectors to allow Oomnitza admins to create mappings between systems and define how data is imported into Oomnitza.

Mapping fields

Values from the connector can be dragged to Oomnitza fields to create mappings, or can be selected from a dropdown.

Creating Oomnitza asset and user fields

You can also create new fields directly in Oomnitza's assets or users module straight from the Mappings page. New fields can be created 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.

Creating custom API fields

While Oomnitza tries to maintain detailed lists of available fields through the mappings screen, sometimes, due to changes to the source systems API, or the presence of custom data, it's necessary to create custom API fields. These can be added using the "+" button at the top of the connector mappings:

From here, you'll need to give the field a name, and specify the path to that field as it's returned in the JSON. 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 data the following ways, and more:

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 support@oomnitza.com.

The create custom API field option is also very useful for hardcoding certain values within the Oomnitza side. You can achieve this by using a syntax like {{"My hardcoded value"}}. While you technically can also do this by directly typing the hardcoded value into the target field on the right side of the connector, defining it as a new field on the left and using the mapping to a field within Oomnitza will also allow you to use the filtering of such field to e.g. only update the field in Oomnitza if it is empty. This can e.g. be used for user integrations and there specifically to default a role for new users only, meaning in the filter criteria on the right side you would the select to only update this field in Oomnitza if it is empty. Another use case for this would be to perform string operations to e.g. concatenate various fields as well as hardcoded segments into a username from the source data to match the username in Oomnitza in case you are not able to retrieve a matching username from the source data.

Jinja2 Templates

Oomnitza's Extended Connectors allow the use of Jinja2 Templates in order to transform data being retrieved by the connector. For further information, refer to Working with Jinja2.

Filtering Results

The Connector allows for results to be filtered, ensuring only the desired objects are updated. To add filters to a connector, click the cog icon in the upper left of the connector 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 connector, ensuring only certain objects are updated depending on the conditions that are executed.

Restrict access to users

You can restrict access to Oomnitza users from the Mappings page 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 he Restrict User checkbox for the user in the People tab to reverse this action.