Native Integrations Module

Table of Contents

1. Table of Contents
2. Creating a New Integration
3. Initial Setup
   1. Sync on Fields
   2. Platform Specific Setup
4. Starting the Sync

Creating a New Integration

1. Follow the steps to get to the page to create a new integration:
2. Fill out all available fields
   1. Integration Type: This is the platform you would like to integrate with
   2. Integration API Client: This is a QBench API Client that you must configure yourself. Make sure you configure your API Client to:
      1. Have API V2 access
      2. Have the proper permissions for all the entities related to the integration platform.
3. Work with the QBench team to get your Magic Link to authenticate with your integration partner.

Initial Setup

Sync on Fields

Overview

The Sync on Fields section within the Configuration tab allows you to define criteria for linking existing QBench entities with preexisting entities in the Integration Platform.

By default, when an unsynced entity exists in QBench, it is created as a new entity in the Integration Platform during a sync.

However, when Sync on Fields is enabled, QBench will attempt to match entities based on the specified fields. If a match is found, no new entity is created—instead, the existing entities are linked automatically.

For example, consider the configuration shown below:

With the configuration above, if an unsynced Customer in QBench has the exact same name as an existing Account in the Integration Platform, QBench will link the Customer to that Account. Going forward, any updates made to the QBench Customer will be reflected in the linked Account—no new Account will be created in the Integration Platform.

Configuration

Let's review each field on this screen individually.

QBench Field

This dropdown lets you select the QBench field to use for syncing. It includes all fields of type STR, TEXT, and NUM for the selected entity.

Integration Field

This text field specifies the corresponding field in the Integration Platform to sync on. Since these fields aren’t directly visible in the UI, you may need to contact QBench Support for assistance in filling this out.

Additional Field Checkbox

Use this checkbox to indicate whether the Integration Field is a Common Model Field or an additional/custom field. Additional fields require specific processing logic. If you're unsure whether this should be checked, reach out to QBench Support for guidance.

Active Checkbox

This toggle controls whether the Sync on Fields logic is active. When unchecked, unsynced QBench entities will always be created as new entities in the Integration Platform. When checked, the sync will attempt to match and link entities based on the defined criteria before creating anything new.

Expected Behavior and Errors

When Sync on Fields is enabled and a QBench entity is being synced for the first time, the following outcomes are possible:

No Match is Found

If no matching entity is found based on the configured criteria, a new entity will be created in the Integration Platform.

Multiple Matches are Found

If multiple entities match the specified criteria, a DuplicateEntityInTargetPlatformException will be thrown, and no new entity will be created in the Integration Platform.

One Match Found (Already Linked to a QBench Entity)

If exactly one match is found, but that Integration entity is already linked to another QBench entity, a DuplicateEntityInQBenchException will be thrown. In this case, the QBench entity will not be synced, and no new entity will be created.

One Match Found (Unlinked)

If exactly one match is found and the Integration entity is not yet linked to any QBench entity, the two will be linked automatically. They will sync going forward, and no new entity will be created in the Integration Platform.

Platform Specific Setup

This section will contain custom settings that are unique to the platform the integration is connected to. Click on the appropriate link to view the configuration set up settings:

• Accounting

Starting the Sync

Once you have completed all your setup and you are ready for the sync to start, simply set the Integration to "Active"

Next time the integration runs (typically an hourly basis), your data will begin syncing! You will know when it's run by refreshing the "Logs" tab and you see an entry like this: