---
title: "Adding a Custom Hotkey in Frameworks"
canonical: "https://kb.myframeworks.com.au/space/CO/30531820/Adding%20a%20Custom%20Hotkey%20in%20Frameworks"
format: markdown
---
# Overview
In Frameworks, you can create custom hotkeys to quickly trigger specific buttons or actions within various screens. This is done by identifying the specific activity area, locating the button element in the UI definition, and configuring a custom site hotkey through the Activity Maintenance menu. Custom hotkeys can use combinations like Ctrl + [Letter] or Ctrl + Alt + [Letter].
> ⚠️ **Important: **This process will apply to all users within Frameworks, not just the individual who created them.
# How to Add a Custom Hotkey
> Macro (include)
## 1. Identify the Activity Area
1. Navigate to the screen where the button you want to add the Hotkey to is located.
2. Right-click on the relevant tab or section heading and choose **Help** > **Support Information**.
3. Note the **Activity **for the specific section (not the whole dashboard if applicable).
> ✅ Refer to [Site Customisation - Find and activity](https://kb.myframeworks.com.au/space/CO/543757629/Site+Customisations#Find-the-Activity-Name) for more information.
## 2. Open Activity Maintenance
1. Click the F**rameworks Menu** then navigate to **System Administration > Screens & Menus > Activity Maintenance** from the navigation tree.
2. Click **Edit **to open the **Activity Definition Finder** window to find the activity you want to customise
3. In the **Activity **field, paste in the activity name you retrieved above and press **Enter** or click **Find**.
4. Click the appropriate **Activity **hyperlink from the results.
> ⚠️ Select the **Device: ALL **activity and** **not the handset or mobile option.
## 3. Create a Hotkey Site Customisation for the Activity
1. Click the **Site Customisation** tab
2. Click **Add** to create a new site customisation entry.
3. From the **Sub Key **drop-down menu, select **Hotkey**.
4. In the **Name** field, you’ll enter the element path: `tableName.buttonName` of the button.
## 4. Find the Element Path
1. Still in Activity Maintenance, click the **UI Definition** tab.
2. To discover what this element path is:
1. Scroll through the page and look for the matching **"title" **of the button you want to apply the hotkey to (Example: Add).
2. At the begging of the line, with the "title" of the button, you will see the **"name"** of the button. This is the **fieldName **part required (example: btnAddShortcut).
3. Scroll up to above the list of "fields" and you will find the **"tableName"**. This is the **tableName **part required (example: ttMenu).
3. Once you have Identify the **table name** and the **button element name** (example: ttMenu.btnAddShortcut), combine them in the format: `tableName.buttonName` and copy it into the **Name** field of the **Site Customisation **tab.
> ✅ **Tip:** Open a notepad app to paste in the table name and element name.
## 5. Assign a HotKey
1. In the **Value** field, enter the desired hotkey.
1. Format examples:
1. `Ctrl + A` → `"a"`
2. `Ctrl + Alt + A` → `"alta"`
> ℹ️ Avoid common shortcuts like Ctrl+S, Ctrl+Z, Ctrl+V, etc.
## 6. Save and Refresh
1. Click **Save** to apply the customisation.
2. Repeat for any additional buttons if needed.
## 7. Apply the Changes
To apply the new Hotkeys to your companies instance of Frameworks, **Log out **and **refresh **the browser.
## 8. Verify the HotKey
1. After refreshing, navigate to the screen where the hotkey was applied.
2. The button will now have a tooltip after the title of the button to indicate the hotkey, for example:
1. **Add (****A****)** indicates that **Ctrl + A **is the hotkey for the Add button on the screen.
2. **Add (****^A****)** inticates thay **Ctrl + Alt + A **is the hotkey for the Add button on the screen.
3. Press the hotkey to test if it activates the correct button.
# Additional Information
> ✅ Refer to [https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28392012](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28392012) and [Site Customisations](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30531106) for more information