FunctionCopy link to clipboard
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
ParametersCopy link to clipboard
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 |
Usage considerationsCopy link to clipboard
Using validationsCopy link to clipboard
- Since the value is encrypted before it can be acted upon by a validation expression, no validation beyond checking for requiredness is possible with this component. For example, it is not possible to write an expression that validates that an id number matches the form
xxx-xx-xxxx
, nor is it possible to compare to values of type Encrypted Text to determine if they are equal.
Accessing rule input valuesCopy link to clipboard
- When creating an interface that uses this component to save into an rule input of type Encrypted Text, the value of that input is not displayed inline in the Data pane. To access the value, click
[Encrypted Text]
in the value column.
Appearance & placeholder textCopy link to clipboard
- This component has the same appearance as the text component.
- Whether placeholder text clears on focus or input varies by device and browser.
Display values & data typesCopy link to clipboard
- The variable given as the value parameter and the saveInto parameter must be of type Encrypted Text.
- Variables declared as
a!localVariables()
are valid. - Literal values or variables of other types are not valid.
- Variables declared as
- The value given to the Display Value parameter cannot be modified by an expression that expects Text because Encrypted Text is a different data type.
- No modification to the user input before storing it into the Save Input To variable is possible for the same reason.
Using the inputPurpose parameterCopy link to clipboard
- When using inputPurpose, there is no visible change in the form factor preview.
- If inputPurpose is set to
"OFF"
, autocomplete may be disabled depending on your browser settings. The default behavior allows for autocomplete, but does not require you to specify inputs. - inputPurpose is not supported if the masked parameter is set to
true
.
ExamplesCopy link to clipboard
To experiment with examples, copy and paste the expression into an interface object.
Encrypting and decrypting a value from a userCopy link to clipboard
Feature compatibilityCopy link to clipboard
The table below lists this component's compatibility with various features in Appian.
Feature | Compatibility | Note |
---|---|---|
Portals | Incompatible | |
Offline Mobile | Incompatible | |
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. |