Bitfocus AS
logo
logo
Bitfocus AS
logo
logo
Sign upSign in

Loading...

Bitfocus

Subscribe to our newsletter

The latest news, articles, and resources, sent to your inbox.

FacebookInstagramGitHubYouTubeLinkedIn

Products

  • Buttons
  • Companion

Integrations

  • Supported Devices
  • Developer Community
  • Connection Development

Support

  • Support Overview
  • Documentation
  • Video Tutorials
  • Community Forum

Sales

  • Resellers & Integrators
  • Buttons Pricing

Updates

  • Case Studies
  • Events & Trade Shows
  • Press Releases
  • Product Updates
  • Webinars

Legal

  • Legal Overview
  • Privacy Policy
  • Buttons EULA
  • Terms & Cookie Policy

Company

  • About us
  • Press kit
  • Careers

© 2026 Bitfocus AS. All rights reserved.

Use variables
Docs for
Overview
Getting started
What is Bitfocus Buttons?
Install Buttons and get started
Manage your Buttons license
Activate Buttons offline
Find your way around Buttons
Create your first backup
Add an ATEM connection
Choose a control method
Choose an installation path
Install Buttons on Debian or Ubuntu
Understand HA clustering
Kubernetes HA
Update or remove Buttons
Positions
Understand positions
Create a position
Add controls and sections to a position
Create your first button
Use a connection's presets
Build more capable button actions
Add more feedback to a button
Organize controls in a section
Shift Section
Organize controls with a Folder Section
Add a Popover Section
Build and reuse a Shared Section
Build a Router Section
Understand Custom Routers
Custom Router panel
Surfaces
Surface compatibility
Add and attach a surface
Device orientation
Connections
Update a connection's module safely
Monitor and troubleshoot a connection
Router integrations
VideoHub and AJA KUMO
Utah Scientific BPS
Generic SW-P-08
Nevion VideoIPath
Arkona BLADE//runner
Routing
Physical routing
Configure ports and labels
Take a physical route
Understand route status
Topology graph
Routing Presets
Get started with virtual routing
Configure Nested Shapes
Reverse routing
Tielines
Routing Projects
Routing settings
Troubleshoot a route
Tally
Understand the Tally system
Send ATEM tally and labels to a UMD
Interpret Active Tally state
TSL/UMD connections
Diagnose tally problems
NMOS
Understand NMOS in Buttons
Connect Buttons to an NMOS Registry
Built-in Registry Server
Configure NMOS connections
Discover and adopt
Browse the NMOS inventory
Manage NMOS multicast addresses
Diagnose NMOS problems
Understand Cuelists
Build a Cuelist
Read and advance a running Cuelist
Control a Cuelist from a Position
Workflows
Understand workflows
Build your first workflow
Reuse a group of workflow nodes safely
Troubleshoot a workflow
Recipes
Sequence a timed automation
Call an HTTP endpoint from a workflow
REST endpoint
Use variables
Understand variable scope
Understand nested variables
Update expressions for v1.8
Plan and use Tags
Access
Create and manage users
Create roles and assign permissions
Grant access to specific resources
Show different controls by role
Sessions
Set up PIN and NFC sign-in
SSO
Get started with SSO
Connect a generic OIDC provider
Connect LDAP or Active Directory
Map identity claims to roles
Secure a Buttons deployment
Integrations
External control
Connect to Bitfocus Listener
USB Relay
Install USB Relay on Windows
Install USB Relay on macOS
Install USB Relay on Linux
Install USB Relay on a Raspberry Pi
Get started with the Control API
Secure and monitor the Control API
Control API reference
API reference
Administration
Enable and manage installable features
Services and health
Configure and monitor scheduled backups
Restore a backup and verify it
Export or import Buttons configuration
Store and rotate connection secrets
Replace the HTTPS certificate
HA backup and recovery
Settings
Collect support information
Reference
Glossary
Button Inspector reference
Network ports reference
Expressions
Internal actions reference
Routing Presets panel reference
Startup configuration reference
Workflow nodes
Connection workflow nodes
Workflow workflow nodes
Internal workflow nodes
Position workflow nodes
API workflow nodes
Utility workflow nodes

Loading...

Previous
← REST endpoint
Next
Understand variable scope →
Contact support →
You are viewing documentation for Buttons 1.8.See the docs for Buttons 1.6
Buttons/Variables/Use variables

Use variables

Once you understand where a variable is visible, using one is the same everywhere in Buttons: browse for it, insert it, and optionally transform it with an expression.

Before you begin#

  • A variable already defined, see the scope-specific steps below if you haven't created one yet.

Create a Self or Parent variable#

  1. Select the button or section that should hold the variable.
  2. Open its Variables inspector section.
  3. Under Self, add a variable and give it a value: it's visible only inside this element.
  4. Under Parent, add a variable if this element needs to expose a value to whatever contains it: it becomes a Self variable of the parent instead of this element.

Create a Position Variable#

  1. Open the position's own configuration, or any element's inspector inside it.
  2. Add a Position Variable and choose its type.
  3. Set its value for this position. Each position that uses this variable needs its own value set independently.
To use a Position Variable to swap which connection a control targets, set its type to Connection, then use the Set Position Variable Internal Action on a button to change it at runtime.

Create a Workflow Variable#

  1. Open Workflow, and open or create a Workflow.
  2. Drag a Workflow Variable node onto the canvas.
  3. Give it a Variable Key: this is the individual variable's own key, separate from the Workflow's own Variable Key (which defaults to the Workflow's name and is used for other purposes on the Workflow itself).
  4. Set Type: String, Number, or Boolean.
  5. Set an Initial Value, or turn on Persist Value to keep the variable's current value across a restart instead of resetting to its initial value.
  6. Select Apply.
Change its value from anywhere using the Set Workflow Variable Internal Action.

Find and insert a variable#

Most text fields in the inspector have a small folder icon at the end. Selecting it opens the variable browser, organized by scope: Self, Parent, Position, and any Connection or Workflow variables available to you. Select a variable to insert it as a label or as an action's value.

Transform a variable with an expression#

When a variable's raw value isn't quite what you need, use an expression instead of the variable directly:
  1. Open the expression editor from the same field you'd insert a variable into.
  2. Reference the variable inside the expression, and combine it with functions as needed. For example, concat combines several strings and variables into one value.
The expression editor suggests available functions and variables as you type, so you don't need to remember exact syntax.

If you get stuck#

What you see
What to try
Two variables seem to conflict, or one shows the wrong value.
Check their scope: a Self variable in one element and an identically-named Self variable in another are never actually the same variable.
A Position Variable shows a different value than you expect.
Confirm you're looking at the right position: the definition is shared, but each position holds its own independent value.
A Workflow Variable resets after a restart when you expected it to keep its value.
Turn on Persist Value for that variable.
You can't find a variable you know exists.
Open the variable browser (the folder icon) and check under the scope you expect it in: Self and Parent variables only appear while you're inside the right element.

Where to go next#

  • Understand variable scope.
  • Understand nested variables.
  • Expression functions and operators reference.

Was this helpful?

Was this helpful?

0 of 0 users found this page helpful