What are Custom Properties?
The following article describes how to create and use "Custom Properties".
After creation, Custom Properties can be used for users and/or events. This results in numerous application possibilities, such as the creation of user profiles with interests, address data, etc. or the categorization of events into topics, event types, publication settings, etc.
Custom Properties can be created, set and evaluated manually in the Streamboxy Backstage interface or from external systems via the Streamboxy REST interface.
This allows Streamboxy to be strongly integrated with other systems or extended with custom components.
Creation and management of Custom Properties
You can create Custom Properties for your events and your created participants.
In order to do that, you have to configure the properties in the tenant settings:
In the navigation bar that opens, first click on "Custom properties" and in a second step on the button "+ Add property" in the upper right corner to define and configure properties.
In the following menu you have the possibility to define a property.
Assign an internal name, a property value type (number, boolean, string, date, dropdown, multiple choice) and select whether this property should be created for users, events or both.
Only if the category "visible" is selected, the properties are displayed in the user and event settings.
Property value type
As already enumerated, there are six different value types that can be assigned to a property.
NUMBER (Ex: "How many times have you attended a digital conference?")
BOOLEAN (Yes - No questions, ex.: "Are you a student?")
STRING (Ex: query of the "name")
DATE (Ex: query of the "date of birth")
DROPDOWN (Ex.: query of "gender"; either "male", "female" or "diverse" are queried).
After selecting "drop-down" as the property value type, you can select any number of selection variants for the drop-down list by clicking on "+Add choice".
MULTIPLE CHOICE (ex.: query of "hobbies"; several enumerated hobbies can be selected).
After selecting "Multiple Selection" as the property value type, you can select as many multiple selection variants as you wish by clicking on "+Add choice". While creating a selection variant, you can determine what name, position and visibility it has in the final multiple selection and assign labels as before.
If required, you can translate the property to up to five languages in which it will be displayed depending on the language selection. Labels are defined in English, German, Spanish, French and Italian.
If the value is not available in the user language, the internal name is displayed.
Please note that when creating user-defined properties, the property must first be created in order to then be able to define selection variants (see Dropdwon, Multiple choice), for example.
Set and query Custom Properties
After creating the properties, they can be assigned to users. To do this, you as the organizer must go to your event in the Backstage and click on "Edit event user" next to your event.
Another possibility to edit event users, is to click on "Event User" in the Event Settings. To edit an event user, click on the three dots next to the user and choose "Edit".
When in the edit mode in the tab "Custom Properties", you have the option of selecting your previously created user-defined properties for the respective user.
The properties are also part of the user export, and can be recognized by the "CUSTOM_" prefix.
Once navigated to "Custom Properties" in the event settings, you can assign your previously defined properties for your event.
Custom properties in user registration
While your event name, the date and time of your event are a fixed part of the registration form and the name and email address of the participants are obligatorily requested, you can additionally request further properties.
You define these properties as described above in this article. Examples of user-defined properties in the user registration are company name, date of birth, shoe size, eye colour, etc.