Customizing Standard Fields & Prompts

Updated April 10, 2023 17:49

Expand-All Collapse-All

Getting Started

Slate delivers many standard fields that you can customize. The following list indicates each field and the steps required to customize it.

Important!

Only create fields and prompts using the exact Field IDs and Prompt Keys as instructed below. Do not create custom fields for Slate standard fields.

To configure Fields :

Select Database on the top navigation bar
Select Fields.

To configure Prompts:

Select Database on the top navigation bar
Select Prompts.

Person Information

Biographical

Name

Behavior

Field ID

Prompt Key

Birth Nation (Country)

Creating this field with the ID of ‘birthnation’ will enable “Birth Country” and display it at the bottom of the Biographical Information section of a Slate application. Set the Value to 'Store Value'.

NOTE: This field should be set to Person scope.

This field can exist on its own. However, this field's existence is required to enable the Birth Place, Birth Region fields.

birthnation

country

Birth Place (City)

Creating this field with the ID of ‘birthplace’ will enable “Birth City” and display it at the bottom of the Biographical Information section of a Slate application. Set the Value to 'Store Value'.

NOTE: This field should be set to Person scope.

This field will only display if the Birth Nation field has been created.

birthplace

n/a

Birth Region

Creating this field with the ID of ‘birthregion’ will enable “Birth Region” and display it at the bottom of the Biographical Information section of a Slate application. Set the Value to 'Store Value'.

NOTE: This field should be set to Person scope.

This field will display if the Birth Nation and Birth Place fields have been created. If birth region has not been created as a field in Slate, the field will still display. However, data will not be saved.

birthregion

n/a

Language

Creating this field with the ID of ‘language’ will enable “Native Language” at the bottom of the Biographical Information section of a Slate application. Set the Field Type to 'Custom Configuration (Advanced Use Only)', the Prompt to ‘language’ in the drop-down menu, and the Value to 'Store Value (bit/language/state/country/user prompts and text fields only).

To use this prompt list, load prompts with the Key of ‘language.’ Each 'language' prompt should have a unique index value.

NOTE: This field should be set to Records>Person scope.

language

Prefix

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'prefix'. Set the Scope of this field to 'Person' and Value to 'Store Prompt ID'

n/a

prefix

Sex

Sex leverages a special prompt key of "sex".

In order to modify the preexisting options, all options including the preexisting default values (Male and Female) must be inserted. Each prompt MUST include a single letter index value.

Preexisting Options:

Custom Example:

Value:
Male

Index Value:
M

Value:
Female

Index Value:
F

Value:
Non-binary

Index Value:
B

Important!

Preexisting options: Male and Female MUST include the Index Values exactly as shown above.

(The index value is limited to 1 character).

Note: When using the 'sex' prompt key for a custom field, ensure the Field Type is set to "Custom Configuration (Advanced Use Only)" and Value is set to "Store Value".

n/a

sex

Suffix

A standard list of prompt values is provided. Additional prompts can be added to the list using a key of 'suffix.'

n/a

suffix

Race - Decline

Creating a new ‘race’ prompt with the value of ‘Decline’ and placing the following code snippet into the XML box will generate a ‘Decline’ checkbox as an option for students who choose not to provide their race:

<p>
<k>decline</k>
<v>1</v>
</p>

n/a

race

Race – Other

Creating a new ‘race’ prompt with the Value of ‘Other’ will generate a selectable race option box of ‘Other’ which, when clicked, will display a free-text box to the right, which students can fill out if they wish to provide a race different than those already listed on a Slate application.

Similar to other prompts of this nature, unless a corresponding field with the ID of ‘raceOther’’ is also created, the data will not store anywhere.

n/a

race

Race – Other Options

Creating a new ‘race’ prompt with the Value of ‘Label - Other’ (e.g. ‘Hispanic – Other,’ ‘Asian – Other,’ ‘Black or African American – Other,’ etc.) will enable “Other” underneath the corresponding prompt Value on a Slate application.
NOTE: when creating these prompt values, follow these naming directions:

Name of the category (White, Asian, etc.)
Space
Hyphen (-)
Space
Other (capital O)

The “Other” box will display upon creating these prompt values. However, the free-text fields that go along with them will not store or retain data unless one of the following corresponding fields has also been created along with it:

raceAsianOther
raceIndianOther
raceBlackOther
raceIslanderOther
raceWhiteOther

n/a

race

Race – American Indian or Alaska Native - Tribe

For the ‘race’ prompt of ‘American Indian or Alaska Native’ partner institutions may wish to include more prescribed options aside from ‘Other’ on a Slate application. Additional ‘race’ prompts with the Value of ‘American Indian or Alaska Native - Cherokee’, or American Indian or Alaska Native - Tomahawk’ may be added.

This behavior can be replicated for the other ‘race’ category prompts (e.g. ‘Asian - Chinese,’ or ‘Asian - Japanese,’ etc.).

Two items to also keep in mind:

The next two Field items in this table contain related functionality to the ‘American Indian or Alaska Native’ prompts in particular.
To show the checkboxes of the items mentioned in this example (i.e., ‘Cherokee,’ ‘Tomahawk,’ ‘Chinese,’ ‘Japanese,’ etc.) and hide the ‘Other’ free-text field, inactivate the corresponding ‘raceXxxxxxOther’ field (if it has been created).

n/a

race

Tribal

Creating this field with the ID of ‘tribal’ will generate a free-text field with a label of “Tribal Affiliation” on a Slate application.

Additionally, the only way this field will display is if:

It is set to “Show” in the “General Settings” section of the Personal Background part within the Application Editor.
At least one other ‘American Indian or Alaska Native’ prompt exists (e.g. ‘American Indian or Alaska Native - Other,’ or ‘American Indian or Alaska Native – Cherokee,’ etc.).

NOTE: This field should be set to Person scope.

tribal

n/a

Tribal Enrollment

Creating this field with the ID of ‘tribalEnrollment’ will enable a free-text field underneath the “Tribal Affiliation” question on a Slate application with the label of “Enrollment Number.”

This field will only display if:

A field with the ID of ‘tribal’ exists.
“Tribal Affiliation” is set to “Show” in the Application Editor.

NOTE: This field should be set to Person scope.

tribalEnrollment

n/a

Hispanic Origin

Creating this field with a key of ‘hispanicOrigin’ will allow for more granular subtypes if a student selects ‘Yes’ to the question of “Are you Hispanic or Latino?” on a Slate application. With the Key of ‘hispanicOrigin’, checkboxes such as ‘Colombian,’ ‘Cuban,’ ‘Mexican,’ etc. can be created.

In order to create these additional checkbox categories, the Key of the prompt would be set to ‘hispanicOrigin,’ but the ‘Value’ of the prompts would be set to ‘Colombian,’ ‘Mexican,’ ‘Cuban,’ etc.

NOTE: This field should be set to Person scope.

hispanicOrigin

Hispanic Origin "Other"

Similar to the other race fields, if a 'hispanicOrigin' prompt with the Value of "Other" is created, a text box will appear if this option is chosen.

In order for this text data value to store on the person record, a field with an ID of 'hispanicOther' will need to be created. (Note: be sure to set the "Value" setting for this new field to "Store Value (bit...etc.)" as this will be a text field.)

hispanicOther

n/a

Citizenship

Name	Behavior	Field ID	Prompt Key
Visa	Creating this field with the ID of "visa" and prompt list with the Key of "visa," as well as showing via the application editor, will enable “Visa.” It will appear in the Citizenship Information section of a Slate application only when an applicant selects a country other than the United States. Be sure to include Index Values for each visa prompt. NOTE: This field should be set to *Person* scope.	visa	visa
Visa Expiration	Creating this field with the ID of ‘visaExpiration’ will enable “Current Visa Type” and appear under "Visa" on a Slate application only when a prompt with the Key of ‘visa’ exists and “Current Visa Type” is set to “Show” in the Application Editor. NOTE: This field should be set to *Person* scope.	visaExpiration	n/a
Permanent Resident Card Number	Creating this field with the ID of "alien" will enable "Permanent Resident Card Number" and appear under "Residency Status" on a Slate application only when "U.S. Permanent Resident" has been checked. NOTE: This field should be set to *Person* scope.	alien	n/a
Race - Decline	Creating a new ‘race’ prompt with the value of ‘Decline’ and placing the following code snippet into the XML box will generate a ‘Decline’ checkbox as an option for students who choose not to provide their race: <p> <k>decline</k> <v>1</v> </p>	n/a	race
Race – Other	Creating a new ‘race’ prompt with the Value of ‘Other’ will generate a selectable race option box of ‘Other’ which, when clicked, will display a free-text box to the right, which students can fill out if they wish to provide a race different than those already listed on a Slate application. Similar to other prompts of this nature, unless a corresponding field with the ID of ‘raceOther’’ is also created, the data will not store anywhere.	n/a	race
Race – Other Options	Creating a new ‘race’ prompt with the Value of ‘Label - Other’ (e.g. ‘Hispanic – Other’, ‘Asian – Other’, ‘Black or African American – Other’, etc.) will enable “Other” underneath the corresponding prompt Value on a Slate application. NOTE: when creating these prompt values, follow these naming directions: Name of the category (White, Asian, etc.) Space Hyphen (-) Space Other (capital O) The “Other” box will display upon creating these prompt values, however, the free-text fields that go along with them will not store or retain data unless one of the following corresponding fields has also been created along with it: raceAsianOther raceIndianOther raceBlackOther raceIslanderOther raceWhiteOther	n/a	race
Race – American Indian or Alaska Native - Tribe	For the ‘race’ prompt of ‘American Indian or Alaska Native’ partner institutions may wish to include more prescribed options aside from ‘Other’ on a Slate application. Additional ‘race’ prompts with the Value of ‘American Indian or Alaska Native - Cherokee’, or American Indian or Alaska Native - Tomahawk’ may be added. This behavior can be replicated for the other ‘race’ category prompts as well (e.g. ‘Asian - Chinese,’ or ‘Asian - Japanese,’ etc.). Two items to also keep in mind: The next two Field items in this table contain related functionality to the ‘American Indian or Alaska Native’ prompts in particular. To show the checkboxes of the items mentioned in this example (i.e., ‘Cherokee,’ ‘Tomahawk,’ ‘Chinese,’ ‘Japanese,’ etc.) and hide the ‘Other’ free-text field, inactivate the corresponding ‘raceXxxxxxOther’ field (if it has been created).	n/a	race
Tribal	Creating this field with the ID of ‘tribal’ will generate a free-text field with a label of “Tribal Affiliation” on a Slate application. Additionally, the only way this field will display is if: It is set to “Show” in the “General Settings” section of the Personal Background part within the Application Editor. At least one other ‘American Indian or Alaska Native’ prompt exists (e.g. ‘American Indian or Alaska Native - Other,’ or ‘American Indian or Alaska Native – Cherokee,’ etc.). NOTE: This field should be set to *Person* scope.	tribal	n/a
Tribal Enrollment	Creating this field with the ID of ‘tribalEnrollment’ will enable a free-text field underneath the “Tribal Affiliation” question on a Slate application with the label of “Enrollment Number.” This field will only display if: A field with the ID of ‘tribal’ exists. “Tribal Affiliation” is set to “Show” in the Application Editor. NOTE: This field should be set to *Person* scope.	tribalEnrollment	n/a
Hispanic Origin	Creating this field with a key of ‘hispanicOrigin’ will allow for more granular subtypes if a student selects ‘Yes’ to the question of “Are you Hispanic or Latino?” on a Slate application. With the Key of ‘hispanicOrigin,’ checkboxes such as ‘Colombian,’ ‘Cuban,’ ‘Mexican,’ etc. can be created. To create these additional checkbox categories, the Key of the prompt would be set to ‘hispanicOrigin,’ but the ‘Value’ of the prompts would be set to ‘Colombian,’ ‘Mexican,’ ‘Cuban,’ etc.	hispanicOrigin	n/a
Hispanic Origin "Other"	Similar to the other race fields, if a 'hispanicOrigin' prompt with the Value of "Other" is created, a text box will appear if this option is chosen. For this text data value to store on the person record, a field with an ID of 'hispanicOther' will need to be created. (Note: be sure to set the "Value" setting for this new field to "Store Value (bit...etc.)" as this will be a text field.)	hispanicOther	n/a

Address

Name

Behavior

Prompt Key

Address Type

Address Type leverages a special prompt key of "address_type."

To modify the preexisting options, all options, including the preexisting default values (Mailing Address, Permanent Address) must be inserted. Each prompt MUST include an index value.

Important!

Address types are limited to 16 characters. Do not create index values that are longer than this.

Preexisting Options:

Custom Example:

Value:
Mailing Address

Index Value:
mailing

Value:
Permanent Address

Index Value:
permanent

Value:
Location Address

Index Value:
location

Important!

Preexisting options of Mailing Address and Permanent Address MUST include the Index Values exactly as shown above.

If the custom address type should allow for temporary "To" and "From" dates, or it is intended as a recurring seasonal address, the following can be added to the XML of the custom prompt:

<p>
<k>allow_temporary</k>
<v>1</v>
</p>

address_type

Contact

Name

Behavior

Field ID

Prompt Key

Device Type

Device Type leverages a special prompt key of "device_type."

In order to modify the preexisting options, all options including the preexisting default values (Primary Phone, Mobile Phone, Evening Phone, Email Address) must be inserted. Each prompt MUST include an index value.

Preexisting Options:

Value:
Primary Phone

Index Value:
phone

Value:
Mobile Phone

Index Value:
mobile

Value:
Evening Phone

Index Value:
business

Value:
Email Address

Index Value:
email

Custom Examples:

Value:
Twitter

Index Value:
twitter_id

Value:
Skype

Index Value:
skype_id

Value:
Instagram

Index Value:
instagram_id

Value:
Videophone

Index Value:
videophone_id

Important!

Preexisting options of Primary Phone, Mobile Phone, Evening, and Email Address Phone MUST include the Index Values exactly as shown above.

Custom Email Address device types: The category must be set to 'email' to include the email address in the recipient dropdown list in ad-hoc emails

If social media accounts are created as custom device types, the following should NOT be used as index values: 'facebook,' 'google,' and 'linkedin.'

n/a

device_type

Fax

Adding a field with the ID of ‘fax’ will cause the Fax field to appear in the Telephone Numbers section of the application.

fax

n/a

Note: Each Device should have its own unique index value. No two devices can have the same index value.

Schools

Name

Behavior

Prompt Key

Level of Study

A standard list of prompt values is provided. Existing values may be modified, and additional types may be added to the list of options.

Must include index value to be stored (e.g., for 'High School' include an index value of 'H,' for 'Graduate' have an index value of 'G,' for 'Undergraduate' include index value of 'U').

school_type

Degree

By default, 'Degree' is a select field with 'No Degree Awarded or Expected' as the only option (which saves a null value).

Creating prompt values with a key of 'degree' will add more values to the list. Additionally, placing the following code snippet into the XML box will display degrees based on 'Level of Study' within the standard Academic History page of the Slate-hosted Application:

Display X Degree When...	XML Code
High School (Level of Study) is selected	<p> <k>level</k> <v>H</v> </p>
Undergraduate (Level of Study) is selected	<p> <k>level</k> <v>U</v> </p>
Graduate (Level of Study) is selected	<p> <k>level</k> <v>G</v> </p>

The <v></v> contains the Index value of each 'Level of Study' (school_type) prompt.

degree

Major

By default, 'Major' is a text box field.

Adding prompts with Key of ‘major’ will automatically change this text box field to a select list.

major

Major 2

'Major 2' can only be accessed when 'major' prompts exist.

major

Minor

'Minor' can only be accessed when 'major' prompts exist.

major

Field of Study

'Field of Study' can be enabled when creating a prompt with a key of ‘field.’

field

GPA Scale

By default, 'GPA Scale' is a text box field.

Adding prompts with Key of ‘school_gpascale’ will automatically change this text box field to a select list.

Only numeric values should be used.

This field will be made available as a prompt list from the standard Academic History page in the Slate-hosted Application.

school_gpascale

Honors

'Honors' can be enabled when creating a prompt with a key of 'honors.'

honors

School Courses

Name	Behavior	Prompt Key
Course Name	By default, 'Course Name' is a text box field. Adding prompts with Key of ‘course_name’ will automatically change this text box list to a select list.	course_name
Level	A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'course_level.' Note: This field can *only* be accessed when a prompt list exists.	course_level
Type	A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'course_type.' Note: This field can *only* be accessed when a prompt list exists.	course_type
Grade	A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'course_grade.' Until this prompt list is established, grade only functions as a text field.	course_grade
Grade Level	A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'course_grade_level.' Note: This field can *only* be accessed when a prompt list exists.	course_grade_level
Term	A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'course_term.' Note: This field can *only* be accessed when a prompt list exists.	course_term

Jobs

Name

Behavior

Prompt Key

Function

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'function.'

Note: This field can only be accessed when a prompt list exists.

function

Industry

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'industry.'

Note: This field can only be accessed when a prompt list exists.

industry

Sector

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'sector.'

Note: This field can only be accessed when a prompt list exists.

sector

Recommendations

Name

Behavior

Prompt Key

Reference Type

A standard list of prompt values is provided. Additional reference types may be added to the list of options, and the entire list will be overwritten by adding prompts.

Must include index value to be stored (e.g., for 'Counselor Recommendation' include an index value of 'C,' for 'Teacher Recommendation' include index value of 'T,' for 'Clergy Recommendation' include index value of 'O').

Important!

Do not use 'R' as an index value. 'R' is a standard reserved index value.

reference_type

Relationships

Name

Behavior

Prompt Key

Relationship Type

Allows an applicant to include a type when providing relationship details. The prompt requires that a Category be included for proper relationship ranking.

Categories:

Sibling
Parent
Legal Guardian
Step-Parent

relationship_type

Relationship Education Level

Allows an applicant to include an education level when providing relationship details. Example: Graduate, Undergraduate, High School.

relationship_education_level

Relationship Prospective Entry Term

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of "term." This list will likely be shared across multiple fields/scopes that revolve around Entry Term.

term

Interests

Name

Behavior

Prompt Key

Interest Type

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'activity_type.'

These prompts will display on the interest tab of a person record.

activity_type

Interest Name

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'activity_name.'

Note: This field is required for the use of Interests.

These prompts will display on the activities application page.

activity_name

Sports

Name

Behavior

Prompt Key

Sport

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'sport.'

Note: This field is required for the use of Sports.

sport

Sport Rating

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'sport_rating.'

Note: This field is required for the use of Sports.

sport_rating

Projects

Name

Behavior

Prompt Key

Project Status

A standard list of prompt values is not provided. Add a prompt list to define those values using a key of 'project_status.' A 'Complete' prompt must exist and requires that a category be included for Projects and Tasks to be marked as 'Complete.'

Note: This field is required for the use of Projects.

Prompt & corresponding categories examples include:

Prompt	Category
Complete	Complete
In Progress	In Progress
Not Started	Not Started

project_status