When adding a new property to a Component, you can always
- Set the name of that property
- Add a description to that property, so the users adding content will have context about what this property is used for.
Some property types will have additional metadata fields that are detailed below.
NOTE: Many more property types are to come. This article will be updated as more properties are released.
Text Property Types
- Min characters: The minimum number of characters permitted. Default value: 0
- Max character: The maximum number of characters permitted. Default value: 250. Max value: 500. If you need longer text, use the Long Text property type.
- Max size: The maximum number of characters permitted. Default: no limit. This value can be set to 250, 500, 750, 1000, or no limit.
Media Property Types
- Max size: The maximum size permitted for an image to be uploaded. Default: 5MB. This value can be set to 5, 10, 15, 20MB, or No limit (not recommended).
- Accepted formats: The formats accepted for an image to be uploaded. Default: all supported extensions.
- Max size: The maximum size permitted for a video to be uploaded. Default: 100MB. This value can be set to 100, 200, 300MB, or No limit (not recommended).
- Accepted formats: The formats accepted for a video to be uploaded. Default: all supported extensions.
- Max size: The maximum size permitted for a document to be uploaded. Default: No Limit. This value can be set to 5, 10, 15, 20MB, or No limit (not recommended).
- Accepted Format: Only PDF files are supported.
Specific Value Property Types
This property type doesn't have any additional properties and will accept Null (meaning not defined), True or False as a value.
You can easily use it in your experience to, for example, specify whether an asset should be visible, or if a Toggle Button should be checked.
- Min digit number: minimum number of digits a base user can enter, with or without decimals.
- Max digit number: maximum number of digits a base user can enter, with or without decimals.
This property type doesn't have any additional properties and presents a dedicated color picker panel in the Content tab of the H-CMS. The value is stored as an hexadecimal number that can be used via binding with any Color property in Composer (e.g. Text font color, Button fill color, ...).
This is the color picker in the Property view.
- Include a time field: If unchecked, the property will only contain date information (day, month, year). If checked, the property will also contain time information (hour, minute, second).
- Limit the date range: If checked, a base user in the Content panel will only be able to enter a date within the range specified between Start Date and End Date.
- Time derived from: This property defines which time zone is used when a user enters a date and time. If you are only using this field to display time information, set the value to "Player local time". If you are using this date and time property to control actions that must occur at the same time across regions, use "Content editor local time".
- Content editor local time (default): The date and time entered will be synchronized with the editor's local time regardless of a Player's location.
- Player local time: The date and time entered will not be synchronized across time zones, but rather specific for each time zone.
- Content editor choice: the base user in the Content panel will have the choice between the two options above.
Date Time use case examples
- Simply display a date and time as information, such as an event list / calendar. The "Time derived from" property doesn't apply in this case.
- Schedule content to be displayed at a given date during a certain period of time, using a filter on that property and comparing its value to the Clock Interface Asset value. If you have players deployed in multiple states or countries with multiple zones and
- You want the content to be displayed between 7am and 12pm, local time, wherever the Player is running (ex: breakfast menu). Select "Player local time".
- You want the content to be displayed between 8pm and 10pm GMT, maybe during a broadcasted event, wherever the Player is running (ex: worldwide sports game). Select "Content editor local time. In this case, if the editor's browser/computer is set to GMT, then the/she only needs to enter 8pm and 10pm.