User-defined property schemas can be used to set up custom properties for Teamworks AMS applications. This tool was developed to give builders even more configuration options when building event forms for mobile applications.
The user-defined property schemas tool is located in the builder interface, so any person with builder access can see the tool. However, we recommend you initially contact your Product Success Manager to make sure it’s the best solution for your workflow.
Once a user-defined property schema has been added to your builder site, it will appear in the left sidebar when editing a form, section or field (this will depend on the Applies to setting, explained below). The Category of the schema will define the name of the sidebar section your property appears in.
Steps to create a user-defined property schema
You’ll find the required information for setting up supported schemas below, but we do recommend you discuss this tool with your Product Success Manager before implementing it on your site.
- Log in to the builder interface.
- Select the User-defined property schemas tool. This will only be visible if you have the appropriate system permission as part of your role.
- Give your property schema a Name. This will display as the property’s name in event forms and fields, so should clearly describe the function.
- Give your property schema a Description. This will display as a tooltip beside the property name, so is useful for providing additional context to the builder.
- Specify what item the property schema Applies to. This will be set to Form, Section or Form item, depending on the nature of the property.
- Choose the type of Selector for the property schema, which determines how you will set the property. The options available include Text, Number, Dropdown or Multiple selection. Each available schema will require a specific selector type based on its intended function.
- If the property schema’s selector type is set to drop-down or multiple selection, add the appropriate Options for the property. You will see these options populated in the property when setting it in an event form, and they must be the correct options for the schema that you’re using.
Supported schemas
Bluetooth Input Device
Lock Entry DateTime
It is possible to configure individual fields in an event form to receive data directly from a Bluetooth device. Any field configured for this will not be available for manual entry, and users of the app will only be able to input data into the field if they have the correct Bluetooth device. This property can be used for multiple fields within the same event form, and can be applied to forms being used in the AMS mobile app.
Enabling this setting does not automatically work for any Bluetooth device. Currently, the following Bluetooth devices are supported:
- Kinsa Thermometers:
- Kinsa QuickCare Smart Thermometer
- Masimo Pulse Oximeters:
- MightySat Rx (3 and 5 parameters)
- MightySat Consumer
- Rice Lake Bluetooth scales
Third-party device manufacturers tend to change their products, discontinue and introduce new models. Sometimes, these new products have the same name as older devices but work differently. Please check with your Product Success Manager before committing to a particular device based on the list above.
The Bluetooth property schema must adhere to the following settings:
- Name: Bluetooth Input Device (suggested)
- Description: Use this setting to assign the field to a Bluetooth device (suggested)
- Categories: Bluetooth Device (enforced)
- Key: bluetooth-input (enforced)
- Applies to: Form Item (enforced)
- Selector: Dropdown (enforced)
-
Options (enforced – must have at least one of these options):
- kinsa-thermometer-c
- kinsa-thermometer-f
- masimo-pulseox-pr
- masimo-pulseox-spo2
- masimo-pulseox-pvi
- rice-lake-healthweigh-kg (enforces value is saved to AMS in kilograms)
- rice-lake-healthweigh-lbs (enforces value is saved to AMS in pounds)
- rice-lake-healthweigh (respects whichever unit is selected on scales)
- rice-lake-h150-10-7 (respects whichever unit is selected on scales)
If using Bluetooth scales, you only need to configure one of the options from the list above. If you are recording weight in pounds, we recommend using the rice-lake-healthweigh-lbs option. If you are recording weight in kilograms, we recommend using the rice-lake-healthweigh-kg option.
Once the Bluetooth input custom property is enabled for a field, you will see the Bluetooth-enabled field in the event form. For an example of how this can be configured for the mobile app, check out our tutorial on Recording data from Bluetooth scales using the mobile app.
This property schema can be applied to an individual event form, and prohibits a user from editing the date and time of a record.
This property is not designed to be used in conjunction with the Date override form property, so must not be used on any forms where this property has been enabled.
This feature is only available for forms being used in the mobile app, and must adhere to the following settings:
- Name: Lock Entry DateTime (suggested)
- Description: Use this setting to prevent users from editing the date and time of a record (suggested)
- Categories: Mobile App (enforced)
- Key: lock_entry_datetime (enforced)
- Applies to: Form (enforced)
- Selector: Dropdown (enforced)
- Options: TRUE, FALSE (enforced)
To enable this schema for the Athlete app, set Categories to Athlete App instead.
As an athlete, you won’t be able to adjust the date and time of a record once this setting is applied to an event form.