Toggle menu

Password (Storing)

The non-storing password input field lets a user enter a value, but disguises each character with an asterisk (*) instead of displaying the entered digits. It offers a user on-screen privacy while they are entering a password.

The value entered into this field will be stored if the form data is saved or a workflow processes started. This means that the original password, as entered, could be visible to an administrator who can view data in the form data browser or workflow process modeller.

Properties

LabelDescriptionType Name
LabelThe label for this fieldLABEL
Show LabelWhether to show the label for this field or not. This property adds/removes a class on the field's label element. The styling itself is controlled by the site's stylesheetSHOWLABEL
HintAdditional information displayed alongside the field to assist the user in completing it. The value of another field can be used by adding the field's name between # characters. See Common Field Properties for more informationHINT
RequiredWhether or not the field is required to have a value to pass validationREQUIRED
DefaultA default value for the field, displayed when the field is first loadedDEFAULT
PlaceholderAny value entered into this property is used as an HTML 5 placeholder. This is a value that will appear in the field but will be cleared when a user enters something in the field. Unlike a default value, it will not be submitted as a value for the field. If a default value is supplied, the placeholder will not be seen unless the user clears the default valuePLACEHOLDER
AutocompleteAdds a HTML autocomplete attribute to the field, which may prompt the browser to suggest relevant values for the filed, based on past or preconfigured (in the browser) values for the field. See Common Field Properties for more informationAUTOCOMPLETE
Error MessageThe error message that will be displayed if this field fails its validationERRMSG
Error Message FunctionA function that can be used to override the default error message. You can return a different message for each error type. The message can include the value of another field can be used by adding the field's name between # characters. See Error Message Functions for more information.

This field has the following error types:
 
  • REQUIRED - the field is required but has been left blank
  • MAXLENGTH - the value is longer than the maximum length
  • REGEX - the value doesn't match the regular expression
  • APPLYSITEPASSWORDRULES - the value doesn't match the password rules
  • VALIDATIONFUNCTION - the result of a custom validation function failing (validation function can also return custom error types)
ERRMSGFUNC
WidthThe display width of the field. The value matches a CSS class, which actually sets the widthWIDTH
Maximum lengthThe maximum number of characters that can be entered into the fieldMAXLENGTH
Regular ExpressionA regular expression that will be used to validate the field. If the value does not match this expression, the field validation will failREGEX
Validation FunctionA JavaScript function that can be used to provide custom field validation whenever the field value changes or the form is submitted. This function will be executed client-side, provided JavaScript is enabled in the browser, and repeated server-sideVALFUNC
Apply site Password RulesSelect true to apply the site password rules set in iCM to the password entered by the user. The chosen password must meet these rules before the password can be set/reset. Rules can be displayed on the form using the Password Guidance Text fieldAPPLYSITECONFIGRULES
Default FunctionA JavaScript function that can be used to calculate the default field value. This function is executed server-side when the field HTML is generated and is useful when the DEFAULT property is insufficientDEFFUNC
HandlersA JavaScript function that is executed client-side whenever the page loads, or the field value changes. This function is useful for modifying the values of other fields based on an entered valueHANDLERS
Read OnlyDisplay the field as read onlyREADONLY
Additional Styling ModifierAn optional CSS modifier for the field. See Common Field Properties for an exampleADDITIONALSTYLINGMODIFIER
DocumentationAdd documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an exampleDOCUMENTATION

Share this page

Facebook icon Twitter icon email icon

Print

print icon