User Record Custom Field - Add/Edit

User Record custom fields may be made available in the following system areas:

  • User Record
  • Forms
  • My Account
  • Self-registration
  • Data Load Wizard

To manage User Record and Self Registration custom fields, go to Admin > Tools > Core Functions > Custom Field Administration. Then select the User Record tab on the left.

To add a user record custom field, User Record from the left menu. On the User Record and Self Registration Custom Fields page, select the Fields add icon .


Enter the following information for the custom field:

  • Name - Enter name of custom field that will be visible to end user, up to 100 characters. If multiple languages are enabled for your portal, select the Translate icon to translate the field into other available languages.
  • Category - Select the category under which to associate the field. All categories available to the administrator display, in addition to a default Select option. Categories display in the order in which they are defined on the User Record Categories page. Note: Populating the Category field with "Select" results in a "Missing Required Field" error. When editing the name of a custom field, by default the field is defined under the default User Record Custom Field category.
  • Email Tag - enter name for the email tag to be associated with this field and use to retrieve the value of this field in email communications.
    • Best practice is to create email tags in all capital letters. Custom tags are prefixed with the word CUSTOM. For example, for the custom field called Profit Net, create the tag using PROFIT.NET and the system will convert this to CUSTOM.PROFIT.NET.
  • Type - From the drop-down list, select the type of field you are creating. The following options are available. See Custom Field Admin - Custom Field Type Options.
    • Date field
    • Drop down
    • Hierarchy
    • Multiple Checkbox
    • Numeric field
    • Radio button
    • Scrolling text box
    • Short text box
  • Active - Check to make the field active.
  • All Users - Allows you to include or exclude the field from a user's record for a user who is not created via self registration. If this option is selected, it is available on the user record, in self registration, as a field in custom reports, and as a criteria option when creating a group.
  • Read Only - If this option is selected, then the user record custom field cannot be edited by anyone, including administrators. A read-only user record custom field can only be updated by the data feed. Note: Self-registration custom fields are always editable by the user, regardless of the read-only setting.
  • Required - If this option is selected, this user record custom field is required and must be completed before the record is saved.
  • Secure - If this option is selected, newly created short text, scrolling text, date, and numeric user custom fields can be configured to appear as as secure fields on the user record. Secure custom fields will function like Sensitive Personally Identifiable Information (SPII) fields and can be maintained and viewed if the administrator’s IP is part of the IP safe list. The following considerations apply to this option:
    • If selected, the All Users and Active options must be check-marked.
    • Required custom fields cannot be set to secure.
    • Secure custom fields cannot be added to My Account.
    • Secure custom fields cannot be maintained via the Data Load Wizard.
    • Secure custom fields cannto be maintained or exposed via the Employee Public API.
    • Secure Custom Fields cannot be maintained via Forms.

Note: The culture of the administrator will be set as the default culture for the custom field label when creating a new custom field.

Configure Field Validation

This section is only available to organizations using Cornerstone HR, and it is only available if the administrator has permission to manage user record custom field validations. This section is only available when creating or editing short text box or scrolling text box user record custom fields.

This section enables administrators to define a required format for the custom field. When a required format is defined, any data entered into the custom field must match the required format. This enables organizations to ensure that data is entered into the custom field in the proper format. The required format is defined using a Regex Pattern.

Enter the following information for the field:

  • Regex Pattern - Enter the regular expression that defines the format in which data must be entered in the field. If no regex pattern is entered, then the system does not enforce any additional field validations. The character limit for this field is 4,000. When the custom field is saved, the system validates that the regex pattern is a valid expression. See the Regex Assistance section below for resources to assist in writing regex expressions. Note: Cornerstone Global Product Support does not troubleshoot regex issues.
  • Format Example - Enter text to explain or demonstrate the correct format for the field so that users who complete the field understand the proper way to enter information in the field. This text will appear below the user record custom field when a user is completing the field. The character limit for this field is 250. If multiple languages are enabled for your portal, select the Translate icon to translate the field into other available languages. Note: Formatting rules are enforced in the My Account and Self Registration pages but the formatting example is not visible on those pages.
  • Error Message - Enter an error message that will display when a user does not enter data in the correct format. This message should help guide the user to correctly enter the data. The character limit for this field is 250. If multiple languages are enabled for your portal, select the Translate icon to translate the field into other available languages. Note: When creating a new Regex format, the culture of the administrator will be set as the default culture for the error message.

If a valid Regex Pattern is entered, then the Format Example and Error Message are required.

Availability

Define which users have the ability to view and access the custom field. See Setting Availability Overview. The administrator must set the availability of the field if the field is to appear for other administrators and end users in the application. If availability is not set, then the field will not appear in administrator and end user areas of the application.

Save

Click Save to create or save the custom field.

Configure Field Validation Considerations and Resources

The Configurable Field Validation section is only available to organizations using Cornerstone HR, and it is only available if the administrator has permission to manage user record custom field validations. This section is only available when creating or editing short text box or scrolling text box user record custom fields.

Regex Assistance

The resources in this section may be used to learn about writing regular expressions, find common regular expressions, and test your regular expressions.

Education / Getting Started

The following resources may help you learn how to write your own regular expressions:

Common Expressions

The following resource allows you to search for common regular expressions that have already been defined for you:

Regular Expression Validator

The following resource helps you validate your regular expression before implementing it in the system:

Data Preparation for Configure Field Validations

Configurable field validations are only applied to data that is entered after the custom field validations are applied. Existing data that was entered prior to configuring the field validations is not validated until the existing data is edited.

Cornerstone recommends that organizations use configurable field validations with custom fields that are created following this enhancement. This ensures that all data within the custom field complies with the format defined for that field. However, if an organization wishes to configure field validations for existing user record custom fields, it is best practice to review and clean up all data within the existing custom field BEFORE configuring a validation. The easiest way to ensure all user data for a single field is in the correct format prior to implementing a validation is to extract user data through a report, correctly format all user data for that field, and then upload the correctly formatted data through the Data Load Wizard. After this exercise is complete and all user data for that field is of the same format, then it is safe to configure a field validation.

Considerations for Configure Field Validations

If an organization has a data feed for user record information, then if the organization implements or changes a field validation and any user data in the feed does not pass the validation for the field, then the data feed will not feed any data into the system. Therefore, it is very important that organizations review and clean up all existing data in a user record custom field if a field validation is being added to the field.

Configurable field validations are only available for User Record custom fields that are of the type short text box and scrolling text box.

If a user record custom field with field validations is included in the self-registration process or in My Account, the format example is not displayed.