Custom fields

This topic describes how to add custom fields using the Rebilly UI. To add custom fields using the Rebilly API, see the Custom fields operations.

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. Depending on the resource on which the custom field is added, it will be available in all related forms and also as a filter in data table segments.

Example: A custom field called 'Preferred contact method' is added to the customer resource. It has two allowed values, which are 'email' and 'phone'. When new customers are added, they will be prompted to provide this information. Alternatively, if the customer is manually added, a field for this value is provided. The custom field is also provided as a filter in data tables.

Create custom fields

Use this process to create custom fields.

1. In the left navigation bar, press Settings .
2. In the Management section, press Custom fields.
3. Press Create custom field.
4. In the Resource dropdown, select the resource you want to associate with the custom field.
   For example, if you want to add a preferred contact method field to customers, select the 'Customers' resource.
5. In the Type dropdown, select the format of the data.
   For example, if you want to store preferred contact information that contains alphanumeric data, select 'String'.
6. In the Label field, enter a name for the custom field.
7. In the Description field, enter a description for the custom field.
8. Optionally, to restrict the available input values, select the Apply value restrictions checkbox and enter the allowed values.
   For example, for the preferred contact method, you may want to add 'Email' or 'Phone'.
   Note: Restrictions are only available for array and string data types.
9. Use the Preview section to visualize how the custom field is displayed.
10. Optionally, to set a default value, in the Default value field, enter a value.
11. Optionally, to make the custom field required, select the Required checkbox.
12. Press Save custom field.

Edit custom fields

This process describes how to edit custom fields.

1. In the left navigation bar, press Settings .
2. In the Management section, press Custom fields.
3. Select a custom field.
4. Edit the custom field, then press Save custom field.

Filter data table content by custom fields

This process describes how to filter data table content based on a custom field.

1. Create a custom field

   1. In the left navigation bar, press Settings .
   2. In the Management section, press Custom fields.
   3. Press Create custom field.
   4. In the Resource dropdown, select the resource you want to associate with the custom field.
      For example, if you want to add a preferred contact method field to customers, select the 'Customers' resource.
   5. In the Type dropdown, select the format of the data.
      For example, if you want to store preferred contact information that contains alphanumeric data, select 'String'.
   6. In the Label field, enter a name for the custom field.
   7. In the Description field, enter a description for the custom field.
   8. Optionally, to restrict the available input values, select the Apply value restrictions checkbox and enter the allowed values.
      For example, for the preferred contact method, you may want to add 'Email' or 'Phone'.
      Note: Restrictions are only available for array and string data types.
   9. Use the Preview section to visualize how the custom field is displayed.
   10. Optionally, to set a default value, in the Default value field, enter a value.
   11. Optionally, to make the custom field required, select the Required checkbox.
   12. Press Save custom field.
2. Apply the custom filter to data table content

   1. In the left navigation bar, press Data tables, depending on the resource in which you created the custom field, select Customer, Payments, Billing, Logs, or KYC & AML.
   2. In the top right of the table, press Filters .
   3. Press Add filter.
   4. In the Filter dropdown, type custom fields, then select your custom field.
   5. In the Operation dropdown, select a condition.
   6. In the Value field, enter or select values.
      For example to filter by customers aged between 30 and 40, using the custom field Age, select the is between operation, then in the Value fields, specify the range.
   7. Press Apply filter.
   8. Select an option:
      • To save the filtered data to the active segment: Press Save.
      • To create a new segment based on the filtered data: Press Save segment as, enter a name for the new segment, then press Save.
        A segment is a filtered view of the data set. Depending on where the filtered view is created, new segments are displayed in Customer, Payments, Billing, or Logs. For more information, see Segments.

Use custom fields as conditions in automations

This process describes how to use a custom field as a condition on an automation. Conditions are used to specify additional criteria on when an automation is triggered, and also to target specific resources.

1. Create a custom field

   1. In the left navigation bar, press Settings .
   2. In the Management section, press Custom fields.
   3. Press Create custom field.
   4. In the Resource dropdown, select the resource you want to associate with the custom field.
      For example, if you want to add a preferred contact method field to customers, select the 'Customers' resource.
   5. In the Type dropdown, select the format of the data.
      For example, if you want to store preferred contact information that contains alphanumeric data, select 'String'.
   6. In the Label field, enter a name for the custom field.
   7. In the Description field, enter a description for the custom field.
   8. Optionally, to restrict the available input values, select the Apply value restrictions checkbox and enter the allowed values.
      For example, for the preferred contact method, you may want to add 'Email' or 'Phone'.
      Note: Restrictions are only available for array and string data types.
   9. Use the Preview section to visualize how the custom field is displayed.
   10. Optionally, to set a default value, in the Default value field, enter a value.
   11. Optionally, to make the custom field required, select the Required checkbox.
   12. Press Save custom field.
2. Create an automation on an event

   This step describes how to create an automation that is triggered when a specific event occurs.

   1. In the left navigation bar, press Automations .
   2. In the Rules engine section, press Rules engine.
   3. Press Core events or Billing events.
   4. Select an event.
   5. Press Rule set, then press Create rule.
   6. In the Name field, enter a unique name to help differentiate between multiple rules.
   7. Optionally, to add labels that help you identify the rule: In the Labels field, add one or more labels.
   8. Optionally, to not stop further processing after this rule is executed: clear the Stop further processing checkbox.
3. Configure a condition using a custom field

   This step describes how to configure a condition that is based on a custom field.

   1. In the Conditions section, clear the No conditions checkbox.
   2. In the Select filter field, select a custom field based condition that you want to apply.
      To view all available custom fields that are available on the event you have selected, in the Select filter field, type custom fields. Then select the custom field, the operation, and the value. Examples:
      • 'Transaction > Customer > Custom fields > 'Field name''.
      • 'Payment card > Customer > Custom fields > 'Field name''.
      • 'Invoice > Customer > Custom fields > 'Field name''.
   3. In the Actions section, press Add action.
   4. Specify the action that you want to occur when the condition is met.
   5. Press Save rule.

Related topics

• Add a customer
• Apply a filter
• Extend resources
• Customize data tables