Function: a!encryptedTextField()
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.
See Also: Encrypted Text Data Type, Text
Parameters
Name | Keyword | Type | Description |
---|---|---|---|
Label | label | Text | Optional text to display as the field label. |
Label Position | labelPosition | Text | Optional text to determine where the label appears. Valid values include
|
Instructions | instructions | Text | Optional text displayed below the field's value. |
Help Tooltip | helpTooltip | 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 "COLLAPSED" . |
Placeholder | placeholder | Text | Optional text to display in the field when it is empty. Does not show if the field is read only. |
Display Value | value | Decrypted Text | Text to display in the text encrypted field. |
Save Input To | saveInto | Save Array | One or more variables that are updated with the encrypted text when the user changes the field. |
Refresh After | refreshAfter | Text | Determines when the interface is refreshed with the saved value from the encrypted text field. Valid values are "KEYPRESS" to refresh after every character typed into the field and "UNFOCUS" (the default value) to refresh when the user deselects the field after changing its value. |
Required | required | Boolean | Determines if a value is required to submit the form. Default is false . |
Required Message | requiredMessage | Text | Custom message to be displayed when the field's value is required and not provided. |
Read-only | readOnly | Boolean | If set to true , prohibits users from editing the *value*. Default is false . |
Disabled | disabled | Boolean | Determines if the user is prevented from changing the value and determines if the field should be grayed out. Default is false . |
Masked | masked | Boolean | Determines if the value is obscured from view. Default is false . |
Validation Group | validationGroup | Text | When present, this field is only validated when a button in the same validation group is clicked. |
Alignment | align | Text | Alignment of the text value (except on mobile devices). Valid values are "LEFT" , "CENTER" , and "RIGHT" . Appian recommends setting the alignment when used in an editable grid component only. |
Visibility | showWhen | Boolean | Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
Notes
load()
local variables are valid. Literal values or variables of other types are not valid.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.Examples
Encrypting and Decrypting a Value from a User
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
=load(
local!secret,
{
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!encryptedTextField(
label: "Input",
instructions: "Enter a secret here",
masked: true,
value: local!secret,
saveInto: local!secret,
refreshAfter: "KEYPRESS"
)
}
),
a!columnLayout(
contents: {
a!encryptedTextField(
label: "Output",
instructions: "The value is displayed here",
value: local!secret,
readOnly: true
)
}
)
}
)
}
)
On This Page