Protected Field Component

The Protected Field is a Centauri (v1.0) component that masks data entered in Express View. Masking is useful when your end-user needs to enter PII they do not want the information to be seen, like a Social Security or account number.

Consider using a Protected Field component when:

  • Preventing the field from being viewed in real-time by anyone other than your end-user. Using a Protected Field component helps prevent "shoulder surfing", which is when someone physically views the end-user's screen to collect information.

  • You do not need to store sensitive data in the database. The Protected Field component does not include the Store Data in Database setting.

A Protected Field component works like a Text Field or Number component, but values entered in a Protected Field component do not display in the field. Instead, the field displays a substitute character, like asterisks or dots.

The Protected Field component does not support built-in encryption or other security features. It only masks the end-user's input in Express View. Therefore, the Protected Field component is not a good option for storing passwords.×

You'll find the Protected Field component under the Secondary Fields group to the left of the Module Builder.

To learn more about general component settings, view our General Component Settings article.×

Field Text

A static image dispaying the Protected Field component's Display settings.

Setting

Description

Label Text

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Placeholder Text

A short prompt telling end-users the expected value of an input field. For example, Enter your Social Security Number. Placeholder Text displays inside the input field until the end-user begins an entry.

Prefix

Alphanumeric characters append to the start of the value entered in the field. If called by another component, the prefix stores with the value.

Suffix

Alphanumeric characters that append to the end of the value entered in the field. If called by another component, the suffix stores with the value.

Contextual Help

Setting Description

Tooltip

A quick tip describing the expected value of an input field. Unlike a Tooltip, Helper Text stays visible under the input field and displays on a single line.

Default State Options

Setting Description

Hide Field

Displays or hides the component from view. Setting Hide Field to  (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder.

By default, Hide Field is set to (OFF).

Input Behavior

Setting Description

Input Behavior

Controls how end-users interact with the component. Choose from the following options:

  • Enable User Input: Allow end-users to view and enter data in this field.

  • Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.

  • Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

Configure a Protected Field component to collect an account number. You'll use validation settings to ensure the account number is exactly 10 characters in length. These instructions assume that you have an open module saved with a title.

1. In the Module Builder, drag and drop a Protected Field component onto your canvas.
2. In the Property ID field, enter accountNumber.
3. In the Label Text field, enter Enter Account Number.
4. In the Min Length and Max Length fields, enter 10.
5. Navigate to the component's Advanced settings.
6. In the Min Length Error Message and Max Length Error Message fields, enter Account number must be 10 digits long..

A static image displaying the Protected Field component's Advanced settings. The Min & Max Length fields, and the Min Length & Max Length Error message fields are highlighted.

7. Click Save Component.
8. Save your module.

Preview your module in Express View to see the following functionality:

A Protected Field component stores its data as key/value pair. The value is stored as a string data type.

A static image displaying the Developer Console view, the Submission Data displays the Protected Field component as a key-value pair.