Special Key Pattern



This setting controls the pattern Genie uses to detect "special" function key labels on screen when creating links/buttons for function keys.  Special keys include Enter, Page Up/Down, Help and Print.  For normal function keys (the F1-F12 keys) see Function Key Pattern.

This setting causes Genie to search each field on the screen for a matching pattern.  If your key label spans multiple fields, use the Special Key Pattern2 feature instead.

Default Setting:

pui["special key pattern"] = "^(Enter|PageUp|PageDown|Rollup|RollDown|PgUp|PgDn|Help|Print)([=-])(.*)$";



The default pattern locates the words Enter, PageUp, PageDown, etc, followed by a separator (equal sign or dash), followed by the text. The parenthesis shown are used to "capture" the different parts (key name, separator and text) so that the appropriate words can be placed on the resulting buttons or links that Genie places on the screen.

By defining a different pattern in your custom.js file, you can change the strings and separators that Genie searches for.

By default, the key name found must be a valid parameter to the pressKey API.  However, you can also map different key names to 5250 keys using the Special Key Map feature.



Alternate Syntax
pui["special key pattern"] = /^(Enter|PageUp|PageDown|Rollup|RollDown|PgUp|PgDn|Help|Print)([=-])(.*)$/i;

The alternate syntax is available after Profound UI V6 FP2.0. It permits you to set the pattern to a RegExp object, allowing you to avoid confusion escaping certain characters, such as the backslash (\).