Transact

  1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Batch Class Management
  6. Batch Class
  7. Function Keys

Function Keys

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.

Adding Function Key Mapping

  1. From the Batch Class Management screen, select the batch class and click Open.
  2. Expand the Document Types folder, then expand the Document Type.
  3. Click the Function Key Mapping configuration.
  4. Click Add.

  1. 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.

  1. Click Apply.

  1. 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:

  1. Press the configured function key on your keyboard.
  2. 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.

Was this article helpful to you? Yes No