Format Definitions

Use format definitions for complex data items of type Name, Address, or Multi-Segment. Build a format definition by designating the required components for that data item type. Once a format definition has been created, it becomes available for every field of that data item type in every application. Users access available formats for a field by selecting the field in the application and opening the dropdown list that appears below the default format.

For example, for Name fields there is one format available in the drop-down menu that has lines for First Name and Last Name, and a different format that has lines for Title, First Name, Last Name, Qualifications, and Suffix. 

Format definitions inform the platform how to build a full value from composite values in these field types, but don't impact how a field is shown or stored. Learn more in Format Definitions application.

Field Format Definitions

Use field format definitions to control the format of values within a text data item. You can configure different format options such as field value patterns, placeholder values, and padding and alignment.

For example, you could create a field format with a format mask of 999-99-9999 and a placeholder of 000-00-0000. This would place the value 000-00-0000 in the field before a user enters their value, and only allow numbers to be entered in the field. This ensures if a social security number of 111223333 was entered in the field, it would format as 111-22-3333.

Learn more in Field Format Definitions application.

Configure format definitions

Configure formatted fields with the Format Definitions and Application Builder applications.

Format Definitions

In the Format Definitions application, there are several Format Types to select from, such as:

  • Name Format
  • Address Format
  • Multi Segment Format

Every format created of that type becomes available in the dropdown menu of every field of that data item type. 

Label formats with a clear, concise name so that users are able to select the appropriate option. 

Application Builder

In the Application Builder application, formats are automatically available in every field that is a Name, Address, or Multi-Segment. 

In the Configuration Panel, in the Field Dependencies section, you can also configure field dependencies to select a single format to be used in a field. To configure field dependencies in an application, you must select a Controlling Field that has a valid format name. That format is then used in the Dependent Field.  Learn more in the Field Dependencies topic.

Format Definitions application

Application developers use the Format Definitions application to designate what information users should input into complex data item fields of type Name, Address, and Multi-Segment. 

This helps guarantee there are valid field values. 

When a user selects a configured field, a dropdown menu opens with options for the format they want to use. For example, one format could require only the City, State, and Country, while another format could have:

Line 1
Address Line 1 
Line 2
AddressLine2
Line 3
AddressLine3
Line 4
City, State, Postal
Line 5
Country (2 character designation)

It is important to label the formats with clear, concise names so users are able to select the appropriate option. 

Formats can be configured with field dependencies. Learn more in the Configure format definitions topic. 

Customize name and address fields

Customize name and address fields to change the field names and synonyms of the component lines in the field details. 

Name and address fields have one, or many, format definitions available for users to select from. Each format definition has component lines that together form a complete name or address value. How the field was configured controls whether a format definition is defaulted into the field or if users can select from a dropdown list of available formats. Learn more in Configure format definitions.

Format definition are delivered with component line names and synonyms alreadycreated. Each component line is defined by a list lookup record and an associated data item which matches the list lookup value. To change the line name and synonym, you must customize the data item. 

Field Format Definitions application

Application developers use the Field Format Definitions application to create and modify constraints to information entered in a field.

Use this application when you want users to enter field values only in a specific pattern. Field formats provide a way to guarantee consistently formatted field values.

You can configure different formatting components including field value patterns, placeholder values, and padding and alignment.

For example, you could create a field format with a format mask of 999-99-9999 and a placeholder of 000-00-0000. This would place the value 000-00-0000 in the field before a user enters their value, and only allow numbers to be entered in the field. This ensures if a social security number of 111223333 was entered in the field, it would format as 111-22-3333.

If you apply a field format to a date field, the entire date is stored, but only the partial formatted date display in the application record. 

Field formats do not constrain what characters can be entered into a field, but validations do. You can learn more in the Validation Setup application section.