Masked Secure Text Field for Jira enables to restrict its value from reading by unauthorized users. Additionally, it allows controlling data entry formats so that entered data is valid. For example, a text editor should only accept phone numbers or an email field might have a validation rule that disallows entering an email address that is incorrectly formatted.
| Info |
|---|
Custom field values are stored in a database in an unmasked and non-encrypted way. |
We use Java regular expressions to define validation/masking pattern.
Video
| Widget Connector | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Permissions
| Info |
|---|
New permission has been added. |
Make sure to grant Read masked field permission to the respective user in order to enable the user to read or edit the masked field value.
Field configuration
Configure parameters for the Secure Masked Text
Mask regular expression -
regular expression pattern that will be used to determine which characters should be masked.
Validation regular expression - checks whether the entered value matches the given format.
Validation error message - general error message if the validation checks fail. You can define your own custom message to display in case of errors.
| Tip |
|---|
As a Jira Administrator, you can change the standard configuration and set different limits or conditions on the data that can be entered in the field. |
Mode: if Standard mode is being used (this is set by default), an error message is not thrown in case of invalid input and the entered value is accepted.
However, all field characters will be masked.
Strong mode - in this case, the system won’t let the user enter an invalid format of data and will alert the user with the pre-defined error message.
Test your configuration
You can preview how
Let's start with a simple example to understand how the masked field works.
After adding new masked field, set up permission
the masked field would look in case of valid and invalid inputs.
The input value is automatically validated to ensure that it’s a properly formatted e-mail address.
| Warning |
|---|
Notice that in case of invalid input all characters are masked (only applies to Standard mode). |
Masked Field History
| Info |
|---|
Only users with respective permissions can view or delete the history of the Masked field. |
If Save field history option is enabled, Masked Field stores its history. So every time a user changes the value, the history section gets updated.
In a history record, a user can view the following information: who made a change, time when a change was made, new and old Masked field values. Values presented in history are masked (with the currently configured pattern) regardless of Read masked field permission.
Masked Field Search
| Note |
|---|
Limited capability of searching over the masked fields. |
Users are unable to search for the content of the masked field.
Only is Emptyor is not Emptyoperators can be used for searching in either Performance or Strict mode.
Standard Sample Masks
The following table describes the standard patterns with respective examples.
Pattern | Description | Example | Masked field view |
All characters | Allows any characters, including spaces. Mask everything except for the last 3 characters. |  |  |
Phone number | Allows digits from 0 to 9 and specified symbols. Mask everything except for the last 3 digits. |  |  |
Integer | Allows integer numbers. |  |  |
Decimal | Allows decimal numbers. Mask all characters except decimal point. |  |  |
Allows entries in the email address format. |  |  | |
IPv4 | Allows entries in IPv4 format. |  |  |
IPv6 | Allows entries in IPv6 format. |  |  |
00-000 | Allow a respective number of digits. |  |  |
000-000-00-00 |  |  | |
0000-0000-0000-0000 |  |  |