About Records - How to map fields inside a scenario

About Records - How to map fields inside a scenario

Records : Mapping fields


Info
Records are the rows in the scenarios. Each record tells BrynQ what field from the source system should map to what field in the target system.

What are records
 
How to add a record (new fields to mapped)
How to add a new record to a scenario in your interface
Steps:

1. Go to interfaces
2. Open the interface
3. click 'create' draft
4. Go to the scenarios Tab
5. select the scenario of interest
6. add a record by using the 'template' record on the bottom - select the fields you wish to connect in here.
7. if you are happy with the interface draft: publish + confirm 

Note; steps 1-3 and 7 do not need to be repeated consecutvily for each added records, you can add multiple records in one draft by repeating step 5-6 and publish them at once.


FAQ

After adding and publishing a new record, will the interface run immediately, meaning, will data be transferred from the source to the target system?

No. Publishing the interface does not trigger a synchronization. The interface will only run when you manually press the Run button, or when it is set to run on a schedule.


Can I add a record to a Scenario that is currently running on a schedule?

Yes. Adding a record requires entering Draft mode, which does not interrupt or affect any scheduled runs. The new record will only take effect once the draft is published. Any scheduled runs that execute before you publish will continue to run based on the previous published version of the interface.

Note: If a scheduled run happens to be actively executing at the exact moment you publish, that run will complete using the version it started with. The new version will be picked up from the next scheduled run onwards.


What is the difference between adding a record and adding a field to an existing record?

A record defines a mapping between one or more source fields and one or more target fields. Adding a record introduces an entirely new mapping, a target field that was not mapped before will now receive data.

Adding a field to an existing record means extending an existing mapping. For example, if a record already maps First Name to Full Name, you could add Last Name to that same record so that both fields combine into the same target field.


Can two records in the same Scenario target the same field?

No. Each target field can only be used in one record per Scenario. If you try to use the same target field twice, BrynQ will show the warning: "The same library field cannot be used multiple times as a target field in this scenario." If you want multiple source fields to feed into the same target field, add them to the same record instead.


Can multiple source fields feed into the same target field?

Yes. A single record can have multiple source fields on its source side. The record's Logic and Transformation settings determine how those source values are combined into the target — for example, concatenating First Name and Last Name into Full Name. Use this approach when you want to enrich one target field rather than create a separate mapping.


After adding a new record, will it apply retroactively to data that was already synced before?

No. A newly added record will only affect data from the next synchronization run onwards. Data that was synced before the record was added is not retroactively updated.


Can I undo a record I just added if I haven't published yet?

Yes. Until you publish, all changes exist in the draft only, the live version remains untouched. You can delete the record or discard the entire draft, and the live interface will continue running exactly as before.


What happens to data already in the target system if I delete a record?

Nothing in the target system is removed. Deleting a record stops future runs from writing to that target field, but any data BrynQ has already sent to the target system remains there. BrynQ does not reach back into the target system to clean up previously synced data.


Can I temporarily disable a record without deleting it?

Yes. Click the pause icon on the right side of the record row to disable it. The record moves to an Inactive section and is preserved with all its settings, but the Scenario will stop syncing it. You can re-enable it at any time to resume syncing.


The source field I want to map is not showing up, what should I do?

The field picker only shows fields that exist in the source app's published schema. If a field is missing, either it has not yet been added to the connector definition (which is an admin-level change), or you can use a Fixed, Custom, or Configuration field type on the record instead of a Library field.


What permission do I need to add a record?

You need Edit access on the interface. Users with view-only access can open the interface but cannot modify records or enter Draft mode.


Why is the Publish button greyed out after I add my record?

This means one or more validation requirements are not yet met. Common reasons are:

  • The Scenario is missing a unique key record.
  • The Authorization tab has unresolved warnings.
  • The same target field is used in more than one record.

Check the tab strip for yellow warning triangles — these point to the tabs where the issue needs to be resolved.



How to adjust a record (example: changing the source field)

Existing records can be changed. You can add, remove, or modify fields within a record.

In the example below, an existing record is edited by replacing one source field with a different source field. The result is that when the interface runs, the target field will now be populated with data from the new source field.

Adjusting a record in a scenario

1. Navigate to the interface
2. Open the interface by clicking on the title
3. Enter draft mode
4. Go to scenarios, select the relevant scenario.
A) add fields
5a. Selecting a field selector on a record allows you to add new fields to existing records.
B) replace fields in a scenario (see gif)
5b.1: remove the older field
5b.2: add new field
6. If you are happy with all the adjustments - publish the interface.


FAQ

After adjusting and publishing the interface, will the interface run immediately — meaning, will data be transferred from the source to the target system?

No. Publishing the interface does not trigger a synchronization. The interface will only run when you manually press the Run button, or when it is set to run on a schedule.


Can I undo changes made to a record after publishing?

Yes. You have two options: you can revert to a previous version of the interface [link], or you can manually undo the changes by entering Draft mode again and reversing them using the steps described above.


Is there a limit to how many fields I can add to a record?

There is no hard limit. However, it is not recommended to add more than 3 source or target fields to a single record unless there is a clear reason to do so.


Will the interface work correctly immediately after I run it following a record adjustment?

This depends on the nature of the change. Minor adjustments are more likely to work straight away, while more significant changes may require testing and further tweaking before the synchronization runs correctly.


If I remove a field from a record, will data already transferred to the target system be deleted?

Not necessarily, but it can have unintended consequences. 
For example, imagine the following mapping is set up:

First Name + Last NameFull Name

On the first sync, this produces:

John + Doe → John Doe

If you then remove First Name from the record, the mapping becomes:

Last NameFull Name

On the next sync, the target field is overwritten with only the last name:

Doe → John Doe becomes Doe

The previously synced value is lost, because the interface now has a different understanding of what Full Name should contain.




How to disable a record

Disabling records

FAQ

What does Disable actually do, is the record deleted forever?

No. Disabling a record is not a permanent deletion. The record moves out of the active table into the Scenario's Inactive section. Its full configuration, source field, target field, mapping, and logic, is preserved. The record simply stops syncing on the next run. You can restore it from the Inactive section at any time.


Why is the pause icon greyed out on some records?

There are two reasons a record may not be disabled:

  • It is the Scenario's unique key (🔑). Every Scenario requires one record marked as the unique identifier, without it, BrynQ cannot tell employees apart. To disable it, first mark a different record as the unique key.
  • It is marked as required. Either the target system requires that field on every record it receives (the sync would fail without it), or the interface was built from a template that defined the record as mandatory. Disabling it would break the interface, so BrynQ greys out the icon.

Will disabling a record delete the data I've already synced to the target system?

No. Disabling a record stops future runs from writing to that target field, it does not delete or roll back data BrynQ has already sent. If you also need the existing values cleared in the target system, you will need to do that directly in the target system itself.


Can I undo a disable before publishing?

Yes. The disable happens in Draft mode, so the live interface remains untouched. Until you click Publish and confirm, you can restore the record from the Inactive section or discard the entire draft to revert all changes.


Can I disable a record while the interface is running on a schedule?

Yes. The change exists in Draft mode only and does not affect scheduled runs until you publish. Any scheduled runs that fire before you publish will continue to sync that field using the previous published version.

Note: If a scheduled run is actively executing at the exact moment you publish, it will complete using the old version. The next scheduled run will pick up the change.


Will the next scheduled run apply my disable retroactively?

No. A disable only affects runs that start after it has been published. Past runs are not re-executed, and historical data already written to the target system remains as-is.


Is there a confirmation step before a disable goes live?

The disable itself is instant inside the draft, the row moves to the Inactive section as soon as you click the pause icon. The safety prompt comes at the point of publishing: BrynQ shows a "Warning! You are about to publish your draft" dialog that you must confirm before any changes go live. Until you confirm, the disable is still reversible.


Can I disable multiple records at once?

Not at the moment, records are disabled one at a time. However, you can disable several records in sequence within the same draft and then publish once, so all changes go live together as a single update.


What is the difference between disabling a record and disabling a whole Scenario?

Disabling a record turns off a single mapping within a Scenario — the rest of the Scenario continues to sync normally. Disabling a Scenario turns off all records within it, stopping the entire data flow for that topic.

Use record-level disable when you want to keep most of the Scenario syncing but skip a single field. Use Scenario-level disable when the entire data flow for that topic should pause.


What happens to the value mapping (conversion table) that the disabled record used?

The value mapping is not affected. Value mappings live on the Mapping tab independently of any specific record. Disabling a record that referenced a mapping leaves that mapping intact and available for other records to use.


Does disabling a record affect the source system in any way?

No. BrynQ only reads from the source system, it never modifies source data or its schema. Disabling a record simply means this Scenario stops reading from that source field on the next run. The field continues to exist in the source system unchanged.

















    • Related Articles

    • Map Fields Between Source and Target

      Summary: Map source values to target values so BrynQ can send the right data to the target app when the two apps use different field values. Requirements: - You need access to the interface you want to configure. - The interface must include a ...
    • About Scenarios - Organizing your interface into topics

      Overview A Scenario is a single delivery route within an interface for one topic. A Template (Interface) is the complete integration. It contains multiple Scenarios. Each scenario has a name and consists of a collection records. A record displays how ...
    • 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 ...
    • 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 ...
    • Complete Template Configuration

      Summary: Complete the setup of a BrynQ template interface by filling in the required tabs, checking the draft, and publishing it when it is ready. Requirements: - You need access to Interfaces. - You need permission to edit and publish the interface. ...