Parameters and Instances





Parameters and instances

Interactions can include parameters that define instances of the interaction. This allows a single interaction to have multiple variations, which the client can select from the interaction screen (for the interactions with initiation media “Button”) or by scanning a QR code (for the interactions with initiation media “QR“). For example, an interaction“Open Door” could have different instances - “1,” “2,” and “3.” As a result, your client (an app user) will have to select the intended goal: “Room 1,“ “Room 2,“ or “Room 3.“


Add parameter


Go to the “Interactions“ page, and either click “Add interaction“ or select an existing interaction where you'd like to add a parameter.

Click the “Instances“ tab.


Screen Shot 2024-02-03 at 01.58.29-20240202-235926.png


On the new page, click “+ Parameter.“ You will see a box with two fields. In the relevant fields, provide a name for the parameter (required) and a default value (optional).

A single interaction might have several parameters.

You can edit or delete saved parameters.


Screen Shot 2024-02-03 at 02.00.22-20240203-000112.png

Create, edit or hide an interaction instance


Go to the “Interactions“ page, and either click “Add interaction“ or select an existing interaction where you'd like to add an instance.

Click “Instances“ tab.

On the new page, click “Add instance“ to create a new one. You will see a new box with the parameter name(s) and an empty field next to each paramater name.

Set an instance parameter value in the field of the proper parameter name.

If the interaction’s initiation media is “Button,” the mobile app user needs to select a specific instance before initiating this interaction.

If the interaction's initiation media set to “QR”, the mobile app user will scan a QR code, automatically initiating a particular instance of the interaction.

For example, if the goal is to allow a hotel guest to access their room by scanning a QR code, set the initiation media as “QR,” and the instance parameter name as “Room.” The instance parameter values could be “1,” “2,” and “3,” resulting in instances named “Room 1,” “Room 2,” and “Room 3.”

To enable a guest to open only a specific room, set a predicate on the attribute of the required credential. For example, the predicate could be: The value of the attribute named “Room” {number} of the required credential “Key” is equal to the value of the instance of the “Room” parameter of this interaction (Room 1 = Room 1 is true)."

More information about predicates can be found in the “Add predicates“ section of the “ “ page.




Edit an interaction instance

You can edit instances any time you want. Simply update the information you want to change. Your updates will be saved automatically.



Hide an interaction instance

Saved instances can not be deleted.

If you no longer need an existing instance in your interaction, you can hide it from the app user.

Click on the "Hide" icon next to the selected instance.

This setting can be helpful if there are many instances in your interaction and you want to simplify the user experience by displaying only the most commonly used ones.