Introduction to Button Builder

Button Builder is a tool for configuring physical devices in the Portal. Button Builder allows customization of buttons for specific devices, bulk deployment and application of templates, and the creation of phone directories directly from the User Portal.

Accessing Button Builder

To access Button Builder, navigate to the Inventory page in the Portal, then click on the Phone Hardware tab.

Launch Methods

Button Builder can be launched in two ways. The first is to click the main "Button Builder" button in the top-right corner of the Phone Hardware tab, which opens the Button Builder Launcher modal. The second is to click either the gear icon or the MAC address next to a specific device in the list, which opens Button Builder for that device.

The Button Builder Interface

Launching Button Builder reveals the main configuration page. This interface enables the management of button assignments, directories, and templates. 

Interface Overview

The main configuration page is where all changes are made. Configuring line keys (on the right side of the page) reveals corresponding indicators (on the left side of the page) that indicate which key is being programmed.

Note: Device button numbering may not align with the expected placement on the device. Be sure to check the image for exact placement (see image below).

	MAC address of the specific device you are configuring.
	Displays the device’s brand and model, confirming which phone you are editing.
	Allows you to edit the configuration name for reference.
	The domain name to which the device is assigned.
	The directory source button is used to configure the directory and can be used to change the order, hide contacts, or filter the list.   Note: This will determine what populates when using the cascade tool.
	Apply or edit templates.
	The “Directory” button is also used to configure the directory, including changing the order, hiding contacts, or filtering the list.
	Click the kebab button to reveal the following options:   Additional phone settings: Modify the preferred server and transport method settings, as well as add overrides from the manufacturer’s documentation to change the phone’s behavior.   Edit device profile: Open and edit the device's profile, a configuration set that defines the physical attributes and button layout for a specific device.   View configuration file: View the actual file sent to the phone. If the file doesn’t load, provisioning won’t function.   Apply backup file: If you have a backup, you can use this to upload the relevant file.   Download backup file: Download a backup of the device’s configuration.   Clear all buttons: Delete all button configurations.   Delete configuration: Delete the entire Button Builder configuration.

Save Device Configuration

After making changes to a configuration, there are three options for saving:

• Save: Enables changes to be applied, but those changes will not take effect until the next time the device provisions or resyncs.
• Save and resync: Pushes the changes to the phone immediately. Note: Clicking “Save and Resync” may cause the device to reboot, ending any active calls.
• Save as new template: Save the device configuration as a template for other devices.

4 Configuring Device Buttons

A line key is a physical button programmed to access a registered phone line. This section of Button Builder configures the device’s line keys. Line Appearances can be assigned to line keys (e.g., Line 1, Line 2) using the Line Appearance or Shared Line Appearance feature in Button Builder. Depending on the device model, additional programmable features, such as BLF, Call Park, or speed dial, may also be available.

Button Features

To configure a line key, click on “Select a Feature” next to any unlocked entry. Select one of the features in the dropdown list. Assign the line key a custom label if desired.

The following table describes Button Builder line key configurations:

4.2 Customization Options

Once a feature is selected, Button Builder allows further customization of the button’s appearance and behaviour.

• Custom Label: Add an optional custom label to a button to give it a name that will appear on the phone’s display.
• Lock Button: Prevent the end user from editing or modifying the configuration via the “Cascade Directory” or “Cascade Button Clear” buttons. To re-enable editing and button modification, you must click the unlock button.

Managing the Device Directory

Button Builder enables users to configure and manage the directory displayed on the device.

Setting a Directory Source

The "Directory" button opens the Button Builder Directory modal. Use this modal to select a directory source for the device. From the dropdown menu, choose a directory source such as "All Contacts," "Coworkers," or "Department." You can also edit which contacts appear in the phone's directory.

Cascade and Clear Features

The Cascade Directory feature automatically applies a chosen directory list to the phone’s buttons as Speed Dials. This can be a significant time-saver for populating buttons with multiple users from a single list. When using a Cascade Directory, you have two options:

• Static: After creating a directory, this option automatically fills the button assignments, and all subsequent buttons, with static Speed Dials for the current directory entries. The button assignments will not change even if you add or remove users from the directory.
• Dynamic: This option also fills the buttons as Speed Dials, but the button assignments will automatically update when the phone resyncs.

The two features for clearing button assignments are as follows:

• Clear Button: Delete the assignment for a specific button and reset it to its initial state.
• Cascade Button Clear: Delete the button assignments for the selected button and all the buttons below it.

Configuration Templates

Configuration templates are a powerful tool for managing button assignments across multiple devices, allowing for bulk edits and consistent setups. They are created per model and can be applied to multiple phones at once, saving significant time.

Accessing Configuration Templates

To access the Button Builder Configuration Templates modal, navigate to the Phone Hardware tab within the Inventory page. From the "Button Builder" dropdown menu, select "Manage configuration templates". Clicking "Edit" or "Add" opens the main configuration page.

Alternatively, you may navigate to this modal from the main configuration page. Click the "Templates" button, then click the "Add or edit configuration templates" link.

Managing Configuration Templates

Several actions are available within the Button Builder Configuration Templates modal:

Add a new template: Click on the "Add" button to create a new template for a specific device model. Once a template is created, it can be applied to selected devices.

Edit, copy, or delete templates: Select an existing template from the list on the left, then use the "Edit," "Copy," or "Delete" buttons to manage it.

Applying templates in bulk: Select the devices on which the template will be applied. Click the "Button Builder" dropdown button and select "Apply a template to selected devices.”

This opens the Bulk Edit Button Builder Templates modal. Select the configuration template to apply to the devices, click the "Apply" dropdown, and select "Apply and Resync.”