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.
ATTENTION: The "Tenant Event Administrator" can only edit the custom properties of the events and the general administrator can edit the custom properties of the "Event Users".
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.
To create a property, there are the following elements to fill in:
Give a name to the new property to be created. This name is displayed if there is no label for the current user language.
Select here which data type the property should have
Here you can choose between the following elements:
- NUMBER (with decimals) (Ex: "How many times have you attended a digital conference?")
- CHECKBOX (Ex.: "Are you a student?")
- Textfield (free text) (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.
When selecting "Image" as a property value type, you can upload images for the selected availabilities in your event, sessions and users and use them as a custom property.
This property value type is currently not supported and cannot yet be included in a user registration form.
Available for event
Select here whether the property should be created for the event.
If you check the box, the property can be used for the configuration of events.
Available for session
Select here whether the property should be created for the session.
If you check the box, the property can be used for the configuration of sessions.
Available for user
Select here whether the property is to be created for users.
If you check the box, the property can be used for configuration in the user profile.
By setting a tick in the checkbox, you decide whether the property should be displayed on the interface. The property is then displayed in the user and event settings.
These settings can be adjusted at any time.
Select here for whom the user-defined property should be available. You can choose between three options:
- Backstage User
If "Backstage User" is selected, only the Backstage User , i.e. Tenant User, can see the values of the custom property and no other roles. This role also appears in the Excel export of the user data. Normally, only administrators of the event have this role - stage users do not have access to these properties.
- Logged in Users
If "Logged In Users" is selected, only users registered for the event can see the values of the custom property and no other roles. Usually, administrators and stage users (e.g. Event Administrator, Administrator, Speaker) have this role.
Detailed information on STREAMBOXY roles can be found here.
If "Anonymous" is selected, the values of the custom property are visible to everyone. For example, participants who are not logged in will then also have access to the values of the user-defined properties.
If you want to use the user-defined property in the registration form, you have the option here to add a tooltip.
This is then displayed to the user by hovering the mouse over it.
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.
More information on the multilingualism can be found here.
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.
Event custom properties
After you create the custom properties in your tenant settings, you can manage them in the following places in the respective events:
- Event Users
- User Registration