Overview
Function Keys provide Transact users with the ability to use function key shortcuts on the Review and Validate screens to run custom scripts. Transact batch class administrators can assign a custom script to a function. Then, operators can quickly run the script by pressing a specific function key when reviewing and validating batches.
Prerequisites
Transact batch class administrators can associate a function key to a custom script specified in the ScriptFunctionKey.java file. To access an example ScriptFunctionKey.java file and for more information on configuring it, please refer to Scripting Guide – FunctionKey.java.
Characteristics
- A function key can only be associated with one method, but the same method can be run by multiple function keys.
- Function keys can be any function key except F1, F5, and F12. This prevents Transact function keys from conflicting with browser shortcuts.
- Function keys will only be displayed on the Review and Validate screens if the selected Document Type has function keys configured for the batch class.
Keyboard Shortcuts
The following table lists all keyboard shortcuts that are supported in Transact. Keyboard shortcuts that are customizable are noted in the Customizable column.
Function | Customizable | Default Shortcut Key |
Save | Ctrl + E | |
Quick Save | Yes | Ctrl + Q |
Split | Ctrl + 2 | |
Zoom-in | Yes | Ctrl + 1 |
Zoom-out | Yes | Ctrl + Shift + 1 |
Move the cursor to the next field | Ctrl + ] | |
Move the cursor to the previous field | Shift + Tab | |
Move the cursor to the next error field | Ctrl + > | |
Duplicate Page | Ctrl + D | |
Fit to Page | Yes | F12 |
Rotate Page Clockwise | Yes | Ctrl + R |
Rotate Page Anticlockwise | Yes | Ctrl + Shift + R |
Remove Page | Ctrl + Delete | |
Focus on document types | Ctrl + | |
Merge document with the previous one | Ctrl + / | |
Merge multiple documents | Ctrl + Shift + / | |
Next Batch | Ctrl + Shift + > | |
Insert a row below a different table row | Ctrl + I | |
Insert a row above a different table row | Ctrl + Shift + I | |
Delete a row in table | Ctrl + J | |
Delete all rows in the table | Ctrl + U | |
Traverse the table | Ctrl + K | |
Insert data manually | Ctrl + Y | |
Move an image to the left | Shift + left arrow | |
Move Image Right | Shift + right arrow | |
Move Image Up | Shift + up arrow | |
Move Image Down | Shift + down arrow | |
Next Document | Ctrl + M | |
Previous Document | Ctrl + Shift + M | |
Next Page | Yes | Ctrl + P / 3
Move to next page with either: Ctrl + P or Ctrl + 3 |
Previous Page | Yes | Ctrl + Shift + P / 3
Move to previous page with either: Ctrl + Shift + P or Ctrl + 3 |
Enable/Disable Field Value Change Script | Ctrl + [ | |
Update Document | Ctrl + Shift + C | |
Delete Document(s) | Shift + Delete | |
Toggle Column Validations while Manual Extraction | Ctrl + ‘ | |
Open External Application | Ctrl + 6/7/8/9 | |
Disable/Enable Page Jumping on Field Change | Ctrl + Shift + | |
Focus on Fuzzy Search Box | Ctrl + ~ | |
Move Cursor to previous Error Field | Ctrl + < | |
Open/Close Table View | Ctrl + 5 | |
Zoom Lock/Unlock | Ctrl + L | |
Apply Validation Pattern On/Off | Ctrl + B | |
Open Document Pages | Ctrl + Shift + o | |
Close Batch | Ctrl + Backspace | |
Line item matching | Ctrl + Shift + Y | |
Pop Out Image | Ctrl + Shift + D | |
Zoom Overlay Image | Ctrl + Shift + X | |
Learn Files | Ctrl + Shfit + 4 | |
Suspend/Resume | Ctrl + Shift + S | |
Fuzzy DB Look-Up | Ctrl + ; | |
OCR/Image View | Ctrl + Shift + F |
Customizing Keyboard Shortcuts and Language Codes
You can create custom keyboard shortcuts for up to four levels of support:
- Application-wide
- Language-wide, when the corresponding language is set in the browser
- A single batch class
- A single batch class, using the language set in the browser
The table below provides additional information on each support level and the location of the properties file you will need to modify for customization, if applicable.
Keyboard Shortcut Type | Level of Specificity | Description | Properties File Format |
Default | Application-wide | Built-in shortcuts available by default | None |
Application Shortcuts | Most general (least specific) | Will apply to all batch classes | [SharedFolders]shortcut-keysShortcutKeys.properties |
Language-specific Application Shortcuts | Will apply to all batch classes where user’s browser is set for the specified language | [SharedFolders]shortcut-keysShortcutKeys-[lang-code].properties
See language codes below |
|
Batch Class Shortcuts | Will apply to a single batch class | [SharedFolders][batch-class]shortcut-keysShortcutKeys.properties | |
Language-specific Batch Class Shortcuts | Most specific | Will apply to a single batch class, where the user’s browser is set for the specified language. | [SharedFolders][batch-class]shortcut-keysShortcutKeys-[lang-code].properties |
Note:
- More specific keyboard shortcuts will always override less specific shortcuts. For example, a keyboard shortcut that is defined for a batch class will override a keyboard shortcut that is defined for the application level.
- A language-specific keyboard shortcut (French, for example) will always override the default shortcut, when the user’s browser is set to that language.
Supported Country Codes
Transact integrates support for the following country codes. You can use these codes to override the default settings in the properties file.
Language Code | Description | Notes |
en | English | Default if no other language is specified. |
es | Spanish | |
fr | French | |
de | German | |
nl | Dutch | |
it | Italian |
Keyboard Shortcut Properties File Format
Each line has four items separated by the pipe ( | ) symbol. The following line illustrates this syntax convention:
binding=modifiers|keycode|Description
Where:
- binding — These are predefined as in the sample cited below. Only those bindings are supported.
- modifiers — For any combination of Ctrl + Alt + Shift, leave empty for no modifiers. You can also use Ctrl, Shft, or Control.
- keycode — These are JavaScript native keycodes that you can get from the following resource: https://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes
- Description — This is the text to be displayed in the Shortcuts dropdown menu on the Review and Validation screens.
The following line is an example:
reviewValidate.ZoomIn=shift+ctrl+alt|83|Shift + Ctrl + Alt + S
Note: If you omit or override a setting, then the default shortcut is used. You can “comment out” a line by starting that line with a # symbol.
The following lines illustrate a sample properties file for keyboard shortcuts:
# ctrl+shift+alt|keycode|human readable keys reviewValidate.RotateClockwise=ctrl|105|APP Ctrl + NUM 9 reviewValidate.RotateAnticlockwise=ctrl|103|Ctrl + NUM 7 reviewValidate.ZoomIn=ctrl|104|Ctrl + NUM 8 reviewValidate.ZoomOut=ctrl|98|Ctrl + NUM 2 reviewValidate.FitImageToPage=ctrl|101|Ctrl + NUM 5 reviewValidate.NextPage=ctrl|102|Ctrl + NUM 6 reviewValidate.PreviousPage=ctrl|100|Ctrl + NUM 4 reviewValidate.QuickSave=ctrl+alt|83|App Ctrl + Alt + S
Adding Function Key Mapping
- From the Batch Class Management screen, select the batch class and click Open.
- Expand the Document Types folder, then expand the Document Type.
- Click the Function Key Mapping configuration.
- Click Add.
- Enter the following fields: Method Name, Method Description, and Shortcut Key. Refer to the table below for descriptions on these fields.
Column Name | Description |
Method Name | The name of the method. This must match the method name in your FunctionKey.java file. |
Method Description | A description of the method executed in the script. |
Shortcut Key | The function key associated with the method. |
Note: You can press the function key on your keyboard that you want to associate with the Shortcut Key. In this example, F2 is used.
- Click Apply.
- The Batch Class updated successfully message will appear.
Running a Script Using Function Keys
On the Review and Validate screens, you can run a script two ways:
- Press the configured function key on your keyboard.
- Click More > Function Key and then select the function key script.
After running the script, the message Executing function key script will appear. When the message disappears, the script has executed.