About Scenarios - Organizing your interface into topics
Overview
Analogy: Think of it like sorting mail. The target app is your filing cabinet, the source app is the incoming mail, and each Scenario is a clerk who files the incoming mail into the right specific drawer.
What is a Scenario?
The source HR system and the target Payroll system are each organized around topics, such as Personal Details, Addresses, Contract, Salary, and so on.
BrynQ processes your data topic by topic, and a Scenario defines how one such topic is handled.
Specifically, a Scenario describes what a topic looks like in both systems, and how BrynQ synchronizes the data for that topic between them.
Key points to understand about Scenarios:
- The interface is divided into Scenarios - one per topic.
- Each Scenario defines WHAT data is synced and HOW - it outlines the data and the logic behind the synchronization for that topic.
- Each Scenario typically aligns with one destination in the target Payroll system - while on the source side, the data may come from multiple locations within the HR system.
- Scenarios run in a fixed order - when a synchronization is triggered, the interface executes each Scenario one by one in a specific sequence.
Important: Scenarios are always structured around the target system. Because BrynQ sends data to the target Payroll system, the setup of each Scenario follows the structure of how that topic is organized in the target — not the source.
Scenarios keep the integration reliable:
- Easy to troubleshoot
- Accurate routing – the system always knows where each change belongs
- Focused view – you only see fields relevant to that destination
Navigating the Scenarios Screen
Open an interface and click the Scenarios tab.
Left panel – Scenario list
- Click a Scenario name to open it
- Drag the dotted grip handle to reorder Scenarios
- Click the ⋮ menu next to a name to:
- Disable scenario – stops sending data but keeps the configuration
- Delete scenario – only available for Scenarios you created; template Scenarios can only be disabled
- Click Add new scenario to create a new one
Note: On some plans, adding new Scenarios is locked. You will see an upgrade notice if this applies to your account.
Disabled Scenarios appear under Inactive scenarios at the bottom of the list. Click the circular arrow icon to re-enable one.
A red warning triangle (⚠) next to a Scenario name means there is a configuration issue. Open the Scenario to review and resolve it.
Right panel – Scenario detail
At the top you can edit:
- Name – the Scenario title
- Description – a short note about what this Scenario does (up to 500 characters)
- Additional comments – internal notes for your team (shown at the bottom of the panel)
Below these fields is the list of Records.
What is a Record?
A Record is a single row inside a Scenario. It defines one mapping:
"Take this value from the source. Put it here in the target."
Each row has four columns:
| Column | Description |
|---|---|
| Source fields | Where the value comes from |
| Target fields | Where the value goes |
| Mapping | How the value is transformed in transit (if needed) |
| Actions | The Unique key button and the disable/delete control |
The Unique Key
The Unique key tells BrynQ how to identify a specific record (a person, contract, address, etc.) in the target app. Without it, the system cannot match incoming data to the right entry.
Important: Every Scenario must have at least one row marked as the Unique key. If none is set, BrynQ will display this message and will not process the Scenario:
"Your scenario needs at least one unique key in order for your scenario to be processed."
You can mark more than one row as the Unique key. Together, they form a combined identifier — for example, employee number + contract number.
Disabling a Record
Some rows can be disabled if they are not needed. However, rows marked as Required or Unique are locked and cannot be disabled.
Field Relationships (1:1, 1:N, N:1, N:M)
You do not manually set a relation type. BrynQ determines it automatically based on how many fields you select on each side:
| Selection | Relation | Example |
|---|---|---|
| 1 source → 1 target | 1:1 | Email → Email |
| 1 source → multiple targets | 1:N | Full name → First name + Last name |
| Multiple sources → 1 target | N:1 | Street + Number → Address line |
| Multiple sources → multiple targets | N:M | Country + Marital status → Tax code + Social code |
Most rows will be 1:1.
When do you need N:M? When a single source field does not provide enough information on its own. For example, a tax code that depends on both country and marital status — neither field alone gives you the right result.
If you need to change how fields are combined, open the row and use the Rename logic / Transformation dropdown. Options include Automatic, Concatenate, Fill in order, and Keep source fields. Leave this on Automatic unless you have a specific reason to change it.
What is a Value Mapping?
Use a Value Mapping when the source and target apps represent the same data differently.
Identifying Value Mappings on screen
In the Mapping column:
- Filled button – a value mapping is configured
- Outline (empty) button – no mapping set
- ✓ badge – mapping is complete
- ! badge – mapping is required but not yet set
Click the button to open the mapping table.
Example
Mapping country of residence between Bob (source) and Zenegy (target):
| Source value (Bob) | Target value (Zenegy) |
|---|---|
| Netherlands | NL |
| United Kingdom | GB |
| Germany | DE |
Without this mapping, Zenegy rejects "Netherlands" because it only accepts country codes.
Some Value Mappings are required (the target app enforces a specific format). Others are optional (used to clean up or standardise data).
Matching Strategy
If incoming data may contain inconsistencies (extra spaces, different capitalisation), you can adjust how strictly BrynQ matches values. Select a strategy at the top of the mapping table:
| Strategy | Ignores |
|---|---|
| Exact match (default) | Nothing — must match precisely |
| Ignore case | Upper vs. lower case |
| Ignore spaces | Spaces |
| Ignore special characters | Symbols and spaces |
| Flexible match | Capitalisation, symbols, and spaces |
Default Value
You can set a default value in the mapping table. If an incoming value is not found in the list, BrynQ uses the default instead of failing.
Field Types
Click the small icon next to a field to change its type:
| Type | Icon | Description |
|---|---|---|
| Library field | Database | A standard field that ships with the app. Use this by default. |
| Custom field | File / pen | A non-standard field specific to one customer's setup. |
| Field | Pencil | A general field selection. |
| Fixed value (source only) | Type | Always sends the same value — e.g., always send "Active". |
| Empty value (source only) | Box | Sends no value (empty). |
Library vs. Custom: Library fields are standard fields available to all customers. Custom fields are extras that exist only for a specific customer's configuration.
Note: There is also a Configuration field type, but this is not visible in the field type menu on the customer side. Configuration values are set on the Configuration tab of the interface, and the Scenario uses them as a fixed input. Supported value types include text, rich text, number, date, date range, list selection, and email. An attachment can also be added as a reference document, but it is not used by the integration itself.
Related Articles
Set Up Scenarios in a Template Interface
Summary: Set up Scenarios in an interface template so BrynQ knows which business flow the template supports, which source data belongs to which target data, and which value mappings users must complete. Requirements: - You need access to Admin portal ...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 ...Interface Concepts and Lifecycle
Summary: Learn what a BrynQ interface is, which states it can have, and how it moves from setup to live use. Requirements: - You need access to Interfaces to view interfaces. - You need the correct permissions to create, edit, publish, or run an ...Create Your First Interface
Summary: Create your first interface in BrynQ by choosing a template or starting a custom interface with BrynQ support. Requirements: - You need access to Interfaces. - You need permission to create interfaces. - Your subscription must still allow ...Use Data Filters in an Interface
Summary: Use Data filters to control which source records are forwarded by an interface. Requirements: - You need access to Interfaces. - You need permission to edit the interface. - The interface must have available source fields for filtering. Use ...