CETerm: Custom remapping hardware keys

Version 1

    Verified Product Versions

    CETerm 5.7

    Applies to: CETerm, CE3270, CE5250, CEVT220 version 4.0 and above




    How do I customize device hardware keys to remap these to a different application operation, host key or escape sequence?



    Although this capability has been available in versions prior to 4.0, it required a special remapping component to be provided by Naurtech support. With version 4.0 or , users can configure the device to re-map any physical keyboard key on the device to any of the following:

    - Another key
    - An application operation such as "Jump to Next Session" or "Print"
    - A host specific key such as "F4" or "Field Exit"
    - An escape sequence such as "Esc[15~"
    - A Script
    - A text string such as "My input string"
    - A NULL or no operation which will prevent use of that key

    This remapping may be configured specific to either a session or specific to an emulation type (such as VT, 5250, 3270 or HTML).

    Follow these steps to remap a hardware key:

    1. From the application menu, select [Session] [Configure]

    2. Go to the "Options" tab and click the "Configure Keybars and Keys..." button

    3. Go to the "Select Keymap" tab. Select the custom keymap to be specific to this particular session, an emulation type (3270, VT, 5250, HTML Web) or external (backward compatibility  for an older KMAPCET.DLL approach). Generally it is recommended that you use an "Emulation" keymap type. The "Unconnected Keymap" is used when the session is not connected to the host.

    4. Go to the "Edit Keymap" tab. Say you want to customize the following key remap:

    F1 ---> "W" key
    Ctrl + 1 ---> "Next live session"
    F5 ---> "Esc[13~" escape sequence (e.g: "\e[13~" (without quotes)
    F8 ---> "Erase Input"
    F9 ---> "my custom input" text string
    Up Arrow ---> disable

    5. From the "Keymap" dropdown list, select the type of keymap you want to customize. For example, for an emulation specific keymap, (selected in 3 above) for a VT host session, select the "VT Keymap". There might be some predefined entries which will appear in the keymap table.

    Keymap Table Columns

    Key: This column shows the ASCII character or "Virtual Key" symbol for the remapped key. If a symbol is not available, the key may be shown as a hexadecimal value.

    Flags: This column shows the type of key and modifier keys, which must be pressed.
    V indicates a Virtual Key.
    A indicates "Alt" is pressed with the key.
    C indicates "Ctrl" is pressed with the key.
    S indicates "Shift" is pressed with the key.

    Action: This column shows the action that the remapping invokes. If the key invokes a "Text #" action, the current text is shown.

    6. Select the "New..." button. You will be prompted with a New key dialog.

    6.1 Select the key type to be "Virtual Key"

    6.2 From the dropdown list, select the key you want to remap. In our remap example, (F1 ---> "W"), this selection should be "F1"

    6.3 Check any modifier state key checkboxes. In our custom remap example, none of these will be check for the F1 --->"W". The "Ctrl" checkbox will be checked for the remap Ctrl + 1 ---> "Next live session"

    6.4 In the "Action" dropdown, Select the new action that the key is being remapped to. In our remap example (F1 ---> "W"), this should be a "W"

    6.5 Click OK. This remap will be displayed in the table.

    6.6 To remap a key to an Escape sequence or text string, select the Action "Text n" (where n is the number between 1 and 65). This will result in a edit box appearing, where you can specify the custom text string.

    Text strings may contain special escape sequences for VT or sequences of actions:

    \r - return
    \t - tab
    \e - ESC for VT sequences
    \x5a - hexadecimal value
    \IDA_action - invoke action

    The IDA_action text is defeined for Naurtech TE and Browser products only. This allows users to invoke almost any application operation or event. Please contact us if you have a specific need and are looking for a particular IDA_action reference

    Follow steps 6.1 through 6.5 to remap other keys. To disable a key, you can map it to a "Null" Action.

    7. Click OK. Connect to the host application and invoke the remapped keys to test the remap.


    Additional Information