Adding Variables to Interfaces

Adding Variables to Interfaces

Summary: Add variables to an interface so users can reuse the same interface with values that can be changed before each run.

Requirements: - You need access to Interfaces. - You need permission to edit the interface. - The interface must have a draft or editable version.

Add Variables to Interfaces

Variables are values that BrynQ can use when an interface runs. Use them when a value may change between runs, such as a period, department, company code, file name, or other setting that should not be fixed inside the interface logic.

Open the Variables page

  • In the left navigation, open Interfaces.
  • Open the interface you want to configure.
  • In the interface editor navigation, click Variables. This opens the page where variable rows are managed.
  • If the interface is live and cannot be edited directly, use the top-right action area to open or create an editable draft before changing variables.

Add the first variable

  • If the page shows Add variables, click Add variable in the center of the page. BrynQ opens the variables table.
  • In the Name column, enter the variable name. Use a short, clear name that explains what the value controls.
  • In the Default value column, enter the value BrynQ should use when no custom value is provided before a run.
  • In the Description column, explain what the variable is used for. This helps users enter the right value when they run the interface.
  • Wait until the auto-save status shows that the changes are saved. The Variables page saves changes automatically.

Add more variables

  • When the variables table is already visible, use the empty row at the bottom of the table to add another variable.
  • Fill in Name, Default value, and Description for each variable.
  • Keep each variable focused on one value. For example, use one variable for a start date and another variable for an end date instead of putting both values in one field.
  • Avoid changing a variable Name after it is used in the interface logic, because the interface may depend on that exact name.

Remove a variable

  • In the variables table, find the row you want to remove.
  • Move your cursor over the right side of the row.
  • Click the trash icon that appears next to the row.
  • Check that the row is no longer needed before removing it. If the interface logic still uses that variable, the next run may fail or use the wrong value.

Use Variables When Running an Interface

Variables can be changed before a manual run. This lets you run the same interface with different input values without editing the interface setup.

Enter values before a run

  • From the Interfaces overview or the interface detail panel, click Run for the interface.
  • If the interface has variables, BrynQ opens the Run interface window.
  • In the Value column, enter a custom value only for the variables you want to overwrite.
  • Leave a value empty when BrynQ should use the variable's Default value.
  • Click Run at the bottom of the window to start the interface with those values.

Choose useful variable values

  • Use values in the format expected by the interface. For example, enter a date, code, or text value exactly as the interface was designed to read it.
  • Check the Description column when you are not sure what a variable controls.
  • Use the default value when you want the normal run behavior.
  • Enter a custom value when this run needs a different period, company, file, or other setting.

More Information

Variables do not replace Scenarios, Mapping, Data filters, or Schedule. They only provide values that the interface can read while it runs. If a variable is not used in the interface logic, adding it to the Variables page will not change the run result.

    • Related Articles

    • Use Variables When Running an Interface

      Summary: Use variables to enter run-specific values before BrynQ starts a manual interface run. Requirements: - You need access to Interfaces. - You need permission to run the interface. - The interface must be Active and have a Live version. - The ...
    • 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 ...
    • Monitor Interfaces from the Overview

      Summary: Use the Interfaces overview to check interface health, recent runs, logs, and run data without opening the full interface editor. Requirements: - You need access to Interfaces. - To open run logs or detailed run information, you need ...
    • 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 ...