Fields

IN THIS PAGE

Custom fields overview
Create a custom field
Manage custom fields
Custom field types and properties

1. Custom fields overview 🔗

Custom fields serve as additional fields that can be used for specific business applications. In general, the fields differ based on the industry, business, and workflow, which makes customization essential for building an effective CRM. The custom fields within Bigin Developer Console play a similar role in customizing the solution during the creation of toppings. These fields are not predefined, but you can define and customize them as needed using toppings. Any fields added to the topping will be reflected in the user interface of Bigin.

2. Create a custom field 🔗

To add a custom field, access the Bigin Developer Console and navigate to Components > Fields.

Choose a module from the Module List, and then click New Custom Field.

Select a field type, provide the necessary details, and save the field to apply changes.

💡 Tip:

When you create a custom field in a topping, its API name will be in the <topping_namespace>__<field_label> format. For example, if you create a custom field named QuickBooks ID, its API name will be <topping_namespace>__QuickBooks_ID.
If you want to use the API name of a custom field, we recommend you create the field label in lowercase (e.g., quickbooks_id) first, so the API name will be <topping_namespace>__quickbooks_id. You can then rename the field label to your preferred name while keeping the API name unchanged.

The field details vary based on the selected field type. For more information, see the Custom field types and properties section below.

3. Manage custom fields 🔗

After you create a custom field for a topping in a module, you may need to update or delete it later on. In such cases, you can edit and delete the custom fields from the toppings.

To edit a custom field, access the Bigin Developer Console, navigate to Components > Fields, and select the module.

Hover over the custom field you want to modify and Click the Edit icon.

After updating the details, save the changes.

To remove a custom field, hover over the custom field you want to remove and click the Delete icon.

Confirm the deletion. This results in permanent loss of data.

✍ Notes:

When you delete a custom field during the update of a topping to a new version, it will not be removed from the earlier version of the installed topping in order to prevent data loss.
The custom fields configured in the topping cannot be deleted from the Bigin user interface and will only be removed when the topping is uninstalled.
Once the topping is installed, the custom fields configured in the topping cannot be edited in Bigin except for a PickList field. The PickList field values configured in the topping can be updated in Bigin. However, if you delete any PickList field values during the update of a topping to a new version, they will still remain in the earlier version of the installed topping.

4. Custom field types and properties 🔗

When adding a new field, you must enter the field properties according to the type of field you create. You can check which properties you'll need for each field type in the following table:

Field Type	Description	Properties
Text	A single-line text field allows input of a sequence of characters and numbers with a limit of 255 characters.	Label - Type a name for the text field. Length - Specify the length between 1 to 255 characters.
Integer	Allows input of integer numbers with a limit of 9 digits.	Label - Type a name for the integer field. Length - Specify the length between 1 and 9 digits.
Percent	Allows input of a percentage (%) value with a limit of 5 digits.	Label - Type a name for the percent field.
Decimal	Allows input of decimal values with a limit of 16 digits, which includes decimal places.	Label - Type a name for the decimal field. Length - Specify the length between 1 to 16 digits. Decimal Places - Define the number of decimal places (e.g., 245.66 contains 2 decimal places)
Currency	Allows input of currency values with a limit of 16 digits, which includes decimal places. The maximum limit for decimal places is 9 digits, and decimal values are restricted based on the selected rounding options.	Label - Type a name for the currency field. Length - Specify the length between 1 to 16 digits. Rounding Option - Select an option from the drop-down. The options include Normal, Round Off, Round Down, or Round up. When you select an option other than Normal, the Precision field appears. Decimal Places - Define the number of decimal places. Precision - Select precision if applicable.
Date	Allows input of a date in MM/DD/YYYY format or selection from a Calendar UI.	Label - Type a name for the date field.
DateTime	Allows input of a date and time in MM/DD/YYYY and HH:MM format or selection from a Calendar UI and Time drop-down.	Label - Type a name for the date and time field.
Phone	Allows input of a valid phone number with a maximum limit of 30 digits.	Label - Type a name for the phone field. Length - Specify the length between 1 to 30 digits.
Pick List	Allows selection of a value from a pre-defined set of options.	Label - Type a name for the pick list field. Pick List Values - Define pick list values. Use first value as default value - Select this check box if you want to represent the first value of the pick list as default value.
URL	Allows input of a web address with a limit of 255 characters.	Label - Type a name for the URL field. Length - Specify the length between 1 to 255 characters.
TextArea	A multi-line text field allows input of text with a maximum of 2000 characters for Small TextArea and 32000 characters for Large TextArea.	Label - Type a name for the TextArea field. Character Limit - Select Small (2000 characters) or Large (32000 characters).
Checkbox	Allows selection of Yes (checked) or No (unchecked).	Label - Type a name for the checkbox field. Enable by Default - Select this check box if you want to enable it by default.
Emails	Allows input of a valid email address with a maximum of 100 characters.	Label - Type a name for the emails field.
Auto-Number	Classifies records using unique auto-generated numbers.	Label - Type a name for the auto-number field. Prefix - Define a prefix for the auto-number sequence. Starting Number - Define the starting number. Suffix - Define a suffix for the sequence. Also update existing records - Select this check box if you want to apply the auto number sequence to existing records.
Lookup	Establishes one-to-many relationships for records.	Label - Type a name for the lookup field. Lookup Type - Select a module to establish a relationship. Related List Label - Type a name for the related list that appears within the record's details page in Bigin.
Long Integer	Allows input of long integers with a limit of 18 digits.	Label - Type a name for the long integer field. Length - Specify the length between 1 and 18 digits.
Multiselect Pick List	Allows selection of multiple values from a pre-defined set of options.	Label - Type a name for the multi-select pick list field. Pick List Values - Define pick list values. Use first value as default value - Select this check box if you want to represent the first value of the pick list as default value.