a!encryptedTextField( label, instructions, required, readOnly, disabled, value, saveInto, refreshAfter, validationGroup, requiredMessage, align, labelPosition, placeholder, helpTooltip, masked, accessibilityText, showWhen, inputPurpose )
Allows entry of a single line of text that is encrypted when saved into a variable. The value remains encrypted while on the server and is only decrypted when displayed in the component.
The entered value is encrypted before being stored in the variable specified by the Save Input To parameter. The Display Value parameter is decrypted just before being displayed. The value remains encrypted when stored on disk.
See Also: Encrypted Text Data Type, Text
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Instructions |
|
Text |
Supplemental text about this field. |
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
Read-only |
|
Boolean |
Determines if the field should display as not editable. Default: false. |
Disabled |
|
Boolean |
Determines if the field should display as potentially editable but grayed out. Default: false. |
Display Value |
|
Decrypted Text |
Text to display in the text field. |
Save Input To |
|
List of Save |
One or more variables that are updated with the encrypted text when the user changes the field. |
Refresh After |
|
Text |
Determines when the interface is refreshed with the saved value from the barcode field. Valid values are |
Validation Group |
|
Text |
When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, |
Required Message |
|
Text |
Custom message to display when the field's value is required and not provided. |
Alignment |
|
Text |
Determines alignment of text value. Appian recommends this setting only be used inside the Grid Layout component. Valid values: |
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
Placeholder |
|
Text |
Text to display in the field when it is empty. Does not show if the field is read only. |
Help Tooltip |
|
Text |
Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is |
Masked |
|
Boolean |
Determines if the value is obscured from view. Default: false. |
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Visibility |
|
Boolean |
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
Input Purpose |
|
Text |
Indicates the intent of input for accessibility improvements, like autocomplete, used by browsers and assistive technologies. Valid values are |
xxx-xx-xxxx
, nor is it possible to compare to values of type Encrypted Text to determine if they are equal.[Encrypted Text]
in the value column.a!localVariables()
are valid."OFF"
, autocomplete may be disabled depending on your browser settings. The default behavior allows for autocomplete, but does not require you to specify inputs.true
.Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Feature | Compatibility | Note |
---|---|---|
Portals | Incompatible | |
Offline Mobile | Compatible | |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
Encrypted Text Component