General UI for extended algorithms

Overview

An algorithm plugin can be configured through the graphical user interface by entering the plugin's required configuration in JSON format. The following section describes how to use this feature.

GUI steps

1. At the top right of the Algorithms page, click + Algorithm.

   

2. Enter an Algorithm Name.

   Info: This MUST be unique.

3. Enter a Description.

4. Select Extended as the Framework Name and click Next.

   

5. In the second step, Use the Framework Name drop-down to create an instance corresponding with the selection.

6. Based on the Framework Name option, the Algorithm Extension will be populated with default values in the corresponding text area. Provide a valid extension of the corresponding framework in JSON format in Algorithm Extension (Required).

7. Selected framework details and configuration schema will be displayed on the right side of the Algorithm Extension.

8. The Format JSON button is used to format the text from the Algorithm Extension text area into JSON format.

9. The Validate Configuration button will validate the Algorithm Extension format and validate against the selected framework configuration schema.

For a plugin with a specific GUI like Character Mapping or Secure Lookup, their respective GUI will be shown when editing.

For other plugin instances, the user can only modify the description and extension of the algorithm instance from the plugin GUI. The select framework and algorithm name fields will be read-only.

The default selected framework populates the corresponding Algorithm Extension in the text area. When the framework changes, the Algorithm Extension and Schema details will be populated automatically.

If there are any issues with the Algorithm Extension on clicking Validate Configuration, an Error message will appear.

If the Algorithm Extension is valid, a Success message will appear.

A Utility icon on the right top of the Algorithm Extension text area is available to upload and copy the local file reference and to pick an algorithm reference from existing algorithm instances.

The Configuration Helper Utility offers a way to upload a file and receive a reference ID for algorithm extension, or to select an algorithm for copying algorithm name.

In the Configuration Helper Utility, click Select File. Select a file to upload, it uploads a file and renders a copyable value.

The Configuration Helper Utility also has a Select Algorithm option which renders a list of available algorithms to select.