In Domain definition we can design domain types, their relationships and attributes.

If you are new to Higson Domain, you may want to read the introductory section Introduction to Domain.

In order to see Domain Definition, select Domain in Main Toolbar.

Select Definition tab.

After you enter Definition you will see screen of all definition types:

Definition Type Tile#

List View of Definition Types#

Add a New Type#

If you want to add a new definition type, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Definition tab.

3. Choose ADD A NEW TYPE +

   a. Choosing ADD A NEW TYPE + opens a step-by-step Definition Type wizard.

   

4. In step 1. Definition, you:

   a. need to provide unique Type code. Code can contain only characters from collection a-z; 0-9; “-”; “_” and it can’t start with “-”.

   i. If entered code in step 1. Definition is already used by another type, then validation error will appear.

   

   b. need to provide Type name. Name can contain only characters from collection a-z; 0-9; “-”; “_” and it can’t start with “-”.

   c. can provide Type description. Description cannot contain characters like “<”; “>”; “@”; “$”; “|” and it * cannot* start with any “special character”, for example “!”

   d. If you change your mind and don’t want to create a new type, you can choose Cancel in step 1. Definition.

5. Choose Next.

   a. If you enter illegal characters in code, name or description field, then borders will be highlighted with red color, and you will not be able to proceed to the next step. Hover mouse over the field to see tooltip with more details.

   

6. In step 2. Components you may add/duplicate/remove components. This data is not necessary to save a type.

   a. If you decide to add a component, you must provide code (unique), name and type code.

   i. Type code is a drop-down list with codes of all types

   

   b. If you entered the same code in at least two components, then borders will be highlighted with red color, and you will not be able to proceed to step 3. Business attributes

   

   c. If you enter illegal characters in code or name field, then borders will be highlighted with red color, and you will not be able to proceed to the next step. Hover mouse over the field to see tooltip with more details.

   

   d. If you choose Previous you will go back to step 1. Definition

7. Choose Next.

8. In step 3. Business attributes you may add/duplicate/remove global attributes. This data is not necessary to save a type.

   a. If you decide to add business attributes, you must provide code unique name. Providing default value is optional.

   

   b. If you entered the same code in at least two attributes, then borders will be highlighted with red color, and you will not be able to save a type.

   

9. In Default Value field, you must click on red exclamation mark to indicate where do you want to implement changes.

   

   a. The pop up will appear, choose one of the available options and click Save changes

   

10. Choose Save changes.

Download Domain Definition#

If you want to download Domain Definition, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Definition tab.

3. Choose Download Domain Definition in Definition tree.

   a. Choosing Download Domain Definition downloads an XML file that contains all definition types and all dependencies between definition types. Example file:

   

Upload Domain Definition#

If you want to upload Domain Definition, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Definition tab.

3. Choose Upload Domain Definition in Definition tree.

   a. Choosing Upload Domain Definition brings up Import from XML screen.

   

   b. If you select checkbox Remove elements not included in file, then warning will appear.

   

4. Drag&drop desired file or Click to upload a file and choose file in File explorer.

   a. Correct XML file should look like this:

   

   b. If you choose a file with extension other than XML, then validation error will pop up

   

5. Choose Upload.

6. The domain definition is uploaded correctly when the message Upload successful appears, as well as a report containing import statistics.

   a. If validation error occurs (see above), then an upload process is being aborted.

   b. If you checked checkbox Remove elements not included in file in step 3, then adequate information about changes will appear after uploading a file.

   

Delete Definition Tree#

If you want to delete the entire Domain Definition, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Definition tab.

3. Check the status of Delete definition tree buton:

   a. If button is greyed out, continue from step 4. Before deleting entire domain definition, you need to delete entire domain configuration first and publish session.

   

   b. If buton is available, continue from step 11.

   

4. Choose Configuration tab.

5. Choose Delete tree configuration.

   a. After choosing Delete tree configuration button, confirmation pop-up will appear.

   

6. Choose Confirm.

   a. The Entire Domain Configuration is deleted from the environment.

7. Choose Session.

   a. After choosing Session button, Session preview screen will appear.

8. Choose Publish changes.

9. Choose Domain in Main toolbar.

10. Choose Definition tab.

11. Choose Delete definition tree button.

    a. After choosing Delete tree configuration button, confirmation pop-up will appear.

12. Choose Confirm.

    a. The Entire Domain Definition is deleted from the environment.

Definition Type Details Screen#

You can access Definition Type details by left-clicking on the specific type tile in the Domain Definition tab. You can also see Definition Type details by changing from Tiles view to List view.

Tiles view:

List view:

You can see Available actions for the Definition Type below:

Delete Type#

If you want to delete a specific Definition Type, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Definition tab.

3. Left-click on a definition type you wish to delete.

   a. Left-clicking on a definition type brings up Definition Type details screen.

4. Choose Delete type.

   a. After choosing Delete type action, confirmation pop-up will appear.

   

5. Choose Confirm.

   a. Definition type is deleted from the environment.

   b. If a definition type is used in the Domain Configuration, then validation error will appear.

   

Edit Type#

If you want to edit data in specific definitione type, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Definition tab.

3. Left-click on a definition type you wish to edit.

   a. Left-clicking on a definition type brings up Definition Type details screen.

4. Choose Edit.

   a. Highlighted borders indicate that edit mode is active.

   

5. Edit any data you need.

   

6. Choose Save changes to save all changes made in definition type.

   a. Cancel reverts all changes made in the definition type.

   b. If components you edit are used in Domain Configuration, then validation error will appear.

   

In Domain configuration we can create instances of domain types and configure their attributes with use of Decision tables or Functions.

If you are new to Higson Domain, you may want to read the introductory section Introduction to Domain.

In order to see Domain Configuration, select Domain in Main Toolbar.

After you enter Configuration you will see screen of configuration from ROOT perspective:

User can Expand/Collapse a tree by clicking on the arrows.

Configuration Collection:#

Add New Collection Elements#

If you want to add a new collection elements, follow these steps:

1. Choose Domain in Main toolbar.

2. Navigate to Collection you want to add new elements to.

3. Choose Add new elements to tree in desired Collection.

   a. Choosing Add new elements to tree brings up Add to tree screen.

   

4. Choose Add elements radiobutton.

5. On this screen, you:

   a. need to provide unique Element code. Code can contain only characters from collection a-z; 0-9; “-”; “_”; “+” and it can’t start with “-”.

   i. If the code you provided is not unique, then borders will be highlighted with red color and warning message will appear.

   

   ii. If you enter illegal characters, then borders will be highlighted with red color. Hover on the field to see tooltip with more information.

   

   b. need to provide Element name. Name can contain only characters from collection a-z; A-Z; 0-9; “-”; “_” and white-space characters.

   i. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

   c. can provide Element description. Description can contain only characters from collection a-z; A-Z; 0-9; “:”; “.”; “,”; “-”; “_” and white-space characters.

   i. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

   d. can add additional Elements by clicking + NEW ELEMENT.

6. Choose Add.

   a. Elements with data you provided are created.

Add Reference#

If you want to add a reference, follow these steps:

1. Choose Domain in Main toolbar.

2. Navigate to the Collection for which you want to create reference.

3. Choose Add new elements to tree in desired Collection.

   a. Choosing Add new elements to tree brings up Add to tree screen.

4. Choose Add a reference radiobutton.

   

   a. If the Add button is greyed out, it means that you have not chosen any Collection Element to refer to yet.

5. Choose Collection Element you want to create a reference to.

   a. If there are no Elements to refer to, then an information message will be placed instead of the configuration tree.

   

6. Choose Add.

   a. Reference to chosen Element is created.

Add a Copy#

If you want to copy Collection or Collection Element, follow these steps:

1. Choose Domain in Main toolbar.

2. Navigate to the Collection for which you want to copy Elements.

3. Choose Add new elements to tree in desired Collection.

   a. Choosing Add new elements to tree brings up Add to tree screen.

4. Choose Add a copy radiobutton.

   

5. In step 1. Description, you:

   a. need to provide unique Element code. Code can contain only characters from collection a-z; 0-9; “-”; “_”; “+” and it can’t start with “-”.

   i. If the code you provided is not unique, then borders will be highlighted with red color and warning message will appear.

   

   ii. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

   b. need to provide unique Element name. Name can contain only characters a-z; A-Z; 0-9; “-”; “_” and white-space characters.

   i. If the name you provided is not unique, then borders will be highlighted with red color and warning message will appear.

   

   ii. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

6. Choose Next.

7. In step 2. Element to copy you need to choose which Collection Element you want to copy.

   

   a. If the Add button is greyed out, it means that you have not chosen any Collection Element to copy.

8. Choose Add.

   a. Copy of chosen Collection Element is created.

Download Domain Configuration#

If you want to download Domain Configuration, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Download Domain Configuration in Configuration tree.

   

   a. Choosing Download Domain Configuration downloads an XML file that contains all configuration Collections, Collection Elements, Definition Types and all dependencies between them.

Upload Domain Configuration#

If you want to upload Domain Configuration, follow these steps:

1. Choose Domain in Main toolbar.

2. Choose Upload Domain Configuration in Configuration tree.

   

   a. Choosing Upload Domain Configuration brings up Import from XML screen.

   

   b. If you select checkbox Remove elements not included in file, then warning will appear.

   

3. Drag&drop desired file or Click to upload a file and choose file in File explorer.

   a. If you choose a file with extension other than XML, then validation error will pop up

   

   b. If there is something wrong with data in XML file, then validation error will appear.

   

4. Choose Upload

5. When the progress bar reaches 100%, it means that domain definition was uploaded correctly.

   a. If a validation error occurs (see above), then an upload process is being aborted.

   b. If you checked checkbox Remove elements not included in file in step 2, then adequate information about changes will appear after uploading a file.

   

Delete Configuration Tree#

If you want to delete the entire Domain Configuration, follow these steps:

1. Choose Domain in Main toolbar

2. Choose Delete configuration tree.

   a. After choosing Delete configuration tree button, confirmation pop up will appear.

   

3. Choose Confirm.

   a. The Entire Domain Configuration is deleted from the environment.

4. Choose Session.

   a. After choosing Session button, Session preview screen will appear.

5. Choose Publish changes.

Collection Element Details Screen#

You can access Collection Element details by left-clicking on the specific Element in the Domain Configuration tree.

Edit Element#

If you want to edit data in specific Collection Element, follow these steps:

1. Choose Domain in Main toolbar.

2. In the Configuration tree, left-click on Collection Element you wish to edit.

3. Choose Edit.

   a. Highlighted borders indicate that edit mode is active.

   

4. Edit any data you need.

   

5. Choose Save changes to save all changes made in Collection Element.

   a. Cancel reverts all changes made in the Collection Element.

Add Local Attribute#

1. Choose Domain in Main toolbar.

2. In the Configuration tree, left-click on Collection Element you wish to add local attribute.

3. Choose Edit.

4. Choose Add local attribute and you:

   

   a. need to provide unique Attribute code. Code can contain only characters from collection “a-z”; “A-Z”; “-”; “_”.

   i. If you entered the same code in at least two attributes, then borders will be highlighted with red color, and you will not be able to save changes.

   

   ii. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

   b. need to provide Attribute name. Name can contain only characters from collection “a-z”; “A-Z”; “0-9”; “-”; “_” and white-space characters.

   i. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

   c. need to provide Attribute value. Value can contain any characters.

5. Choose Save changes.

Reset to Default Value#

1. Choose Domain in Main toolbar.

2. In the Configuration tree, left-click on Collection Element you wish to add local attribute.

3. Choose Edit.

4. Choose Reset to default value for specific Global Attribute.

   

   a. Attribute’s value is changed to the value defined in the appropriate Definition Type.

5. Choose Save changes.

Clone Element#

If you want to clone specific Collection Element, follow these steps:

1. Choose Domain in Main toolbar.

2. In the Configuration tree, left-click on Collection Element you wish to clone.

3. Choose Clone.

   a. Choosing Clone brings up the Clone element screen.

   

4. You need to provide:

   a. unique code. Code can contain only characters from collection “a-z”; “A-Z”; “-”; “_”.

   i. If the code you entered is not unique, then borders will be highlighted with red color and warning message will appear.

   

   ii. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

   b. unique name. Name can contain only characters from collection"a-z"; “A-Z”; “0-9”; “-”; “_” and white-space characters.

   i. If the code you entered is not unique, then borders will be highlighted with red color and warning message will appear.

   

   ii. If you enter illegal characters, then borders will be highlighted with red color. Hover on field to see tooltip with more information.

   

5. Choose Clone.

   a. Collection Elements are being cloned.

Delete Element#

If you want to delete specific Collection Element, follow these steps:

1. Choose Domain in Main toolbar.

2. In the Configuration tree, left-click on Collection Element you wish to delete.

3. Choose Delete element.

   a. After choosing Delete element action, confirmation pop up will appear.

   

4. Choose Confirm.

   a. Collection Element is deleted from the environment.

Attach Region#

If you want to attach a region to Collection Element, follow these steps:

1. Choose Domain in Main toolbar.

2. In the Configuration tree, left-click on Collection Element with no region assigned you want to attach a region.

3. Choose Attach region

   a. If Attach region action is greyed out, it means that user has active open session.

   b. If Detach region action is available, it means that Collection Element has assigned reason already. You need to Detach region before you will be able to attach a new region.

   c. Choosing Attach region brings up Manage versioning screen.

   

4. Select Region and one or more Version.

5. Choose Change.

   a. Region is being assigned to the Collection Element.

Detach Region#

If you want to detach a region from Collection Element, follow these steps:

1. Choose Domain in Main toolbar.

2. In the Configuration tree, left-click on Collection Element with a region assigned you want to detach a region.

3. Choose Detach region.

   a. If Detach region action is greyed out, it means that user has active open session.

   b. If Attach region action is available, it means that Collection Element has no region assigned.

   c. After choosing Detach region action, confirmation pop up will appear.

   

4. Choose Confirm.

   a. The Region is being detached from Collection Element.

A decision table presents values in rows and columns. Each row describes a situation when given inputs (columns) result in certain outputs (also columns). In other words, a decision matrix displays decisions based on certain criteria. You can create a decision table in Higson (so-called a parameter), where you define input and output columns and then populate data with values in rows.

If you are new to Higson decision tables, you may want to read the introductory section Introduction to Decision Tables.

Since version 4.3, Higson Studio also includes an AI Assistant that can help you conversationally design and refine decision tables. To learn how to enable it, see AI Assistant Configuration, and for usage instructions see AI Features in Decision Tables.

In order to see all Decision Tables select Decision Tables in the Main Toolbar.

After that, when you enter Decision tables, you will see a screen of Decision Tables

The decision tables list view depends on the selected profile. If a profile is selected, both global items and items assigned to the selected profile are displayed. If no profile is selected (not-chosen), only global items are visible.

Elements modified in current session are marked with pink dot:

On this screen, you can apply Filters to search for specific decision table or to narrow down the number of displayed decision tables. You can also perform actions on one or multiple decision tables.

You can see All Actions available for the decision tables below:

Some of the actions in the More actions drop-down menu are grayed out, when no decision tables are selected

You can see all Filters available for decision tables below:

Add Decision Table#

If you want to add Decision tables follow these steps:

1. Choose Decision tables in Main toolbar.

2. Choose + Add Decision table in All actions bar.

   a. Choosing + Add Decision table opens a step-by-step wizard.

   

3. In step 1. Name, you need to provide a unique decision table code/name. Name can contain only characters from collection a-z; 0-9; “.”; “-”; “_” and it can’t start with “-”.

   a. If you changed your mind and don’t want to create a new decision table, you can choose Cancel in step 1. Name.

4. Choose Next.

   a. If you enter illegal characters, then the validation error will appear

   b. If the name you provided is already used by another decision table, then a pop-up dialog will appear, either close the pop-up by clicking Cancel or View existing decision table, that will redirect you to the appropriate Decision table and close the Decision table wizard.

   

5. In step 2. Profile you may assign decision table to a profile by selecting a profile from drop down list or create a global table by checking No profile (global). Assigning this table to a profile will ensure that only users with permissions for that profile can access it. Global decision tables will be visible regardless of profile permissions.

6. In step 3. Definition you may optionally add a description and assign tags. You must choose a data source for a matrix. External source and AI Model Source are described later in this document.

   

Additional options available to configure a decision table are described in the table below.

a. The match required and In-memory flags are checked by default. Unchecking the In-memory checkbox means that you will not be able to use the matchers, union, blob and asterisk. The confirmation pop-up will appear.

7. Choose Next.

8. In step 4. Levels you may add IN and OUT columns, but this is not necessary to proceed to the next step.

   

   When selecting the “date” value type, be sure to use the correct recording format: yyyy-MM-dd.

   When selecting the “data time” value type, be sure to use the correct notation format: yyyy-MM-dd HH:mm:ss

   

9. Choose Next.

10. In step 5. Matrix you may add matrix cells, but this is not necessary to proceed to the next step.

11. Choose Save changes.

    a. Decision table with data you provided is created. You will be redirected to Decision table’s details screen.

Upload Decision Table#

If you want to upload decision tables from a ZIP file, follow these steps:

1. Choose Decision Tables in the Main Toolbar.

2. Choose Upload in the “All Actions” bar.

   a. Choosing Upload brings up the Import decision table screen.

   

3. Drag and drop the desired file or Click to upload a file and choose file in File Explorer.

   a. If you choose a file with an extension other than ZIP, then a validation error will pop up.

   

4. After uploading, the upload report appears.

Mass Export to XLSX#

If you want to download one or more decision tables, follow these steps:

1. Choose Decision Tables in the Main Toolbar.

2. Select one or more.

   a. Select the top checkbox to select all decision tables in the view, or select individual checkboxes to select one or multiple

3. From the drop-down menu More actions: choose Mass export to XLSx.

   a. If action Mass export to XLSx is grayed out, it means that no decision tables have been selected.

   b. Choosing Mass export to XLSx downloads a ZIP file that contains files with decision tables.

Details of zip Sheet Data contains matrix.

Sheet Configuration contains details of levels and definition.

Sheet Mark contains information on object type, it is used for validation when uploading file into Higson Studio.

Extract Codes#

If you want to extract one or more decision tables, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Select one or more decision tables

   a. Select the top checkbox to select all decision tables in the view or select individual checkboxes to select one or multiple.

3. From drop-down menu More actions choose Extract codes

   a. If action Extract codes is greyed out, it means that no decision tables have been selected.

   b. Selecting Extract codes downloads a XLSX file that contains Code, SHA and Region columns

Download Codes#

If you want to download one or more decision tables codes, follow these steps:

1. Choose decision table in Main toolbar.

2. Select one or more decision tables.

   a. Select the top checkbox to select all decision tables in the view, or select individual checkboxes to select one or multiple

3. From drop-down menu More actions choose Download codes

   a. If Download codes action is greyed out, it means that no decision tables have been selected.

   b. Selecting Download codes downloads a TXT file that contains decision tables’ codes

Select from File#

If you want to select one or more Decision tables from the file, follow these steps:

1. Choose Decision tables in Main toolbar.

2. From drop-down menu More actions choose Select from file

   a. Choosing Select from file brings up the Select from file screen

   

3. Drag and drop the desired file or Click to upload a file and choose file in File explorer.

   a. Correct TXT file should look like this:

   

   b. If you choose a file with an extension other than TXT, then a validation error will pop up.

   

4. When the progress bar reaches 100%, you will be informed which decision tables will be selected.

   

5. Choose Select.

   a. All decision tables that were present in the Selected Elements table get selected.

Compare with Extract#

Makes a comparison between the file and the environment, and gives information on which elements are the same, and which changes are only in the file or only in the environment.

1. Choose Decision tables in Main toolbar.

2. From drop-down menu More actions choose Compare with extract.

   a. Choosing Compare with extract brings up the Compare with extract screen.

   

3. Drag and drop the desired file or Click to upload a file and choose file in the File explorer.

   a. Correct XLS/XLSX file should look like this

   

   b. If you choose a file with extension other than XLS/XLSX, then validation error will pop up

   

4. When the import is successful you will be informed about it with the appropriate status Upload succesful. You will be informed about the status of all decision tables present in the environment and the extract file you provided.

   

5. In the Select section (visible below the table with decision table status), choose which Decision tables will be selected.

   a. You can select multiple options.

   b. Matching: decision tables that are equal between the environment and the extract file will be selected.

   c. Different regions: decision tables that are equal but with different regions between the environment and the extract file will be selected.

   d. Different name: decision tables that are equal but with different names between the environment and the extract file will be selected.

   e. Missing from extract: decision tables that are present in the environment but absent from the extract file will be selected.

6. Choose the Select Button.

   a. If the Select button is grayed out, it means that no checkboxes were selected in step 5.

   b. All Decision Tables that match the criteria provided in step 5 are selected.

Assign Profile#

If you want to assign a profile to one or more Decision Tables, follow these steps:

1. Select Decision Tables from the main toolbar.

2. Select the Decision Tables without an assigned profile by checking the boxes on the left side of the list.

3. From the More Actions drop-down menu, choose Assign Profile.

   a. Selecting Assign Profile opens the Assign Profile screen.

4. Select the profile to which you want to assign the Decision Table and confirm by clicking Change.

On the Decision Tables list view, a profile entry will appear for the assigned Decision Tables. The view will also be updated to reflect the selected profile.

Make Global#

If you want to detach one or more Decision Tables from profile, follow these steps:

1. Select Decision Tables from the main toolbar.

2. Select the Decision Tables with an assigned profile by checking the boxes on the left side of the list.

3. From the More Actions drop-down menu, choose Make Global.

   a. The pop up will appear.

4. Click Confirm.

On the Decision Tables list view, a profile entry will disappear for the selected Decision Tables. The view will also be updated to global.

Add Region#

If you want to add a region to one or more decision tables, follow these steps:

1. Choose Decision Tables in the Main Toolbar.

2. Select one or more decision tables without a Region.

   a. Select the top checkbox to select all decision tables in the view or select individual checkboxes to select one or multiple decision tables.

3. From the drop-down menu More actions, choose Add region.

   a. If action Add region is grayed out, it means that no decision tables have been selected.

   b. Choosing Add Region brings up the Manage Versioning screen.

   

4. Select a Region and one or more versions.

5. Select Change.

6. The region has been assigned to the decision tables

Remove Region#

If you want to remove a region from one or more decision tables, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Select one or more Decision tables with a Region.

   a. Select the top checkbox to select all decision tables in the view or select individual checkboxes to select one or multiple.

3. From drop-down menu More actions choose Remove region.

   a. If action Remove region is greyed out, it means that no function has been selected.

   b. After choosing Remove region action, confirmation pop-up will appear.

   

4. Choose Confirm.

   a. Regions are being removed from all selected decision tables.

Manage Tags#

If you want to manage tags from one or more decision tables, follow these steps:

1. Select the decision tables on the main toolbar.

2. Select one or more untagged decision tables.

3. From the More Actions drop-down menu, select Manage Tags.

4. Select the tags you are interested in and click Save.

Remove Decision Table#

If you want to delete one or more decision tables, follow the steps below:

1. Choose the Decision tables in the Main toolbar.

2. Select one or more decision tables.

   a. Select the top checkbox to select all decision tables in the view, or select individual checkboxes to select one or multiple

3. From the drop-down menu More actions, choose Remove.

   a. If action Remove is grayed out, it means that no decision tables have been selected.

   b. After choosing Remove action, a confirmation pop-up will appear.

   

4. Choose Confirm.

5. All selected decision tables are deleted from the environment

Details View#

You can access decision table details by left-clicking on the specific decision table in the List of all decision tables. The decision tables details screen contains all information about the decision tables, including their description, assigned regions, tags, and others.

And you can see the available actions below:

Left-click on LEVELS AND DEFINITION to see more details about the Decision table.

Value Source#

The Value Source field is used to define the source of a value for an IN level in a decision table. It can accept two types of references:

• context paths,
• functions.

Context Paths in the Value Source Field

If the value in the IN level should be read from the context, an appropriate context path must be provided, for example: quote.driver.age. In this example, the value of the age attribute is read from the Driver type, which is a subtype of the Quote type.

EXAMPLE

For the following data taken from the context:

quote.driver.gender = F

quote.driver.age = 20

the resulting Tariff’s factor is 0.507.

Functions in the Value Source Field

The Value Source field also supports references to functions using the $f notation. In this case, the value evaluated in the decision matrix is the result of a function execution.

Duplicate Decision Table#

If you want to duplicate specific Decision table, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you wish to duplicate.

   a. Left-clicking on Decision table opens Decision table details screen.

3. Choose Duplicate in Available actions.

   a. Choosing Duplicate brings up the Duplicate table screen.

   

4. Enter unique Decision table name. Name can contain only characters from collection a-z; 0-9; “.”; “-”; “_” and it can’t start with “-”.

5. Choose Save changes.

   a. If you entered illegal characters, then name filed will highlight with red color.

   

   b. If the name you provided is already used by another Decision table, then pop-up dialog will appear. You can either close the pop-up by clicking Cancel or you can click View existing Decision table, that will redirect you to the appropriate Decision table.

   

Download Decision Table#

If you want to download a specific Decision table, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you wish to download.

   a. Left-clicking on Decision table opens Decision table details screen.

3. Choose Download in Available actions.

   a. Choosing Download downloads an XLSX file that contains data of Decision table.

Show History#

If you want to check all modifications made on Decision table, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you want to check.

   a. Left-clicking on Decision table opens Decision table details screen.

3. From drop-down menu More actions choose Show history.

   a. Choosing Show history brings up the Decision table history screen.

   

   No.	Column name	Description
   1	Operation Type	Type of operation made on the Decision table.
   2	Message	Deatailed information on operation.
   3	Author	User’s login that made an operation.
   4	Modification Date	Date of the published session that made an operation.
   5	Region	Region and version assigned to the Decision table at the time of modification.
   6	Digest	Decision table’s hash.
   7	Actions	View redirects to an archived version of the Decision table. In this screen, you can choose Restore to restore that version of the Decision table.

Rename#

If you want to rename a Decision table, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you wish to rename.

   a. Left-clicking on Decision table opens Decision table details screen.

3. From drop-down menu More actions choose Rename.

   a. The Highlighted border around the Decision table name indicates that the name is editable.

   

4. Enter unique Decision table name. Name can contain only characters from collection a-z; 0-9; “.”; “-”; “_” and it can’t start with “-”.

5. Choose Save name.

   a. If you enter illegal characters, then the rename field will highlight with red color.

   

   b. If the name you provided is already used by another Decision table, then pop-up dialog will appear. You can either close the pop-up by clicking Cancel or you can click View existing decision table, that will redirect you to the appropriate Decision table.

Attach Region#

To attach a decision table to a region, decision table must first be assigned to a profile. A region belongs to a profile.

If you want to attach a region to a specific Decision table from Decision table details level, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on Decision table with no region assigned you want to attach a region.

   a. Left-clicking on Decision table opens Decision table details screen.

3. From drop-down menu More actions choose Attach region

   a. If Detach region action is available, it means that the Decision table has assigned the region already. You need to Detach region (hyperlink) before you will be able to attach a new region.

   b. Choosing Attach region brings up Manage versioning screen.

   

4. Select Region and one or more Version.

5. Choose Change

   a. The Region is being assigned to the Decision table.

Detach Region#

If you want to detach a region from a specific Decision table from Decision table details level, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table with a region assigned you want to detach region.

   a. Left-clicking on Decision table opens Decision table details screen.

3. From drop-down menu More actions choose Detach region.

   a. If Attach region action is available, it means that the Decision table has no region assigned.

   b. After choosing Detach region action, confirmation pop-up will appear.

   

4. Choose Confirm.

   a. The Region is being detached from the Decision table.

Create Alias#

If you want to create an alias to specific Decision table, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on Decision table you want to create alias.

   a. Left-clicking on Decision table opens Decision table details screen.

3. From drop-down menu More actions choose Create alias.

   a. Choosing Create alias brings up the Create alias screen.

   

4. Enter unique alias name. Name can contain only characters from collection a-z; 0-9; “.”; “-”; “_” and it can’t start with “-”.

5. Choose Save change.

   a. If you enter illegal characters, then the rename field will highlight with red color.

   

   b. If the name you provided is already used by another Decision table, then a pop-up message will appear.

   

Find Usages#

If you want to check where Decision table is used, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you want to check.

   a. Left-clicking on Decision table opens Decision table details screen.

From drop-down menu More actions choose Find usages.

a. Choosing Find usages brings up the Find usages screen.

Remove (Details View)#

If you want to delete specific Decision table from Decision table details level, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you wish to remove.

   a. Left-clicking on Decision table opens Decision table details screen.

3. From drop-down menu More actions choose Remove.

   a. After choosing Remove action, confirmation pop-up will appear.

   

4. Choose Confirm.

   a. The Decision table is deleted from the environment.

Matrix#

The Matrix section displays the decision table data in rows and columns. The section header shows the current number of rows.

The following actions are available in the Matrix section toolbar:

Each row in the matrix that has been modified in the current session is preceded by a colored dot indicator. Each column has a Search field that allows you to filter rows by the values in that column.

Edit Matrix#

If you want to edit matrix in a specific decision table, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you wish to edit.

   a. Left-clicking on the Decision table opens the details screen.

3. Choose Edit in Matrix section.

   a. Highlighted borders indicate that the edit mode is active.

   

4. Edit any data you need.

5. Choose Save changes to save all changes made in the Decision table.

   a. Cancel reverts all changes.

Edit Levels and Definition#

If you want to edit levels or definition in a specific decision table, follow these steps:

1. Choose Decision tables in Main toolbar.

2. Left-click on the Decision table you wish to edit.

   a. Left-clicking on Decision table opens Decision table details screen.

3. Expand LEVELS AND DEFINITION

4. Choose Edit in Definition section or in Levels section. Only one section can be edited at given time.

   a. Edit mode for Definition section.

   

   b. Edit mode for Levels section.

   

5. Edit any data you need.

6. Choose Save changes to save all changes made in the Decision table.

   a. Cancel reverts all changes.

Decision tables - Cascade call#

In each OUT cell of the decision table, the value can be specified in three ways:

• as a literal
• as a value retrieved from another decision table (cascade get)
• as a value retrieved from a function (cascade call)

Cascade call - how to call#

In the cell, enter an expression that means returning the result from the specified function.

Cascade call – implicit type conversion#

If we use a cascade call expression to function F returning an object of any type T2 in decision table P at level T1, then:

• cascade call will internally return an object of type T2
• then T2 will be converted to HolderT1
• the conversion will take place according to the logic of the methods from the family: _dec(), _num(), _int(), _str() , _date(), _bool()
• the conversion may be lossy

Cascade call – example#

Function calc.factors:

age = _num(age)
var factor1 = 1.0 + age / 100
var factor2 = 3.0 + age / 10

// function returns a map
return util.map(
    'f1', factor1,
    'f2', factor2
)

Decision table client.factors:

Result of get( “client.factors”, ctx ):

Cascade get – invocation method#

In a cell, we enter an expression that represents returning a value from another decision table.

Cascade get - implicit type conversion#

If, in decision table P1 at level T1, we use the cascade get expression to decision table P2 at level T2, then:

• cascade get will internally return a Holder of type T2
• then HolderT2 will be converted to HolderT1
• the conversion will take place according to the logic of one of the functions: _dec(), _num(), _int(), _str(), _date(), _bool()
• the conversion may be lossy

Cascade get - example#

Decision table decisionTable.p1:

Decision table decisionTable.p2:

Result of get(decisionTabl.p2):

When retrieving values for decisionTable.p2, the same context is used as for the initial decisionTable.p1.

A cascade calls cycle is not permitted: P1 -> P2 -> …. -> P1

Decision Table Search Mechanism#

There are two mechanisms for searching the matrix of a decision table: best match and union match.

Best match#

Best match is the default search mode. It searches the In levels sequentially, looking for an exact match. The asterisk (*) is considered only if no exact match is found at a given level. In this mode, subsequent levels have progressively lower priority. Therefore, the order of the columns affects the search result.

Let’s examine this using the following decision table:

EXAMPLE

context values: In1 = b, In2 = 1

An exact match for value In1 = b is found at the In1 level, so for that row we search the In2 level for the value 1. No exact match is found, but there is an asterisk, so the result in best match mode is 200.

Union match#

In union match mode, asterisk(*) is treated the same as an exact match. To enable uniion mode select union checkbox in the in-levels section.

EXAMPLE

context values: In1 = b, In2 = 1

An exact match for value In1 = b is found at the In1 level, but there is also an asterisk so both rows are taken into account. We then search the In2 level for the value 1. Both asterisk(*) and an exact match are found, so the result in union mode is 100 and 200. In this case, both rows are returned.

Creating AI Model-Based Decision Tables in Higson Studio#

Higson Studio allows the creation of decision tables utilizing artificial intelligence (AI) models. In this approach, the AI model serves as the matrix of the decision table. The definition and levels are configured similarly to standard decision tables; however, the matrix is represented by the ONNX file. Higson Studio does not perform model training – it is assumed that the model has been previously prepared in an external environment and converted to the ONNX format.

Use Case#

Use a trained AI model (in ONNX format) to predict a client’s monthly insurance premium based on their demographic and lifestyle data. Below is a description of the process for configuring and deploying such a table using an AI model in the ONNX format.

To get started, create a new decision table in Higson Studio. Navigate to the Decision tables tab and select the Add decision table action.

1. Assign a name to your decision table and click Next to proceed to the next step.

   

2. In the second step, under the Definition section, set AI Model Source as the data source for decision-making. Then, click Next to continue.

   

3. In step 3, similar to standard decision tables, you need to define:

• Input levels (in) – the input data passed to the AI model.
• Output levels (out) – the expected responses generated by the AI model.

Please note, that for decision tables with an AI model data source, only decimal data type is available.

4. In step 4 of the configuration wizard:

• You need to upload a onnx file containing the trained AI model.
• During upload, the file is automatically validated for correct format and model structure.

The onnx file added in this way serves as the matrix of our decision table.

Once the decision table is correctly configured and saved, it can be invoked through Higson Runtime REST. At this stage, the ONNX file logic is validated.

A matcher is a functionality available for IN levels in a decision table. It is easy to use but has a significant impact on how values in matrix columns are interpreted.

Matchers are divided into three main groups:

1. Between
2. Contains
3. Like

Between Group – Defining Numerical Ranges#

These matchers allow the definition of a numerical range in a matrix column:

• between/ii – closed interval on both sides.
• between/ie – left-inclusive, right-exclusive interval.
• between/ei – left-exclusive, right-inclusive interval.

Wildcards and ranges in matrix cells for “Between” matcher columns#

• * — wildcard; matches any value.

In Best Match mode it’s only considered if no exact match exists in other rows.

Use one of two notations for unbounded ranges:

• * — * unbounded range (−∞ … +∞); matches any non-null value.
• * + checkbox — also an unbounded range, but null-safe; it matches any value including null.

Tip: Use * + checkbox for a default/fallback row that should also handle missing input; use *-* when null is handled elsewhere.

Contains Group – Matching Based on Value Sets#

This group enables the introduction of value lists into matrix columns and allows values to be compared as sets:

• contains/all – checks whether all values in the matrix exist in the dataset from the data source (comparison direction matters!).
• contains/any – checks whether the two sets have at least one common element.
• contains/none – checks whether the sets are disjoint; if they are, the matcher returns a match.
• in / not in
  • in – checks whether the value from the data source is present in the list of values in the matrix cell.
  • not in – checks whether the sets are disjoint. Contains matchers assume that:
• The value source is a set of values (e.g., A, B, C, D).
• The value in the matrix cell also represents a set.
• The matcher verifies whether the value source set has a common part with the matrix set.

In / Not In matchers assume that:

• The value source is a single value (scalar).
• The value in the matrix cell represents a set.
• The matcher checks whether the value source belongs to that set. Performance Considerations: The contains and in/not in matchers produce the same result. Contains matchers are more general, so if performance is a priority, use in/not in whenever possible.

Like Group – Pattern Matching#

This group allows for pattern-based text matching:

• text/like – compares a string value from the data source with the string value in the matrix. The values in the matrix can use asterisk as a wildcard character.
• text/regex– checks whether the value from the data source matches the regex pattern stored in the matrix cell.

When to Use Matchers?#

Matchers are useful when you need to precisely define how values in a column should be interpreted, such as:

• Value Ranges (Range)
• Lists of Values (List)
• Pattern Matching (RegEx, Like) Each matcher can be defined separately for every IN level in a decision table, providing flexibility in business logic modeling.

Each column of any decision table has a specific type. This type is defined when creating a decision table.

There are many built-in types available:

• string
• decimal
• integer
• date
• datetime
• boolean

However, sometimes we need to limit the values that can be entered by the user. In this case we need to be able to define an enumeration of allowed values or in other words a dictionary.

Higson has the answer to this need - a Dictionary mode.

Creating a Dictionary Table#

To create an enumeration of allowed values, we just need to create a decision table and select the Dictionary value checkbox:

Then we define a single OUT column and enter (or import from the Excel file) all dictionary values.

Let’s say we need a dictionary of available fund codes. So we can create a decision table called fund.codes (for example) and enter all valid fund codes into a single OUT column, like in the image below:

By creating this dictionary decision table we just defined new type available for other decision tables. Now, we can create an ordinary decision table and define a column type to be fund.codes.

Using a Dictionary Table#

Once we have created a dictionary we can use it in another table. The following image shows an example decision table called fund.transfer.fee that uses IN column with dictionary type fund.codes:

From now on, only codes defined in the fund.codes dictionary can be entered into this column:

Below is a list of restrictions related to the use of dictionary decision tables:

• dictionary table must have exactly one output column
• dictionary table cannot be deleted if it is used by another decision table
• dictionary table cannot be defined as an external source
• dictionary table cannot be attached to any region
• dictionary table cannot be unmarked as a dictionary if it is used

External Source is a feature that allows you to retrieve data from an external database (using an SQL query) and treat this data as if it were defined in a decision table matrix.

With this option you can create decision tables that are fully dependent on data coming from an external source, managed by an external application, etc. For example, you could create a database table with daily updated prices of investment fund units and then have Higson treat these prices as a decision table matrix.

Let’s see how External Source feature fits into the bigger picture.

Ordinary Decision Table#

Every ordinary decision table consists of two main parts:

1. input/output columns configuration (types, matchers, matching mode etc.)
2. matrix with data

The ordinary decision table is the owner of the matrix data. The matrix data is managed by Higson and is stored in the Higson DB. It can be exported or imported from excel or snapshot files.

Ordinary decision tables can work in 2 modes:

• in-memory mode (default)
• non-memory mode

In-memory mode means that during the first use the matrix is converted into fast index kept in memory for fast decision table lookups.

Non-memory mode means that every time, the decision table is used, Higson executes an SQL query to fetch the result from the Higson DB.

Now we are ready to see what change the external-source brings.

External-Source Decision Table#

The matrix data is stored in an external database and can be fetched when needed. Once the data is downloaded, the decision table behaves like an ordinary decision table.

So, in case of external-source decision table, instead of creating a matrix, we need to create an SQL query.

Higson provides 2 modes that need to be described in more detail.

In-Memory External-Source Decision Table#

To configure decision table to use in-memory external source, we need to:

• check the External Source toggle button
• check the In-memory checkbox.

Then we need to define input/output columns like in an ordinary decision table.

Finally, we can configure External Source panel by:

• selecting datasource from External data source dropdown,
• writing SQL query in In-memory SQL Template text area,
• setting auto refresh and refresh period if needed.

Writing SQL Query for In-Memory Mode#

As mentioned earlier, in-memory decision table takes the entire matrix (input and output columns) and converts it into fast search index. So, the SQL query must also return the entire matrix, both input and output columns.

Consider a decision table with 3 input columns and 2 output columns:

1. input column: product_code
2. input column: fund_code
3. input column: unit_price_date
4. output column: unit_bid_price
5. output column: unit_offer_price

So, the SQL query must return dataset with 5 columns that will match 5 columns from decision table definition.

For example:

SELECT p.code, f.code, fp.price_date, fp.bid_price, fp.offer_price
FROM fund_price fp
  INNER JOIN fund f ON fp.fund_id = f.id
  INNER JOIN product p ON f.product_id = p.id
WHERE p.active = 1
  AND fp.price_date > now() - INTERVAL '1' YEAR

When this decision table is used for the first time, Higson executes this SQL query to obtain full data set (matrix). This matrix will be converted to in-memory index like in ordinary decision table.

Auto Refresh#

The SQL query is executed only once, when decision table is used for the first time. All subsequent lookups will be extremely fast, because they will be handled by in-memory index. What if the underlying database table changes in the meantime?

We can force Higson to periodically refresh the index in memory. Just check the Auto refresh checkbox and provide Refresh period expression. Refresh period consist of a number followed by a duration unit, for example:

An empty Refresh period means 1h by default.

The image below shows the sample configuration:

Non-Memory External-Source Decision Table#

To configure decision table to use non-memory external source, we need to:

• check the External Source toggle button
• uncheck the In-memory checkbox.

Then we need to define input/output columns like in an every decision table.

Finally, we can configure External Source panel by:

• selecting datasource from External data source dropdown,
• writing SQL query in Non-memory SQL Template text area.

Writing SQL Query for Non-Memory Mode#

As mentioned earlier, non-memory decision table does not cache anything. It executes SQL query for every evaluation request.

So, the SQL query:

• must return only output column
• may use input values to make conditions in SQL (where clause)

Consider a decision table with 3 input columns and 2 output columns:

1. input column: product_code
2. input column: fund_code
3. input column: unit_price_date
4. output column: unit_bid_price
5. output column: unit_offer_price

So, the SQL query must return dataset with only 2 columns, for unit_bid_price and unit_offer_price. It may use 3 inputs (product_code, fund_code, unit_price_date) to narrow the result.

For example:

SELECT fp.bid_price, fp.offer_price
FROM fund_price fp
  INNER JOIN fund f ON fp.fund_id = f.id
  INNER JOIN product p ON f.product_id = p.id
WHERE p.active = 1
  AND p.code = :product_code
  AND f.code = :fund_code
  AND fp.price_date = :unit_price_date  

The above query will use input values in where clause. If we evaluate decision table with such context:

ctx = new HigsonContext('product_code', 'AUL1', 'fund_code', 'FCB', 'unit_price_date', '2025-01-01');
result = engine.get(decisionTable, ctx);

Higson executes SQL query (PreparedStatement) with where clause:

select fp.bid_price, fp.offer_price
...
where p.active = 1
and p.code = 'AUL1'
and f.code = 'FCB'
and fp.price_date = '2025-01-01'

Configuring Datasources in Higson Studio#

For an datasource to be available on the External data source dropdown it must be configured in Higson Studio configuration file.

The following is the part of the conf/application.properties file with sample external source configuration:

higson.runtime.external-datasource.sql.names=ext_data, ext_funds, analytics

higson.runtime.external-datasource.sql.ext_data.url=jdbc:postgresql://...:5432/db1
higson.runtime.external-datasource.sql.ext_data.username=...
higson.runtime.external-datasource.sql.ext_data.password=...

higson.runtime.external-datasource.sql.ext_funds.url=jdbc:postgresql://...:5432/funds_history
higson.runtime.external-datasource.sql.ext_funds.username=...
higson.runtime.external-datasource.sql.ext_funds.password=...

higson.runtime.external-datasource.sql.analytics.url=jdbc:postgresql://...:5432/analytics
higson.runtime.external-datasource.sql.analytics.username=...
higson.runtime.external-datasource.sql.analytics.password=...

The above file configures 3 datasources that can be used by External Source decision tables:

• ext_data
• ext_funds
• analytics

Higson Studio creates simple javax.sql.DataSource for every defined external datasource.

The configuration uses following properties:

Configuring Datasources in Higson Runtime#

If the application uses the Higson Runtime (embedded engine), it is necessary to provide external data sources and add them to the engine runtime:

HyperonEngineFactory factory = new HyperonEngineFactory(higsonDataSource);
...
DataSource dataDs = createDataSource(...)
DataSource fundsDs = createDataSource(...)
DataSource analyticsDs = createDataSource(...)
...
factory.addExternalDataSource( "ext_data",      dataDs );
factory.addExternalDataSource( "ext_funds",     fundsDs );
factory.addExternalDataSource( "ext_analytics", analyticsDs );
...
HigsonEngine engine = factory.create();

The deduplication process for decision tables is an automatic, cyclic background process running on the Higson Studio server. Its purpose is to optimize the storage of decision table matrices by detecting and deduplicating (reusing) identical matrices.

Problem It Solves#

Decision tables in Higson Studio may contain identical matrices. In such cases, the same data is stored multiple times — separately for each decision table. The deduplication process detects such situations and eliminates redundancy:

• one decision table is designated as the owner of the matrix,
• while the others become hard links pointing to that owner.

The physical data exists only once, regardless of how many decision tables share it.

Benefits#

• Lower memory (heap) – the DT lookup index is reused whenever possible
• Database storage – the matrix is stored only once in the database
• Smaller snapshot size – DTs that are hard links do not contain matrix files (*.mat)
• Faster DT loading time by the engine (no need to rebuild the lookup index if another DT uses the same matrix)
• Faster snapshot export time
• Faster export time for the list of decision tables

Functionality#

In addition to the deduplication process, hard links may also be created in other scenarios. For example, attaching a global decision table (DT) to multiple versions no longer requires creating deep copies of the DT. Only one DT will contain the matrix, while the others will become hard links.

Configuration#

Configuration is available via four properties:

Functions enable you to write code snippets in regular programming language, which let you implement any logic you want. You can write functions where Decision Table matrix is not enough.

If you are new to Higson functions, you may want to read the introductory section Introduction to Functions.

Since version 4.3, Higson Studio also includes an AI Assistant that can help you generate and refine functions from a natural-language description. To learn how to enable it, see AI Assistant Configuration, and for usage instructions see AI Features in Functions.

In order to see all functions, select Functions in Main Toolbar.

After you enter Functions you will see screen of all functions:

Each function is described by seven attributes:

The functions list view depends on the selected profile. If a profile is selected, both global items and items assigned to the selected profile are displayed. If no profile is selected (not-chosen), only global items are visible.

Elements modified in current session are marked with a dot:

On this screen, you can apply Filters to search for specific function or to narrow down the number of displayed functions. You can also perform actions on one or multiple functions.

You can see All Actions available for the functions below:

More actions drop-down menu, when no function is selected:

You can see all Filters available for the functions below:

Add Function#

If you want to add a new function, follow these steps:

1. Choose Functions in Main toolbar.

2. Choose + Add function in All actions bar.

   a. Choosing + Add function opens a step-by-step Function wizard.

   

   No.	Field/Button code	Description
   1a	Name	Allows to add function name.
   1b	Cancel	Interrupts the process of creating a new function. Returns the user to the functions list view.
   1c	Next	Proceeds to the next step of the function wizard.

3. In step 1. Name, you need to provide unique Function code/name. Name can contain only characters from collection a-z; 0-9; “.”; “-”; “_” and it can’t start with “-”, “+”, “=” or “@”.

   a. If you change your mind and don’t want to create a new function, you can choose Cancel in step 1. Name.

4. Click Next.

   a. If you enter illegal characters, then validation error will make field frame red.

   

   b. If another function already uses the name you provided, then pop-up dialog will appear. You can either close the pop-up by clicking Cancel or you can click View existing function, that will redirect you to the appropriate function and close the Function wizard.

   

5. In step 2. Profile you may assign the function to a profile by selecting a profile from the drop-down list, or create a global function by checking No profile (global). Assigning the function to a profile will ensure that only users with permissions for that profile can access it. Global functions are visible regardless of profile permissions.

6. In step 3. Definition you may add description, assign tags and select a type.

   

   No.	Field/Button code	Description
   1.	Description	Add or modify element description. Here you can add any additional detailed information about the new function.
   2.	Change	Modify tags attached to the function.
   3.	Type	Function’s type.
   4.	Previous	Go back to the previous step of the function wizard.
   5.	Save function	Completes the process of creating the new function.

   a. If you choose Previous you will go back to step 2. Profile

7. Choose Save function.

   a. Function with data you provided is created. You will be redirected to Function’s details screen.

Upload Function#

If you want to upload functions from ZIP file, follow these steps:

1. Choose Functions in Main toolbar.

2. Choose Upload in All actions bar.

   a. Choosing Upload brings up the Upload screen.

   

3. Drag&drop desired file or Click to upload a file and choose file in File explorer.

   a. If you choose a file with extension other than ZIP, then validation error will pop up to learn how the correct file looks like go here.

   

   b. If there is some problem with the data in the ZIP file you provided, then validation error will pop up.

4. If the file loads correctly, it may be uploaded to the environment. File will load correctly if there is no file format problem.

   a. If validation error occurs (see above), then no function will be uploaded.

   

   No.	Field/Button code	Description
   1	Close	Aborts the upload process.
   2	Delete	Removes the loaded file. When clicked, you will need to provide the file to load for the upload process to be completed.
   3	Upload	Uploads the loaded file to the system. The report of the upload will show.

5. Click Upload

6. When Upload is completed, the progress bar at 100% shows and the report is visible below.

   

   It allows you to check all the imported elements and if any problems during upload occurred.

Mass Export to XLSx#

If you want to download one or more functions, follow these steps:

1. Choose Functions in Main toolbar.

2. Select one or more function.

   a. Select the top checkbox to select all functions in the view, or select individual checkboxes to select one or multiple functions

3. From drop-down menu More actions choose Mass export to XLSx

   a. If action Mass export to XLSx is greyed out, it means that no function has been selected.

   b. Choosing Mass export to XLSx downloads a ZIP file that contains files with functions’ body (one file per function) and XLSX file with functions’ details.

   

Extract Codes#

If you want to extract one or more functions, follow these steps:

1. Choose Functions in Main toolbar.

2. Select one or more function.

   a. Select the top checkbox to select all functions in the view, or select individual checkboxes to select one or multiple functions

3. From drop-down menu More actions choose Extract codes

   a. If action Extract codes is greyed out, it means that no function has been selected.

   b. Selecting Extract codes downloads a XLSX file that contains Code, SHA and Region columns

   

Download Codes#

If you want to download one or more function codes, follow these steps:

1. Choose Functions in Main toolbar.

2. Select one or more function.

   a. Select the top checkbox to select all functions in the view, or select individual checkboxes to select one or multiple functions

3. From drop-down menu More actions choose Download codes

   a. If action Download codes is greyed out, it means that no function has been selected.

   b. Selecting Download codes downloads a TXT file that contains functions’ codes (as in you can see below, one function code per one row)

   

Select from File#

If you want to select one or more functions from the file, follow these steps:

1. Choose Functions in Main toolbar.

2. From drop-down menu More actions choose Select from file

   a. Choosing Select from file brings up the Select from file screen

   

   No.	Field / Button code	Description
   1	Upload a file	Drag & drop a txt file from your computer or select a txt file through File Explorer.
   2	Upload	Uploads the loaded file. When clicked, the file gets uploaded and all elements provided in it are compared with elements on the environment.
   3	Select	Selects (checks checkboxes) for elements on the list from the provided file.

3. Drag&drop desired file or Click to upload a file and choose file in File explorer.

   a. Correct TXT file should look like this:

   

   b. If you choose a file with extension other than TXT, then validation error will pop up

   

4. When the progress bar reaches 100%, you will be informed which functions will be selected.

   a. Functions present in Selected elements table will be selected in step 5. These functions exist both in the TXT file and on the environment.

   b. Functions present in Missing from table will not be selected in step 5. These functions exist only in TXT file therefore, they cannot be selected on the environment.

   

5. Choose Select.

   a. All functions that were present in Selected elements table get selected (checkboxes associated with these functions are checked).

Compare with Extract#

Makes a comparison between file and the environment, gives information which element are the same, which changed and which are only in file or only in the environment.

1. Choose Functions in Main toolbar.

2. From drop-down menu More actions choose Compare with extract.

   a. Choosing Compare with extract brings up the Compare with extract screen.

   

3. Drag&drop desired file or Click to upload a file and choose file in File explorer.

   a. Correct XLS/XLSX file should look like this:

   

   b. If you choose a file with extension other than XLS/XLSX, then validation error will pop up

   

4. When the progress bar reaches 100%, you will be informed about the status of all functions present in the environment and the extract file you provided.

5. In Select section (visible below table with functions’ status) choose which functions will be selected

   a. You can select multiple options

   b. Matching - functions that are equal between the environment and the extract file will be selected.

   c. Different region - functions that are equal but with different regions between the environment and the extract file will be selected.

   d. Different name - functions that are equal but with different name between the environment and the extract file will be selected.

   e. Missing from extract - functions that are present in the environment but absent from extract file will be selected.

6. Choose Select button.

   a. If Select button is greyed out, it means that no checkboxes were selected in step 5.

   b. All functions that match the criteria provided in step 5 are selected.

Assign Profile#

If you want to assign a profile to one or more functions, follow these steps:

1. Select Functions from the Main toolbar.

2. Select the functions without an assigned profile by checking the boxes on the left side of the list.

3. From the More Actions drop-down menu, choose Assign Profile.

   a. Selecting Assign Profile opens the Assign Profile screen.

4. Select the profile to which you want to assign the function and confirm by clicking Change.

On the functions list view, a profile entry will appear for the assigned functions. The view will also be updated to reflect the selected profile.

Make Global#

If you want to detach one or more functions from a profile, follow these steps:

1. Select Functions from the Main toolbar.

2. Select the functions with an assigned profile by checking the boxes on the left side of the list.

3. From the More Actions drop-down menu, choose Make Global.

   a. A confirmation pop-up will appear.

4. Click Confirm.

On the functions list view, the profile entry will disappear for the selected functions. The view will also be updated to global.

Add Region#

To attach a function to a region, function must first be assigned to a profile. A region belongs to a profile.

If you want to add a region to one or more functions, follow these steps:

1. Choose Functions in Main toolbar.

2. Select one or more functions without a Region.

   a. Select the top checkbox to select all functions in the view, or select individual checkboxes to select one or multiple functions.

3. From drop-down menu More actions choose Add region.

   a. If action Add region is greyed out, it means that no function has been selected.

   b. Choosing Add region brings up the Manage versioning screen.

   

4. Select Region and one or more Version.

5. Choose Change.

   a. Region is being assigned to all functions selected in Step 2.

   b. If at least one function you selected in Step 2 had assigned Region, then validation error appears and assigning Region process will be aborted.

Remove Region#

If you want to remove region from one or more functions, follow these steps:

1. Choose Functions in Main toolbar.

2. Select one or more functions with a Region.

   a. Select the top checkbox to select all functions in the view, or select individual checkboxes to select one or multiple functions.

3. From drop-down menu More actions choose Remove region.

   a. If action Remove region is greyed out, it means that no function has been selected.

   b. After choosing Remove region action, confirmation pop-up will appear.

   

4. Choose Confirm.

   d. Regions are being removed from all selected functions.

Manage Tags#

If you want to manage tags for one or more functions, follow these steps:

1. Select the Functions on the Main toolbar.

2. Select one or more functions.

3. From the More Actions drop-down menu, select Manage Tags.

4. Select the tags you are interested in and click Save.

Remove Function#

If you want to delete one or more functions, follow the steps below:

1. Choose Functions in Main toolbar.

2. Select one or more functions.

   a. Select the top checkbox to select all functions in the view, or select individual checkboxes to select one or multiple functions.

3. From the drop-down menu More actions choose Remove

   a. If action Remove is greyed out, it means that no function has been selected.

   b. After choosing Remove action, confirmation pop-up will appear.

   

4. Choose Confirm.

   a. All functions are deleted from the environment.

Function Details Screen#

You can access Function details by left-clicking on the specific function in the List of all functions. Function details screen contains all information about the function, its Description, assigned Region/Tags, function body and function arguments.

Firstly, function basic info:

You can see Available actions for the function below:

The main part of the function view includes the most important information about the function that makes it work:

Edit Function#

If you want to edit data in a specific function, follow these steps:

1. Choose Functions in Main toolbar.

2. Left-click on the function you wish to edit.

   a. Left-clicking on function opens Function details screen.

3. Choose Edit in Available actions.

   a. Highlighted borders indicate that edit mode is active.

   

4. Edit any data you need.

   

   No.	Action	Description
   1	Description	Contains the Description of the function if such was added.
   2	Change	Allows to manage tags.
   3	Add argument	Adds a new argument for which name, type, and class name will have to be provided.
   4	Function body	Here you can write a code to create your algorithm. You can define variables and use arguments defined in the Argument section.
   5	Cancel	Rejects all changes made in the edit mode.
   6	Save changes	Saves all changes made in the edit mode.

   a. Bear in mind that function’s name can only be changed with Rename action.

5. Choose Save changes to save all changes made in the function.

   a. Cancel reverts all changes made in the function.

Duplicate Function#

If you want to duplicate specific function, follow these steps:

1. Choose Functions in Main toolbar.

2. Left-click on the function you wish to duplicate.

   a. Left-clicking on function opens Function details screen.

3. Choose Duplicate in Available actions.

   a. Choosing Duplicate brings up the Duplicate function screen.

   

   No.	Action	Description
   1	Name	Provide the name for the duplicated function.
   2	Cancel	Abort the process of duplicating the function.
   3	Save changes	Save the new, duplicated, element.
   4	Close	Abort the process of duplicating the function.

4. Enter unique function name. Name can contain only characters from collection a-z; 0-9; “.”; “-”; “_” and it can’t start with “-”.

5. Choose Save changes.

   a. If you enter illegal characters, then validation error will make the field frame red.

   

   b. If another function already uses the name you provided, then pop-up dialog will appear. You can either close the pop-up by clicking Cancel or you can click View existing function, that will redirect you to the appropriate function.

   

6. Choose Save changes.

   a. The Function will be duplicated with the name provided in step 4. You will be redirected to duplicated Function’s details screen.

Show History#

If you want to check all modifications made on function, follow these steps:

1. Choose Functions in Main toolbar.

2. Left-click on the function you want to check.

   a. Left-clicking on function opens Function details screen.

3. From drop-down menu More actions choose Show history.

   a. Choosing Show history brings up the Function history screen.

   

   No.	Column name	Description
   1.	Operation	Type of operation made on function.
   2.	Message	Brief information about the details of the operation.
   3.	Author	User’s login that made an operation.
   4.	Modification Date	Date of the published session that made an operation.
   5.	Region	Region and version assigned to function at the time of modification.
   6.	Actions	View redirects to archived version of Function. In this screen you can choose Restore to restore that version of Function.

Rename#

If you want to rename a function, follow these steps:

1. Choose Functions in Main toolbar.

2. Left-click on the function you wish to duplicate.

   a. Left-clicking on function opens Function details screen.

3. From drop-down menu More actions choose Rename.

   a. The Highlighted border around the function name indicates that it is editable.

   

4. Enter unique function name. Name can contain only characters from collection a-z; 0-9; “.”; “-”; “_” and it can’t start with “-”.

5. Choose Save name.

   a. If you enter illegal characters, then validation error will appear.

   

Find Usages#

If you want to check where the function is used, follow these steps:

1. Choose Functions in Main toolbar.

2. Left-click on the function you want to check.

   a. Left-clicking on function opens Function details screen.

3. From drop-down menu More actions choose Find usages.

   a. Choosing Find usages brings up the Find usages screen. The screen displays a list of objects in which the function has been used

   

   No.	Column name	Description
   1.	Element type	Type of element that uses this function.
   2.	Element name	Name of the element that uses this function.
   3.	Field	Value of the element that uses this function. This column is filled only for Attribute value element, for other elements this column is empty.
   4.	Value	Informs the user in what value the searched element was used.

Remove (Details View)#

If you want to delete specific function from Function details level, follow these steps:

1. Choose Functions in Main toolbar.

2. Left-click on the function you wish to remove.

   a. Left-clicking on function opens Function details screen.

3. From drop-down menu More actions choose Remove.

   a. After choosing Remove action, confirmation pop-up will appear.

   

4. Choose Confirm.

   a. The Function is deleted from the environment.

Util functions are small, general-purpose functions designed to perform simple, often repetitive tasks. They are generic and can be used in various places in Higson configuration, which helps organize, maintain, and increase the readability of configuration.

Features of Util Functions:

• Clearly defined purpose: Util functions perform a single, specific operation, such as date formatting, string manipulation, data type conversions, validations, etc.
• Independent of specific business logic: They are neutral and can be reused across different projects.
• Reusable: They are created to be used multiple times in different parts of the configuration.

In summary, util functions are tools that make it easier to handle common and repetitive tasks in Higson, improving the structure and organization of configuration.

You can use util functions in Domain Configuration and Decision Tables. To call a util function in Higson configuration, use the notation $u utilFunctionName().

The following util functions are available in Higson:

• Equals
• Add
• Diff
• Exist
• Format
• From
• GreaterThanEquals
• GreaterThan
• IsBlank
• LessThanEquals
• LessThan
• NotBlank
• Size
• To
• Trim
• NotEmpty
• Get
• IsEmpty

Examples#

Equals#

This method checks if a value from the Higson context is equal to another value.

Function arguments (mandatory 2 arguments):

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example 1: $u equals(context.path, 100)

• The first argument should be the path to the target object in the context.
• The second argument should be the value to compare with the target object (it can be a number or date).

Function arguments (optionally 4 arguments):

• First argument: path to the target object.
• Second argument: value to compare with the target object.
• Third argument: ignoreCase for case-insensitive comparison.
• Fourth argument: trim to ignore leading and trailing whitespace.

Example 2: $u equals(context.path, 100, ignoreCase, trim)

Return: True or false based on the comparison.

Add#

This method performs an addition operation based on the given arguments. Note: Numbers given as text in the context are interpreted by Higson as numbers

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example 1: $u add(ctx, arg) For numeric attributes, only two arguments are needed: context path and value to add.

Example 2: $u add(ctx, 10, d) For date type attributes, three arguments are needed: context path, value to add, and string representation of the time token (e.g., “d” for days).

The following table shows the supported time tokens.

Return: The result of the addition operation, or null if the value is blank.

Example 3: $u add(ctx.path1, ctx.path2) - adds two elements provided by the HigsonContext

Return: The result of the addition operation, or null if the value is blank.

Diff#

Calculates the difference based on the given arguments and the target object.

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example: $u diff(ctx, arg)

• The first argument is the path to the target object.
• The second argument is the value to subtract from the target object.
• The third argument (optional) is the string representation of the time token (for date formats).

Return: The result of the difference calculation, or:

• If the target object and the diff value are both numbers, the method returns the subtraction of the two values.
• If the target object is a Date or LocalDateTime, and the diff value is a number, the method returns the difference in time based on the provided time token.
• If the target object is a String, the method returns the modified string after applying the difference operation.
• If none of the above conditions match, the method returns the target object as is.

Throws: HigsonRuntimeException if the target object is a number and the diff value is not a number, an exception is thrown.

Exist#

Checks if a value exists in the given context.

Function arguments:

• ctx: The HigsonContext object.

Example: $u exist(ctx.path)

Return: True if the context value exists. False if the ctx.path is an empty string.

Format#

Formats data according to a given pattern. Applies to the following data types:

• Number/Integer
• String
• Date

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example: $u format(ctx, arg) $u format(1.2345, 2) → 1.23 Return: The formatted output based on the type of the object retrieved from the context.

Throws: HigsonRuntimeException if the format utility function is missing the format argument or if the type is unsupported.

From#

This function is used to extract a substring from a string or extract some elements from a list.

• if object is String then function will return part of string after indexed passed in the second argument
• if object is List then function will return part of list after indexed passed in the second argument
• in other cases function will throw exception with unsupported type

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the ‘from’ util function.

Example: $u from(ctx, arg) $u from(abcdef, 5) → f

Return: The result of the ‘from’ util function or null if the target is null or of an unsupported type.

Throws: HigsonRuntimeException if a required argument is missing, or if the target is of an unsupported type.

Greater Than Equals#

Checks if a value from the Higson context is greater than or equal to another value.

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example: $u gte(ctx, arg)

The method supports comparing various types, including:

• Strings: Compares lexicographically.
• Numbers: Compares numerically.
• Dates (java.util.Date, LocalDate, LocalDateTime): Compares chronologically.

Return: True if the target object is greater than or equal to the given value, otherwise false.

Throws: HigsonRuntimeException if fewer than two arguments are provided.

Greater Than#

Checks if a value from the Higson context is greater than another value.

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example: $u gt(ctx, arg)

• The first argument should be the path to the target object in the context.
• The second argument should be the value to compare with the target object.

The method supports comparing various types, including:

• Strings: Compares lexicographically.
• Numbers: Compares numerically.
• Dates (java.util.Date, LocalDate, LocalDateTime): Compares chronologically.

Return: True if the target object is greater than the given value, otherwise false.

Is Blank#

Checks if a value from the Higson context is blank.

This method considers an object blank if it meets one of the following conditions:

• It is null
• It is the string “undefined”
• It is an instance of ParamValue and its isBlank method returns true
• It is an instance of MultiValue and its isBlank method returns true
• It is an instance of ValueHolder and its isBlank method returns true
• It is an instance of Collection and it is empty or all its elements are blank
• It is an array and all its elements are blank
• It is an instance of Map and all its values are blank
• It is a CharSequence (like String, StringBuffer, etc.) and is blank, that is when text has no characters or there is no other character than whitespace.
• It is an instance of Iterable and it is empty or all its elements are blank

Function arguments:

• ctx: The HigsonContext object.

Example: $u isBlank(ctx.path)

Return: True if the object is blank, false otherwise.

Is Empty#

Checks if a value from the Higson context is empty.

Function arguments:

• ctx: The HigsonContext object.

Example: $u isEmpty(ctx)

Return: It retrieves the value from the context using the given path and returns:

• false: if value is not string, collection, map, array, ParamValue
• false: if value is not empty string
• false: if value is collection or map, array but it is not empty
• true: if value is empty string or is null
• true: if value is collection, map or array but it is empty
• true: if value is null
• true: if value is ParamValue but it is empty, meaning does not contains any value inside of it

Less Than Equals#

Checks if a value from the Higson context is less than or equal to another value.

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example: $u lte(ctx, arg)

• The first argument should be the path to the target object in the context.
• The second argument should be the value to compare with the target object.

The method supports comparing various types, including:

• Strings: Compares lexicographically.
• Numbers: Compares numerically.
• Dates (java.util.Date, LocalDate, LocalDateTime): Compares chronologically.

Return: True if the target object is less than or equal to the given value, otherwise false.

Throws: HigsonRuntimeException if fewer than two arguments are provided.

Less Than#

Checks if a value from the Higson context is less than another value.

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example: $u lt(ctx, arg)

• The first argument should be the path to the target object in the context.
• The second argument should be the value to compare with the target object.

The method supports comparing various types, including:

• Strings: Compares lexicographically.
• Numbers: Compares numerically.
• Dates (java.util.Date, LocalDate, LocalDateTime): Compares chronologically.

Return: True if the target object is less than the given value, otherwise false.

Throws: HigsonRuntimeException if fewer than two arguments are provided.

Not Blank#

Checks if a value from the Higson context is not blank.

Function arguments:

• ctx: The HigsonContext object.

Example: $u notBlank(ctx)

Return: It retrieves the value from the context using the given path and returns:

• false: if value is null
• false: if value is not string, collection or map , array, ParamValue
• false: if value is string, collection or map , array, ParamValue but it is blank
• true: if value is blank string
• true: if value is collection or map but it is empty

Size#

Retrieves the length of a string attribute from context.

Function arguments:

• ctx: The HigsonContext object.

Example: $u size(ctx)

Return: The length of the string or collection, or null if the object is null or of an unsupported type.

Throws: HigsonRuntimeException If the object is of unsupported type.

To#

Calls the ’to’ util function with the given context and arguments.

• if object is String then function will return part of string to indexed passed in the second argument
• if object is collection then function will return part of list to indexed passed in the second argument
• in other cases function will throw exception with unsupported type
• if object is a null then returned value is a null

Function arguments:

• ctx: The HigsonContext object.
• args: The arguments passed to the method.

Example: $u to(ctx, arg) $u to(abcdef, 5) → abcde Return: Part of the string or collection up to the indexed position passed in the second argument or null if the target is null or of an unsupported type.

Throws: HigsonRuntimeException if a required argument is missing, or if the target is of an unsupported type.

Trim#

Trims values in a given context, removing leading and trailing whitespaces.

Function arguments:

• ctx: The HigsonContext object.

Example: $u trim(ctx)

• If the value is null, returns null.
• If the value is a Number, returns its decimal representation.
• If the value is a Boolean, returns its boolean representation If the value is a Number, returns its decimal representation.
• If the value is a Date, returns its Date representation.
• If the value is a LocalDate, returns its LocalDate representation.
• If the value is a LocalDateTime, returns its LocalDateTime representation.
• If the value is a collection, filters out null values and returns the filtered array.
• If the value is a CharSequence, trims it and returns the trimmed String.

Return: The trimmed value, or the original value if no trimming is possible.

Not Empty#

Checks if a given object is not empty.

Function arguments:

• ctx: The HigsonContext object.

Example: $u notEmpty(ctx)

Return: True if the context object is not empty, false if it is empty.

Get#

Retrieves a value from the Higson context.

Function arguments:

• ctx: The HigsonContext object.

Example: $u get(ctx, arg)

Return: The value from the context using the provided path.

The Higson function is a Groovy code snippet stored in the Higson application database. Its primary purpose is to perform business logic computations. Higson functions can be executed in multiple ways: programmatically via the Higson engine object, through the Higson Runtime REST API, or within the Tester module. In addition to being directly invoked via the engine or REST, functions can also be used as part of other functions, within a decision table, or as an output values for Domain attributes.

Higson functions consists of the following components:

• Name: The function’s unique identifier.
• Body: The core Groovy code snippet that implements the function’s logic.
• Definition: This section contains the function’s description and any assigned tags.
• Arguments: A list of arguments defined by the user. Each argument consists of a name and type. Supported argument types include:
  • Boolean (similar to Java’s boolean)
  • Integer (similar to Java’s int)
  • Decimal (similar to Java’s BigDecimal)
  • Date (similar to Java’s Date)
  • Local Date (similar to Java’s LocalDate)
  • Local DateTime (similar to Java’s LocalDateTime)
  • String (similar to Java’s String)
  • Object (similar to Java’s Object)

By default, each Higson function has a special argument called ctx, which references the context object. This context object is accessible within the function body. For further details on this topic, refer to the documentation below.

Available Objects in the Function Body#

Several objects are accessible within the function body, including:

• ctx: The context object, representing the default argument of the function.
• higson: An object providing access to decision tables and function calls.
• log: A reference to the logger utility class.
• date: A utility class for working with dates supported by Higson.
• math: A utility class that provides mathematical functions for use within Higson functions.
• str: A utility class for working with strings.
• util: A reference to a common utility class.
• type: A reference to a utility class for programming types.
• domain: A reference to a utility class for domain types.

Built-in Type Converters#

Higson also includes a set of built-in type converters, which help convert values between different data types. These converters are:

Retrieving Values from a Decision Table#

The following table outlines the structure of decision table calls, detailing the type of data returned and the default values in case of missing data:

EXAMPLE: Retrieving Value from a Decision Table

In this example, we will demonstrate how to retrieve a value from the decision table demo.motor.coverage.bi.tariff. This decision table has two IN levels defined by gender and age, with the values for these levels being sourced from the context data (see picture below). The result of the decision table lookup will be the tariff’s factor from the output level.

To retrieve the output from the decision table demo.motor.coverage.bi.tariff use the following code:

def factor = higson.getNumber('demo.motor.coverage.bi.tariff', ctx)

Code breakdown:

• higson.getNumber is used to query the decision table demo.motor.coverage.bi.tariff.
• The argument, ctx, allows reaching into the object context.
• The decision table reads the levels (gender and age) from the context and identifies the corresponding row.
• Based on this input, the appropriate output row is returned, containing the tariff’s factor.

Working with a Matrix#

When a value from a decision table is assigned to a variable, we often want to use that value later in the function code. Below are some tips on how to work with variables containing a matrix.

To assign the result of a decision table call (based on data from the context) to a variable:

def matrix = higson.getValue('decisionTableName', ctx)

Once the matrix is assigned, you can call various methods on the matrix variable:

matrix.size()
matrix.isEmpty()
matrix.rows()

You can also iterate over the matrix to access its individual rows:

for (def row in matrix) {
    def value = row.getNumber( ‘columnName’ )
    def value = row.getDecimal( ‘columnName’)
    ...
}

Calling Other Functions#

To call another function from within the body of your function, use the following syntax:

higson.call(‘functionName’, ctx)

If the function you are calling requires arguments, you can pass them as follows:

higson.call(‘functionName’, ctx, arg1, arg2, ..)

where arg1, arg2, etc., are optional arguments for the function.

When calling another function, make sure to consider the data type it returns. The table below outlines various function calls and the types of data they return:

EXAMPLE:

def result = higson.callDecimal(‘pl.decerto.demo.telco.hardware.activation.price.calculator’, ctx, packageCode)

Keep in mind that the order of the arguments must match the order in which they were defined in the function. The ctx argument is always the first one, as it is automatically included when the function is created

Accessing Domain Elements#

The table below lists methods for accessing domain elements, along with the results returned by each method.

Domain paths should be written according to this pattern:

/Collection1[Collection1_Element]/Collection[Collection2_Element]

EXAMPLE 1:

def domainObj = domain.get(‘DEMO’, ‘/PLANS[FULL]’)

In this example, we access the FULL element in the PLANS - Rating Plan collection in the Domain Configuration of profile DEMO, as shown in the screen below.

EXAMPLE 2:

def rootObj   = domain.get(‘DEMO’)

In this example, we access directly to the ROOT of the profile DEMO.

Reading Domain Attributes#

The table below outlines methods for accessing domain attributes and the corresponding data types returned by each method.

EXAMPLE:

In this example, we’ll demonstrate how to retrieve the Position attribute from a domain configuration, similar to the one shown in the screenshot below.

Steps to Retrieve the Position Attribute

1. Access the Domain Configuration: First, we access the relevant domain configuration element.
2. Retrieve the Position Attribute: Once we have the element, we retrieve the Position attribute using the getAttrInteger method.

Code:

def coverage = domain.get('DEMO', '/PLANS[FULL]/COVERAGES[BI]')
def position = coverage.getAttrInteger('POSITION', ctx) 
return position

Reading Code and Name#

Dedicated functions are available to retrieve the code and name of a domain element. Below are examples demonstrating how to call these functions.

EXAMPLE: Reading the BI element code

def coverage = domain.get('DEMO', '/PLANS[FULL]/COVERAGES[BI]')
def coverageCode = coverage.code

EXAMPLE: Reading the BI element name

def coverage = domain.get('DEMO', '/PLANS[FULL]/COVERAGES[BI]')
def coverageName = coverage.name

Reading Values from Context#

The table below lists methods for accessing context elements, along with the data types they return.

Context Path Format#

Context paths should follow this pattern:

Type1.Type2.Type2_Attribute

EXAMPLE:

def value = ctx.getInteger(‘quote.driver.age’)

In this simple example, age is an attribute of the Driver type, which is a subtype of the Quote type. Note that the ROOT is omitted in context paths.

Getting Collection#

To retrieve a collection, use the following method:

def collection = ctx.get(collectionPath)

You can iterate over the collection elements as shown below:

for (elementCtx in collection) {

    def x = elementCtx.getNumber(relativePath)
}

Getting Sub-Context or Intermediate Node#

To retrieve a sub-context or an intermediate node, use the following methods:

def node = ctx.get(nodePath)
def value = node.getString(relativePath)

EXAMPLE:

def risks = ctx.get('policy.risks')
for (def risk in risks) {
    def premium = risk.getDecimal('premium')
    def sumInsured = risk.getDecimal('sumInsured')
}

In example above, we navigate to the risks context node, then retrieve the values of the premium and sumInsured attributes (both of type number) into the corresponding variables.

Using Functions in Cascade Expressions#

In complex business configurations, operations on objects or data often need to be performed sequentially, where one operation triggers another. In Higson, cascade expressions allow this kind of functionality and can be used in the following configuration elements:

• Value source field of decision tables
• Cells in the matrix of the output levels of decision tables
• Domain attributes

EXAMPLE:

$f fun (1, ctx:risk.code) [factor]

In this example, the function fun is executed with the value of ctx:risk.code as an argument, and the result is filtered by the factor element if the return type is a complex object.

Higson Function Example#

Above function calculates the total premium for a policy based on the premium per day and the number of days the policy is active.

Using Flows in Cascade Expressions#

To call a flow use $w notation.

EXAMPLE:

$w flow (1,active)