Understand Custom Fields

What are Custom Fields?

The Custom Fields activity will allow you to create new fields under five objects in the Boomtown Platform to push organization specific data to those fields either manually within the Platform or via APIs. The five Platform objects you can create Custom Fields on are - 

• Cases

• Customers

• Locations

• Contacts (Customer Users)

• Products

Creating Custom Fields

To create a Custom Field, navigate to the Settings activity of the Boomtown Platform and select the Custom Fields menu option. You’ll then choose which main object you want to create Custom Fields under (i.e. Cases, Customer, etc.). 

To create a new Custom Field under the main object  - 

1. Go to Settings
2. Select the Custom Fields activity under the Settings menu
3. Choose the Platform object you want to create your Custom Fields under (e.g. Cases, Customers, etc.)
4. Click the New Field button on that main object page
5. This will pop-up a Custom Field creation screen where you can define the specifics of your Custom Field. You’ll fill out the following fields on the creation screen to complete the creation of your Custom Field:
   • Field Name: The display name of the field in the Boomtown Platform (Example: Customer Segment)
   • API Name: This will be the field name you’ll use to push data to the field via API calls. 
   • Description: A quick description of this field
   • Searchable Toggle: Checking this box allows agents to search for this Custom Field in Global Search within the UX (Note: the more Custom Fields you add as Searchable the slower Global Search will return results)
   • Ecosystem: Allows you to show this Custom Field to your Ecosystem Partners (you can leave this blank for Shift4’s current use case)
   • Field Type: Defines what type of field this should be. The available field types are listed below - 
     • Identifier: Identifier (Text)
     • Checkbox: Allows the user to select True (Checked) or False (Unchecked) Value
     • Currency: Allows the user to enter dollars or other currency and automatically formats the field as currency amount
     • Date: Allows the user to enter date or pick a date from the popup calendar 
     • Date/Time: Allows the user to enter date and time or pick a date and time from the popup calendar
     • Email: Allows the user to enter an email address wich is validated to ensure proper format
     • Number: Allows the user to enter any number. Leading zeroes are removed
     • Percentage: Allows the user to enter any percentage number. For example: 2 will be converted to 2%
     • Phone: Allows the user to enter phone number and formats the numbers accordingly
     • Picklist: Allows the user to select a value from the defined list
     • Picklist (Multi-Select): Allows the user to select multiple values from the defined list
     • Text: Allows the user to enter any letters or numbers
     • Text Area: Allows the user to enter any letters or numbers up to 255 characters
     • Text Area (Long): Allows the user to enter any letters or numbers beyond 255 characters
     • Text Area (Rich): Allows the users to enter rich text that includes imaging, formatting and links beyond 255 characters
     • Time: Allows the user to enter time
     • URL: Allows the user to enter any website address. When clicked it opens in a new browser tab
     • Users: Allows the user to associate one or more users to this field from their organization
6. Once the Custom Field creation screen is completed, click Save or Save & Exit to save your new Custom Field

Adding Custom Fields to API Calls

To populate Custom Fields via an API call, you’ll add the API Name for the Custom Field as a new field available under the object you created that Custom Field under. 

Example: If you have a new Custom Field called “customer_segment” under the Locations object, you’ll simply add this as a new field in your call if you were calling /customers/put/

"customer_location": {
      "id": "string",
      "customer_id": "string",
            “customer_segment”: “string”
      "street_1": "string",
      "street_2": "string",
      "city": "string",
      "state": "string",
      "zipcode": "string",

Adding Custom Fields to the Boomtown Platform Pages

To display Custom Fields on the main objects in the Boomtown Platform, you’ll define these in the Layouts activity under Settings.