Summary: Add variables to an interface so users can change selected values before a manual run without editing the interface setup.

Requirements: - You need access to Interfaces. - You need permission to edit the interface. - The interface must have an editable draft version before you can change variables.

Add Variables to Interfaces

Variables are reusable values that BrynQ can read when an interface runs. Use them for values that may change from run to run, such as a reporting period, company code, department, file name, or other setting that should not be fixed inside the interface logic.

Understand how variables work

• A Name identifies the variable in the interface logic. The name is required and should be short, clear, and stable.
• A Default value is the value BrynQ uses when the user does not enter another value before a manual run. This field is required.
• A Description explains what the variable controls. This field is optional, but it helps users choose the right value when they run the interface.
• Variables only affect a run when the interface logic uses the variable Name. Adding a row on the Variables page does not change the result by itself.

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 or read-only, use the action area at the top of the interface editor to open or create an editable draft before changing variables.

Add a 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 name that the interface logic can recognize, for example month, company_code, or file_name.
• In the Default value column, enter the value BrynQ should use when no custom value is entered before a manual run.
• In the Description column, explain what the variable is used for and what kind of value the user should enter.
• When you start filling the row, BrynQ adds a new empty row below it. Use that row only when you need another variable.
• Wait until the auto-save status shows that the changes are saved. The Variables page saves changes automatically.

Add more variables

• Use the empty row at the bottom of the variables table to add another variable.
• Fill in Name and Default value for each variable. Add Description when users need context before running the interface.
• Keep each variable focused on one value. For example, use one variable for start_date and another variable for end_date instead of putting both dates in one field.
• Avoid changing a variable Name after it is used in the interface logic. The run may fail or use the wrong value if the logic still expects the old 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.
• Remove a variable only when the interface logic no longer uses it. If the logic still reads that variable name, the next run may fail or use incomplete data.

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 changing the saved interface setup.

Enter values before a run

• From the Interfaces overview, find the interface you want to run.
• In the interface row action area, click Run. If the interface has variables, BrynQ opens the Run interface window.
• Read the text at the top of the window. It explains that you can enter values for variables you want to overwrite, or leave them empty to use the default values.
• In the table, review Name, Description, and Value.
• In the Value column, enter a custom value only for the variables you want to overwrite for this run.
• Leave Value empty when BrynQ should use the variable's Default value.
• Click Run in the action area at the bottom of the window to start the interface with those values.

Choose useful variable values

• Use the format expected by the interface logic. For example, enter a date, code, or text value exactly as the interface was built to read it.
• Check Description 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

Example: an interface imports payroll data for one month. You can add a variable named month with the default value 2026-06 and the description Payroll month in YYYY-MM format. During a manual run, users can leave Value empty to run June, or enter 2026-07 to run July without editing the interface setup.

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.