Customizing Standard Fields & Prompts
  • 04 Apr 2024
  • 15 minute read
  • Dark
    Light
  • PDF

Customizing Standard Fields & Prompts

  • Dark
    Light
  • PDF

Article Summary

Slate delivers a multitude of customizable standard fields and prompts. This article indicates each field and the steps required to customize it.

For additional information on standard fields and prompts, refer to the Standard Fields & Prompts Knowledge Base article.

🔔 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.

Configuring fields and prompts

To configure fields:

  1. Select Database on the top navigation bar

  2. Select Fields.

To configure prompts:

  1. Select Database on the top navigation bar

  2. Select Prompts.

Person Information

Biographical

Name

Behavior

Field ID

Prompt Key

Birth Nation (Country)

  • Enables “Birth Country,” which appears at the bottom of the Biographical Information section of a Slate application.

  • This field can exist on its own. However, this field must exist to enable the Birth Place and Birth Region fields.

birthnation

country

Birth Place (City)

  • Creating this field with the ID of “birthplace” enables “Birth City” and displays it at the bottom of the Biographical Information section of a Slate application. Set the Value to “Store Value.”

  • 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 appear 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 appear. 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

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 uses a special prompt key of "sex."

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." For instance, a custom field for “relationship sex” or housing assignments.

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,” and 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” (for example, “Hispanic – Other,” “Asian – Other,” or “Black or African American – Other,”) will enable “Other” under 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 appear 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 might want 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” could be added.

This behavior can be replicated for the other “race” category prompts (such as “Asian - Chinese” or “Asian - Japanese”).

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 (“Cherokee,” “Tomahawk,” “Chinese,” “Japanese,” and so on) 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” generates a free-text field with a label of “Tribal Affiliation” on a Slate application.

Additionally, this field will only appear if: 

  1. It is set to “Show” in the “General Settings” section of the Personal Background part in the Application Editor.

  2. At least one other “American Indian or Alaska Native” prompt exists (“American Indian or Alaska Native - Other,” ”American Indian or Alaska Native – Cherokee,” and so on).

NOTE: This field should be set to Person scope. 

tribal

n/a

Tribal Enrollment

Creating this field with the ID of “tribalEnrollment” enables a free-text field under the “Tribal Affiliation” question on a Slate application with the label of “Enrollment Number.”

This field will only appear if: 

  1. A field with the ID of “tribal” exists.

  2. “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 enable 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,” and “Mexican,” 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,” and so on.

NOTE: This field should be set to Person scope. 

hispanicOrigin

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.

For this text data value to store on the person record, a field with an ID of “hispanicOther” must be created. (Note: Be sure to set the "Value" setting for this new field to "Store Value (bit...etc.)" because 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” enables “Current Visa Type” and appears 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" enables "Permanent Resident Card Number" and appears under "Residency Status" on a Slate application only when "U.S. Permanent Resident" has been selected.

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 generates 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” generates a selectable race option box of “Other” that when clicked, displays 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” (for example, “Hispanic – Other,” “Asian – Other,” or “Black or African American – Other”) enables “Other” under 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 appear after 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:

  • 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 might want to include more prescribed options besides “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” can be added.

This behavior can also be replicated for the other “race” category prompts (such as “Asian - Chinese” or “Asian - Japanese”).

Two items to also keep in mind: 

  • The next two Field items in this table contain functions related to the “American Indian or Alaska Native” prompts in particular.

  • To show the checkboxes of the items mentioned in this example (such as “Cherokee,” “Tomahawk,” “Chinese,” or “Japanese”) 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” generates a free-text field with a label of “Tribal Affiliation” on a Slate application.

Additionally, this field will only display if: 

  1. It is set to “Show” in the “General Settings” section of the Personal Background part within the Application Editor.

  2. At least one other “American Indian or Alaska Native” prompt exists (such as “American Indian or Alaska Native - Other” or “American Indian or Alaska Native – Cherokee”).

NOTE: This field should be set to Person scope. 

tribal

n/a

Tribal Enrollment

Creating this field with the ID of “tribalEnrollment” enables a free-text field under the “Tribal Affiliation” question on a Slate application with the label of “Enrollment Number.”

This field will only display if: 

  1. A field with the ID of “tribal” exists.

  2. “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” enables 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,” and “Mexican,” can be created.

To create these additional checkbox categories, set the key of the prompt to “hispanicOrigin,” but set the value of the prompts to “Colombian,” “Mexican,” “Cuban, and so forth.

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 appears if this option is chosen. For this text data value to store on the person record, a field with an ID of “hispanicOther must be created. (Note: Be sure to set the Value setting for this new field to "Store Value (bit...etc.)" because this is a text field.)

hispanicOther

n/a

Address

Name

Behavior

Prompt Key

Address Type

Address Type uses 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."

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 select list for 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” causes 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 can be modified, and additional types may be added to the list of options.

This must include an index value to be stored (such as for “High School,” include an index value of “H,” for “Graduate,” use an index value of “G, and for “Undergraduate,” use an index value of “U”).

school_type

Degree

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

Creating prompt values with a key of “degree” adds more values to the list. Additionally, for admissions databases, placing the following code snippet into the XML box will display degrees based on “Level of Study” in 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>decline</k>
<v>H</v>
</p>

Undergraduate (Level of Study) is selected

<p>
<k>decline</k>
<v>U</v>
</p>

Graduate (Level of Study) is selected

<p>
<k>decline</k>
<v>G</v>
</p>

This 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” automatically changes 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” automatically changes 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 by creating a prompt with a key of “honors.”

honors

School Courses

Course information stored on the student record on the Profile tab is commonly used to track classes taken before admission to a college. If you are sharing an instance between Admission and Student Success, you might want to use entities to capture current college-level classes rather than using the Courses table. School courses are related to a specific school on the person record, so data for each course must have a school saved to the person record on which to save it.

Name

Behavior

Prompt Key

Course Name

By default, “Course Name” is a text box field.

Adding prompts with Key of “course_name” automatically changes 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

Job history information stored on the student record within the Profile tab is commonly used to track employment occurring before admission to a college. If you are sharing an instance between Admission and Student Success, you may wish to use entities to capture enrolled student job history. 

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 can be added to the list of options, and the entire list will be overwritten by adding prompts.  

This must include an index value to be stored (for example, for “Counselor Recommendation,” include an index value of “C,” for “Teacher Recommendation” include an index value of “T,” for “Clergy Recommendation” include an 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

Enables 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

Enables an applicant to include an education level when providing relationship details (for example, Graduate, Undergraduate, or 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

Interest information stored on the student record’s Profile tab is commonly used to track interests before admission to a college. If you are sharing an instance between Admission and Student Success, you might want to use entities to capture enrolled student 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 appear 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 appear on the activities application page.

 activity_name

Sports

Sport information stored on the student record within the Profile tab is commonly used to track sports before admission to a college. If you are sharing an instance between Admissions and Student Success, you might want to use entities to capture enrolled student 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.

Prompts and corresponding category examples include:

Prompt

Category

Complete

Complete

In Progress

In Progress

Not Started

Not Started

project_status


Was this article helpful?