Skip to content

Configure properties

You can expand tebio’s standard data model with your own information using properties or user-defined fields. You individually determine which additional data fields should be recorded for customers, products, subscriptions or sales partners.

You need this function if the platform’s standard fields are not sufficient to reflect your business model. For example, if you want to query customers about a cost center, need an external project ID for subscriptions or need to save specific hardware features for products.

  • You are logged in to the tebio business portal.
  • The Subscription Management product is booked for your tenant.
  • You have sufficient permissions for the platform settings.
  1. Open the settings area: Navigate to the General settings in the tebio Business portal (via the gear symbol) and select Configure properties (or Custom fields) in the Platform area.
  2. Select scope and entity type: To view existing properties or create new ones, you must set the context. In the first dropdown, select the Area (for example Customer, Product, Sales Partner or Subscription). In the second dropdown, select the exact entity type (for example, for products, whether the property applies to a subscription product, an option or a shop item).
  3. Check overview: After selection, a table appears with all the properties already created for this context. Here you can see the field name as well as settings such as visible, searchable or mandatory field.
  4. Create new property: Click on the Add field or Create field, depending on the name in the portal button to configure a new property.
  5. Set property details and field type: Give a unique name or field name. Select the Field Type from the dropdown (see table below). You can also use switches to determine whether the field is visible, whether it is included in search queries (Searchable) and whether it must be filled out (Mandatory field).
  6. Save: Save your information to create the new property in the system.

Depending on the type of information you want to record, you can choose from different field types when creating it. Each field type can have its own validation rules:

Field typeDescriptionPossible rules & special features
String / TextFor normal text and character strings.Minimum and maximum length (characters).
Integer / whole numberFor whole numbers (without decimal places).Minimum and maximum numerical value.
Decimal numberFor decimal numbers (e.g. financial or metric values).Minimum and maximum numerical value.
Boolean / Yes-No valueA simple yes/no switch (checkbox).-
Date / Date & TimeFor calendar information.Restrictions to certain periods possible.
EmailTo capture and validate an email address.-
PhoneFor the structured recording of telephone numbers.-
URI / URLTo validate web addresses and links.-
Predefined listA drop-down menu with predetermined options.Definition of the selectable values; Single selection vs. multiple selection.

After saving, the new property is available for the selected context. For example, if you create or edit a new customer or a new subscription, the new property will be displayed as an additional input field in the corresponding forms of the portal, depending on the configuration.

If you mark a property as required, future business users and API integrations will no longer be able to save new records in that context without specifying the value for that field. In existing integrations, this can lead to errors if the new mandatory field has not yet been transmitted.

Properties are always tied to a scope and an entity type. A Project ID property that you configure for subscriptions does not automatically appear in the customer data.

You can delete properties again using the list view (trash can symbol). Please note that this means that the field will disappear from the forms, but the data recorded so far can still be present historically in the system.

User-defined fields (Custom Properties) are fully integrated into the tebio API. The administration is divided into two aspects:

  1. Configuration of the fields (templates): You can not only manage the input fields and their validation rules via the interface, but also define them via the API. For each entity area there are technically so-called Property Metadata Templates, which you can use to create, edit or query fields. Examples of key endpoints:

  2. Use of properties: As soon as a property has been anchored in the system via such a template, it can be used in API requests for the respective resource. You then simply pass or read the field as a key-value pair in the properties array of the target resource (e.g. when creating a new customer via Create a customer).