Template Interfaces

Template Interfaces

Template Interfaces

Info
A Template is the blueprint for an integration between two systems. 

Info
A Template Interface is the finished product of that blueprint, an integration put to work. 

At BrynQ we work out how two systems should connect up front, the result is a Template, which defines the structure and rules that make sure data flows correctly from a source system to a target system.

A Template Interface is the live version of that Template, connecting your specific systems and doing the actual work of moving data between them. Because it's built from a tested blueprint, it follows a proven standard from day one. BrynQ offers the option to fine-tune this interface to fit needs of specific organizations.

Idea

Template Example: 
The HiBob – Nmbrs | Employee Data Template defines how employee data should move from HiBob to Nmbrs. 

The interface built from it, connected to your systems, then knows how to sync those details (name, birth date, social security number, and more).

Customization

Depending on your setup, a Template Interface can be fine-tuned to fit your specific needs. For example, you may use custom fields or change how certain fields map.

How much you can change depends on your subscription: In general, the higher the subscription tier, the more freedom you gain to customize and fine-tune your interface beyond the default settings.

Alert
Warning: The more you customize, the less likely it is to work out of the box and more intensive testing is needed.


Getting started

1. Set up your interface

  1. Go to Interfaces and click on New Interface.
  2. Choose the template-based option.
  3. Navigate to and Pick a template that matches your source and target apps.
Once created, you land in the interface setup. New template interfaces start as a draft.

Alert
If the required apps aren't active yet, BrynQ will prompt you to activate them first. You may also reach plan limits on interfaces or apps. Your BrynQ contact can help with that!

2. Complete the setup sections

Work through the sections shown for your interface. 
Not every template includes every section: that depends on the template and your subscription.

A typical order:

  • Configuration:  answer the setup questions for this template (company settings, preferences, and so on).
  • Scenarios: review what data is exchanged and how fields map between the two systems.
  • Data filters: limit which records are included, if applicable.
  • Authorization: connect the credentials for your source and target apps. The interface can't run until this is complete.
  • Logging & monitoring: configure how runs are logged and monitored.

Notes
Resolve any validation warnings before publishing; sections with issues are usually flagged in the interface header. Changes to a draft are saved automatically.

3. Publish

When setup is complete, publish the draft to make the interface live. Until you do, the interface isn't production-ready. Depending on your template, scheduling may only become available after publishing.


4. Run and monitor

From the interface overview you can:

  • Run manually  useful for a first test.
  • Set a schedule  run on a timer or after another interface, once scheduling is available.
  • Review runs check the status, logs, and errors after each run.

The way Template Interfaces are set up in the BrynQ app is in continuously improved, so some details may change over time.



    • Related Articles

    • Determine Interface Scope

      This guide explains how to create and manage interfaces between two systems (source and target systems) within our platform. It includes creating a new interface, defining scenarios, detailing fields per scenario, and submitting your setup for ...

    • Setup an automated data interface between Factorial and Sage

      What is this guide for? This guide walks you through setting up an automated data interface between Factorial and Sage 100. Once complete, employee data will flow from Factorial into Sage automatically — no manual exports, no copy-pasting, no ...