How-to manage SwyxIt! Global Hotkey using SwyxWare PowerShell

SwyxIt! is able to register hotkeys in Windows to trigger actions in SwyxIt! from anywhere in Windows by pressing a keyboard shortcut. There currently is limited support in SwyxWare Powershell to configure these hotkeys. This article gives some hints and example about how to do that.

Prerequisites

The following examples assume that you have a user object in variable $u. To do that, use something like this:

$User = get-ippbxuser -Username Alice

To use the examples in a pipeline use the usual mechanisms, e.g. getting multiple users, pipe them to foreach-object. This will not be explained here.

The examples do not use aliases to shorten commands.

Configuring Keyboard shortcuts for speed dial key

To configure keyboard shortcuts for speed dial keys use the

Get-IpPbxSpeedDialKey and

Set-IpPbxSpeedDialkey cmdlets.

To find the scan code to use for a hotkey, see below.

Configuring Keyboard shortcuts for SwyxIt! commands

Getting current hotkey configuration

PS>$UserData = Get-IpPbxUserData -UserEntry $User
PS>$UserData.m_HotkeySettings | format-table

Dirty IsRegistered Command ScanCode Key Alt Shift Ctrl
----- ------------ ------- -------- --- --- ----- ----
True False 32808 0 0 0 0 0
True False 35200 0 0 0 0 0
True False 35100 0 0 0 0 0
True False 35101 0 0 0 0 0
True False 35102 0 0 0 0 0
True False 35103 0 0 0 0 0
True False 35104 0 0 0 0 0
True False 35105 0 0 0 0 0
True False 35106 0 0 0 0 0
True False 35107 0 0 0 0 0
True False 35108 0 0 0 0 0
True False 35109 0 0 0 0 0
True False 35110 0 0 0 0 0
True False 35111 0 0 0 0 0
True False 35112 0 0 0 0 0
True False 36401 0 0 0 0 0
True False 35222 0 0 0 0 0
True False 35223 0 0 0 0 0
True False 35210 0 0 0 0 0
True False 35211 0 0 0 0 0
True False 32825 0 0 0 0 0
True False 35212 0 0 0 0 0
True False 35203 0 0 0 0 0
True False 32827 0 0 0 0 0
True False 32828 0 0 0 0 0
True False 32809 5701633 122 0 0 1
True False 35235 0 0 0 0 0
True False 35238 0 0 0 0 0
True False 35239 0 0 0 0 0
True False 35240 0 0 0 0 0
True False 35241 0 0 0 0 0
True False 35230 0 0 0 0 0
True False 32826 0 0 0 0 0
True False 35229 0 0 0 0 0
True False 35217 0 0 0 0 0
True False 35234 0 0 0 0 0
True False 32829 0 0 0 0 0
True False 35206 0 0 0 0 0
True False 35227 0 0 0 0 0
True False 35228 0 0 0 0 0
True False 32817 0 0 0 0 0
True False 35204 0 0 0 0 0
True False 35218 0 0 0 0 0
True False 35219 0 0 0 0 0
True False 35220 0 0 0 0 0
True False 35215 0 0 0 0 0
True False 35214 0 0 0 0 0
True False 32902 0 0 0 0 0
True False 32789 0 0 0 0 0
True False 32790 0 0 0 0 0
True False 57665 0 0 0 0 0
True False 32932 1966081 65 0 1 1
True False 32962 2293761 72 0 1 1
True False 32963 0 0 0 0 0
True False 32964 2162689 70 0 1 1
True False 32965 1572865 79 0 1 1

Relevant for setting hotkeys are the following properties of the m_HotkeySettings items:

List of commands:

Assign hotkey to a command

To set a hotkey, e.g. Ctrl+Shift+H to hold a call, do the following:

1. Lookup the command ID in the table above, e.g. 35222 for "Hold"
2. Find the scan code of the keyboard shortcut you want to set (see below)

3. Get the current hotkey configuration array, update the entry for the command and save

$UserData = Get-IpPbxUserData -UserEntry $User
$HotkeyConfig = $UserData.m_HotkeySettings | where Command -eq 35222
$HotkeyConfig.ScanCode = 2293761
$HotkeyConfig.Shift = 1
$HotkeyConfig.Ctrl = 1
Set-IpPbxUserData -UserEntry $User -UserData $UserData

Remove Hotkey from a command

To remove a hotkey, e.g. from "Hold" command, do the following:

1. Lookup the command ID in the table above, e.g. 35222 for "Hold"

2. Get the current hotkey configuration array, remove the key config from the entry for the command and save

$UserData = Get-IpPbxUserData -UserEntry $User
$HotkeyConfig = $UserData.m_HotkeySettings | where Command -eq 35222
$HotkeyConfig.ScanCode = 0
$HotkeyConfig.Shift = 0
$HotkeyConfig.Ctrl = 0
$HotkeyConfig.Alt = 0
Set-IpPbxUserData -UserEntry $User -UserData $UserData

How to determine the scan code

There is no easy way to determine the scan code via PowerShell, because it's a keyboard device specific code. As a workaround do the following:

1. With SwyxIt configure for the logged in user, e.g. "Alice", one SwyxIt! hotkey with the keyboard configuration you want to use,  e.g. use "Logoff" 
2. Find the command in the list above (Logoff = Command 32790)
3. Look up the current config with
   (get-ippbxuser -username "Alice" | Get-IpPbxUserData).m_Hotkeysettings | where Command -eq 32790 
4. Note the scancode property.