skip to Main Content

By pressing Add Action Helpers navigates you to a new pop up window as shown in the example where you fill out the new action helpers information. Some fields are mandatory, some are optional for the creation of action helpers.

Action helper creation fields

Name String
Mandatory
The label that will be shown whenever you will need to select an action helper.

Key String
Mandatory
The key represents the original representation of the action where the name is a label that can be added as a descriptor.

Example – a client sends a lower case “win event” where the name of the key can be upper case but the key must be the same as the clients sent “win event”.

Description String
Optional
The description of the action helper for the clients usage.

Unit type Enum
Mandatory
Action helper measurement type:
  • Other
  • Currency
  • Mass
  • Time
  • Temperature
  • ElectricCurrent
  • AmountOfSubstance
  • LuminousIntensity
  • Distance

Metadata Object
Optional
It is used for storing information in the client’s data base. Optional information for client’s reference.

If you filled out all the information correctly, then you can press the icon button Save and the Action Helper will be saved.

If the information is filled out incorrectly the information bar will be shown in red. If the information is filled out incorrectly the information bar will be shown in red. If you did all the steps correctly the Action Helper should be created in the Settings → Action Helpers and shown as in an example. After creation you can Edit the helper or Delete the action helper from the list.

If the information is filled out incorrectly the information bar will be shown in red as in an example below.

Back To Top