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 source and target apps used by the interface must be active.
- The variables window appears only when the live interface version has variables.
Use Variables When Running an Interface
Variables let you provide values that can change before a manual run starts.
Know when variables appear
- Open Interfaces from the sidebar.
- Find the interface you want to run.
- Select Run when the interface is Idle.
- If the live interface has variables, BrynQ opens the Run interface window before starting the run.
- If the live interface has no variables, BrynQ starts the run without showing the variables window.
Review the variable details
- Name shows which variable you are setting.
- Description explains what the variable is used for. If no description is available, BrynQ shows that there is no description.
- Value is where you enter the value for this run.
- The Value field can show the default value as placeholder text.
- Leave a value empty when you want BrynQ to use the default value.
Start a Run With Variable Values
Enter only the values that should be different for this run.
Fill in the values
- In the Run interface window, review each variable.
- Enter a custom value in Value for each variable you want to change.
- Keep the spelling, date format, number format, or code exactly as the interface expects.
- Leave variables empty when the default value should be used.
- Select Run.
- BrynQ queues the interface run and sends the entered values with the run.
Check the result
- Wait until the run has finished.
- Open View logs if you need to check what happened during the run.
- If the run used the wrong value, run the interface again with the corrected value.
- If the default value is wrong, update the Variables tab in a draft and publish the draft.
Troubleshooting
Use these checks when variables do not work as expected.
The variables window does not open
- Check whether the interface has a Live version.
- Check whether the live version includes variables.
- If the interface has no variables, BrynQ starts the manual run directly.
- To add or edit variables, create or open a draft, update Variables, and publish the draft.
You cannot start the run
- Check that you have permission to run the interface.
- Check that the interface is Active and Idle.
- Check that the source and target apps are active.
- If the interface is already running or stopping, wait until it returns to Idle.
- If your workspace has reached the manual run limit, ask an administrator for help.
A value is not accepted or gives the wrong result
- Check the variable Description for the expected value.
- Use the exact format the interface expects, for example a date, number, ID, or app-specific code.
- Check for extra spaces before or after the value.
- Leave the field empty if the default value should be used.
More Information
Variables are useful for values such as date ranges, reporting periods, import batch IDs, or other settings that can change between manual runs. The values you enter are sent with the run; to change the default value shown to users, update the Variables tab in a draft and publish it.
Related Articles
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 ...
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 ...
Create Your First Interface
Summary: Create your first BrynQ interface by choosing a template or starting a custom interface with BrynQ support. Requirements: - You need Create interfaces permission. - The source and target apps must be active before you can use a template. - ...
Rename, Deactivate, and Reactivate an Interface
Summary: Rename an interface, deactivate it when it should not run, and reactivate it when it is ready to use again. Requirements: - You need access to Interfaces. - You need Edit interface permission for the interface you want to change. - The ...
Rename, Deactivate, and Reactivate an Interface
Summary: Rename an interface, deactivate it when it should not run, and reactivate it when it is ready to use again. Requirements: - You need access to Interfaces. - You need Edit interface permission for the interface you want to change. - The ...