Skip to main content

Custom Fields (Previously Extensions)

Custom Fields allow you to capture and store custom contact data, with proper segmentation and the ability for sheepApp users to maintain that data when connected to forms.

Written by Tom Byrom

What's changing from Extensions to Custom Fields?

Extensions have been renamed and upgraded to Custom Fields as part of our wider Data Capture Improvement work. Previously, Extensions were basic plain text fields with no way to connect them to forms and had to be maintained by sheepCRM admins. Segmentation also lacked rich filtering rules because each extension field lacked a specific field type as everything was being captured as plain text.

Custom Fields, in its initial version, improves many of these areas whilst supporting legacy Extension data and paving the way for further Data Capture Improvements in upcoming releases.

  • Custom Fields are now defined by a field type, this allows for better data capture and segmentation. Date, select fields, lists, yes/no, number, text fields etc

  • Custom Fields can be connected to and updated from form questions, the same way as connecting form questions to core fields works today.

  • Better contact segmentation based on the field type. Example: date fields allow filtering on correct date rules; lists allow you to select which options to segment on, etc.

⚠️ Existing customers who have been using Extensions
Please get in contact with us before changing any of your existing fields. Legacy extension fields will default to the 'Single Text Entry' field type for legacy support.
​
​Please get in contact with us to discuss your options before changing any of your legacy extension fields. Your existing Extension records will not be disrupted by this upgrade. However, the data you currently hold might not be valid if you change to a different field type. So it is safer to leave fields as 'Single Text Entry' for legacy support. To fully benefit or make changes to existing fields, you may need a data migration and validation service.

What are custom fields?

Custom fields can be used to capture and store custom contact data that does not match to an appropriate core contact field.

  • Perfect for additional profile data that does not map to core fields

  • Data that must stay up to date over time and be maintained

  • The current, editable truth about a Person or Org

  • Segmentation and reporting is based on the latest truth

  • Can be updated by sheepApp users via forms

    • With more sheepApp integration points coming later

It's most suitable for persistent data that may need to be referenced or kept up to date. It's not so suitable for moment-in-time data where forms are likely still the preferred method. Essentially, if the data could live outside of a forms context, it could likely also be a custom contact field.

Who gets access to custom fields?

All license levels currently get a minimum of two custom field templates (field groups) with up to 10 custom fields in each.

Custom Fields are available across all sheepCRM licence levels, with limits depending on your current licence:

  • Simple (everyone): 2 custom field templates, with up to 10 fields per template.

  • Advanced: 5 custom field templates, with up to 30 fields per template.

  • Professional: 10 custom field templates, with up to 50 fields per template.

  • Enterprise: Additional limits are available by negotiation.

We will be upgrading applicable customers as we roll out the initial release, but please feel free to get in touch with us if you have any questions.

Please note: Existing customers who have been using extensions, which previously had no limits, you may find you have already reached your license limits. Please reach out to us if you would like to discuss this.

How do I create custom fields?

To start using custom fields please follow the steps below.

  • Go to Settings > Contacts > Custom fields (Previously Extensions)

  • Press 'Add Custom Field Template'

    • Note that if you have already reached the limits for your license level this button will be disabled and will explain why.

  • From the sidepanel, configure the template based on these settings.

    • Name for display

    • Internal ID

      • This is a unique identifier prefix which cannot be changed once set. This is used to identify custom fields in segments and fieldsets in exports.

    • Extends

      • Determines which contact record types can use these custom fields, Person, Organisations or both.

    • Description

    • Available in forms*

      • *Only shows if you have the correct access to forms. This allows the custom fields to be updateable and linked to from form questions. It works the same way as connecting to core fields via form questions.

    • Promote to contact section

      • If this custom field template should live under the main contact section on contact records or not. Allows for quicker access.

        • Display after

          • This custom field template will be displayed after the selected section. If other custom field templates are set to display after the same section, they will be ordered alphabetically

    • Fields

      • Name

      • Type

        • Single text entry

        • Large text entry

        • List of text entries

        • Email address

        • Telephone number

        • Yes/No

        • Date

        • Number

        • Choose from list*

        • Multiple options from list*

Please note: Choose from list and Multiple options from list, their options are automatically aggregated from values added and stored on contact records as well as choices set on connected form questions. Options are not configured here. Defining fixed lists from custom fields will come later. However, in the meantime, this allows for more flexibility on a wider range of changing data.

*Only available for customers with advanced or higher licenses


​

How do I add, edit or access custom fields on a contact record?

To view, add and update custom field data on a contact record, follow the steps below.
​

  • Go to an individual contact's side panel

  • Go to either the 'Custom Fields' near the bottom of the left navigation

  • Or, if you promoted a template to the 'Contact' section, you will find the template there. In this example, I promoted it under the Contact panel.

  • From there, you will see the custom fields, and it will display any data held on that contact

  • Click 'Add' if no data exists

      • The 'New Custom Field Record' popup will open

      • Add the data you need for this contact

      • For select fields

        • You will see available options based on data that exists on other contacts or connected form questions

        • You can select existing options

        • You can type to create a new option for this contact

      • Once you have added data, press 'Add' to save.

  • Click 'Actions' if data exists

    • Edit Custom Field record

    • Delete Custom Field record

How do I connect custom fields to forms?

For those of you with a sheepFlow license or forms access through another module, you can connect form questions to custom fields, allowing your sheepApp users to keep their own data up to date.

🟢What this enables: This allows data to be captured in forms and automatically keep custom fields up to date with the latest data. It works the same way as linking/connecting form questions to core fields.

No need to manually transfer information captured in forms to custom fields.

It will also pull in the existing custom field data into the form when connected. Allowing users to see the data held and update where necessary.

Follow the steps below to connect form questions to custom fields.

  1. On your 'Custom Field Template' make sure the option 'Available in Forms' to yes

    1. Without this you will not be able to select those custom fields from a form question.

  2. Go to Forms via Settings or Flow > Select a form > Edit or add a section > Edit or add a form question

  3. From the Form Question modal, complete the form question as you would normally.

    1. This includes adding your options for things like lists and multi-selects

  4. Then toggle the 'Connect to Core/Custom field' option

  5. From the new dropdown select the custom field you want to connect the form question to.

    1. You will only see fields that match the core/custom field type. Example a data field can only update another date field and so on.

  6. Save your question, and it will now be linked to the custom field and any forms subimtted will automatically update the custom field.

Data stored on custom fields will automatically pull and allow sheepApp users to update it when submitting forms. The same way connect to core fields works.

How can I segment on custom fields?

Once data starts coming in against contacts' custom fields, you can start using these fields in your segmentation rules to filter contact segments.

  • Add or edit a segment

  • From the segment side panel, go to rules

  • Search for the field name and select it. The template prefix will also show to help you easily identify them.

  • You will now be able to filter the field based on the type of field that was set when setting up your custom fields

    • Dates will give you proper date filtering

    • Lists and multi-selects will give you proper options to select etc

How can I include custom fields in segment exports?

Custom fields can also be included in contact segment exports, via the contact segment action 'Export to XLSX'.

They will automatically be included in the out of the box, 'Contact - Extended' export/fieldset.

However if you are creating a custom fieldset they can be included much like selecting them via a segment.

  • Add or edit a custom fieldset

  • Add a field

  • Search and select the custom field

What happens if I delete custom fields or a custom field template?

Please note: Deleting custom field templates and/or individual custom fields should be done with absolute care.

It is generally not advised once you have started capturing data or connected those to form questions unless you really don't need them.

Deleting may cause unintended consequences and data loss. That can not be undone.

  • If you delete a custom field within a template. If contacts had data stored against that field, it will become read-only and editing it will not be allowed; you will only be able to delete it from an existing contact.

  • If you delete an entire template. That template will completely remove those custom fields from any contact record. Not advised unless necessary.

Known Limitations in V1 of Custom Fields

  • Legacy support - We support legacy extension data by default by setting all those fields to 'Single Text Entry'. To fully benefit or make changes to legacy fields, you may need a data migration and validation service.

  • Fixed-list versions of the Choose from list and the Multiple options from list

    • You cannot define a fixed list of options from the custom field template to be used exclusively everywhere the data is captured.

    • The current implementation of these fields is essentially loose lists. This provides more flexibility initially, where the options are added and aggregated across all contacts and any form questions linked where they have defined options.

      • When you go to a contact record to add custom fields the options you see in the dropdown for these field types are pulled from all contacts and form questions. You can add new options by typing to create or simply select existing ones.

      • This behaviour is similar to tags, where tags are aggregated across contacts. There is currently no centralised tag handling either.

  • File uploads and image field support

    • These are not supported yet in custom fields

Did this answer your question?