Set Up Scenarios in a Template Interface

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 and permission to manage Interface templates. - The template must have an editable draft. If the template version is read-only, use Create draft or Continue draft in the template header first. - The template must already have source and target apps, because scenarios use the fields from those apps.

Set Up Scenarios in a Template Interface

Scenarios describe what BrynQ should do for one business flow in a template, such as creating employees, updating contracts, or syncing absence records.

Why scenarios are important

  • A Scenario groups the fields, rules, and mappings for one result. This keeps different flows separate, so users do not mix fields for unrelated actions.
  • A scenario row tells BrynQ: read this value from the Source fields, write or compare it against this value in the Target fields, and use Mapping when the values are named differently.
  • Scenario setup is part of the template. Users who create an interface from the template see these scenarios later and complete only the values or mappings that still need customer-specific choices.

Open the Scenarios step

  • In the left navigation, open Admin portal.
  • In Admin portal, open Interface templates and select the template you want to edit.
  • At the top of the template page, open the editable version with Create draft or Continue draft when the current version cannot be edited.
  • In the template step navigation, select Scenarios. The page shows the scenario list on the left and the scenario editor on the right.

Add, select, or reorder scenarios

  • At the bottom of the left scenario list, click Add new scenario to add a scenario to the draft.
  • In the left scenario list, select a scenario name to edit its details on the right.
  • Use the drag handle on the left side of a scenario name to change the scenario order. This order is shown to users when they configure an interface from the template.
  • Use the three-dot menu on the right side of a scenario name and choose Delete scenario when the scenario should be removed from the template.
  • If the warning icon shows This scenario has validation errors, open that scenario and complete the missing or invalid setup before publishing the template.

Fill in the scenario header

  • In the top part of the editor, fill in Name of your scenario. Use a short action name, for example Create employee or Update contract.
  • Below the name, fill in Description. Explain when users should use this scenario and what result the flow creates.
  • If Target scheme is shown below Description, select the target scheme that matches this scenario. The selected scheme filters Target fields, so users do not map data to the wrong part of the target app.
  • If you change Target scheme after rows already contain target fields, review the rows again. BrynQ removes target fields and mappings that no longer match the selected scheme.

Configure Scenario Rows

Each row connects source data to target data. A row can also define required behavior, unique matching, transformation, and value mapping.

Understand source fields, target fields, and mapping

  • Source fields are the fields BrynQ reads from the source app. For example, in an HR source app this can be Employee number, Employment status, or Department.
  • Target fields are the fields BrynQ writes to or checks in the target app. For example, in a payroll target app this can be Worker ID, Status, or Cost center.
  • Mapping is the value translation between selected source fields and selected target fields. Use it when the source app and target app use different values for the same business meaning.
  • BrynQ uses the Source fields and Target fields selection to build the mapping table. The source side becomes the input columns. The target side becomes the output columns.
  • A mapping table row is a conversion rule. It tells BrynQ: when the source value is this, use this target value.
  • Example: the source app sends Active, but the target app expects Employed. In the scenario row, choose Employment status under Source fields, choose Status under Target fields, open Mapping, and add Active as the source value with Employed as the target value.

Choose source and target fields

  • In the row header, use Source fields to choose the data BrynQ reads from the source app.
  • Next to it, use Target fields to choose the data BrynQ writes to the target app.
  • In each field selector, use the field type menu to choose the kind of value:
  • Library field for standard fields from the selected app.
  • Configuration field for answers from the template Configuration step.
  • Custom field when the interface user may select a customer-specific field later.
  • Fixed value when the same value should always be used.
  • Empty value when the row should intentionally send no value.
  • Between rows, click the plus button to add a row directly below the current row.
  • On the right side of a row, use the trash button to delete a row that should not be part of the scenario.

Configure Mapping and Must fill

  • In the Mapping column, click the mapping button to open the Mapping window for that row.
  • In Mapping, add conversion rows when source values must be translated into different target values, such as Active to Employed, Inactive to Terminated, or Temporary to Fixed term.
  • Use Value mapping strategy when BrynQ should compare source values in a less strict way. For example, choose a strategy that ignores case when active and Active should be treated as the same value.
  • Use Set all unmapped values as when values that are not listed in the mapping table should receive one default target value.
  • Turn on Lock mapping for additions when the template mapping is complete and users should not add extra mapping values while configuring an interface from the template.
  • Turn on Must fill for a row when the interface user must complete or confirm the row mapping before the interface can be finished.
  • Leave Must fill off when the mapping is helpful but not always required.
  • Mapping is disabled for Fixed value and Empty value fields, because those values do not need a source-to-target conversion table.

Mark Unique key and Required rows

  • On the right side of a row, use Unique key when the field helps BrynQ match source records with target records. A scenario normally needs at least one unique key so BrynQ can compare records safely.
  • Use Required when the row must be present for the interface to work correctly.
  • If the selected target field is required by the target app, BrynQ turns on Required automatically and the button cannot be turned off.

Add Logic and Transformation

  • At the left side of a row, expand the row with the arrow button when you need extra settings.
  • In the expanded row, use Logic for short implementation notes or business rules that explain how the row should be handled.
  • Use Transformation when one or more source fields need a specific handling method:
  • Automatic (based on relation) lets BrynQ choose the behavior from the relation between source and target fields.
  • Concatenate combines source values.
  • Fill in order maps source fields to target fields by position.
  • Keep source fields keeps the selected source fields unchanged.

Review and Save the Scenario Setup

BrynQ saves scenario changes automatically while you work in the draft.

Check the draft before publishing

  • In the left scenario list, check that no scenario still shows This scenario has validation errors.
  • Review each scenario row for the correct Source fields, Target fields, Mapping, Must fill, Unique key, and Required settings.
  • Review other template steps, such as Configuration, Mapping, Variables, and Data filters, before publishing the template.
  • Publish the template only when all scenarios are complete and the draft has no validation warnings.

More Information

Keep each scenario focused on one business flow. If a template supports several flows, create separate scenarios instead of placing every row in one large scenario. This makes the template easier for users to configure and easier for your team to maintain.

    • Related Articles

    • Template Interfaces

      Template Interfaces A Template is the blueprint for an integration between two systems. 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 ...
    • 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. ...
    • Create an Interface from a Template

      Summary: Create a new BrynQ interface by selecting a ready-made template and, when needed, activating the apps used by that template. Requirements: - You need the Create interfaces permission. - Your plan must have space for another interface. - If ...
    • 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 ...
    • 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 ...