Line Input Control

Add a control that displays a text field that allows the Request participant to enter plain text or a password.

Control Description

The Line Input control is a text field that the Request participant can use to enter information. The Line Input control can be configured to accept the following data types:

  • Text: The control only accepts alphanumeric characters.

  • Integer: The control only accepts integers.

  • Currency: The control only accepts a currency value.

  • Percentage: The control only accepts a percentage value.

  • Decimal: The control only accepts any number, both positive and negative.

  • Datetime: The control only accepts a datetime, which is includes both date and time components.

  • Date: The control only accepts a date.

  • Password: The control accepts a password. Entered text is hidden.

As a best practice when a Vocabulary validates the JSON in a Screen for a datetime value, use a Date Picker control instead of a Line Input control.

Add the Control to a Screen

Permissions

Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the Screens permissions or ask your Administrator for assistance.

Follow these steps to add this control to the Screen:

  1. Drag the Line Input icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.

  2. Place into the Screen Builder canvas where you want the control to display on the Screen.

  3. Configure the Line Input control. See Settings.

  4. Validate that the control is configured correctly. See Validate Your Screen.

Settings

The Line Input control has the following panels that contain settings:

Variable Panel Settings

Click the control while in Design mode, and then click the Variable panel that is on the right-side of the Screen Builder canvas. The Line Input control has the following settings in the Variable panel:

Variable Name

Use the Variable Name setting value in the following ways:

  • Reference this control's value in a different Screen Builder control. To do so, use mustache syntax and reference this control's Variable Name value in the target control. Example: {{ LineInputControl }}.

  • Reference this value in Visibility Rule setting expressions.

See best practices when editing a Request variable name.

Label

Label

Ensure that all Line Input controls implemented in a Conversational-type Screen contain Label setting values. See Controls in Conversational-Type Screens Require Labels.

Data Type

Select one of the following data type options this control accepts when the Request participant enters content into this control:

  • Text: The control only accepts alphanumeric characters. Text is the default setting.

  • Integer: The control only accepts integers.

  • Currency: The control only accepts a currency value.

  • Percentage: The control only accepts a percentage value.

  • Decimal: The control only accepts any number, both positive and negative.

  • Datetime: The control only accepts a datetime, which is includes both date and time components.

  • Date: The control only accepts a date.

  • Password: The control accepts a password. Entered text is hidden.

For the Currency and the Percentage data types, data formatting is not saved in the Request variable linked to the Line Input control. As a result, the formatting is not available if the variable is used elsewhere in that Request. For example, instead of $50.00, the Request variable only saves the value 50.

The following message displays below the control if the Request participant enters content that does not comply with this control's data type: The format is invalid.

Validation Rules

Follow these steps to add a validation rule to this control:

  1. Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.

  2. Select the rule that this control validates against.

  3. Click Save. Parameters for the selected rule display. Parameter settings display which ones are required to properly configure the rule.

  4. Enter the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.

Follow these steps to edit a validation rule for this control:

  1. Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.

  2. Edit the parameter settings that this control uses to validate against. See Validation Rule Settings, and then locate the validation rule for its parameters.

Follow these steps to delete a validation rule for this control:

  1. Access the Variable panel for this control while in Design mode, and then locate the Validation Rules setting.

  2. Click Delete.

Required and Read Only

Make Required

Read Only

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas. The Line Input control has the following settings in the Configuration panel:

Placeholder Text
Helper Text

Design Panel Settings

Click the control while in Design mode, and then click the Design panel that is on the right-side of the Screen Builder canvas. The Line Input control has the following settings in the Design panel:

Text Color
Background Color

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas. The Line Input control has the following settings in the Advanced panel:

Default Value

Enter the default value this control displays. The default value can be assigned as a Request variable, text or JavaScript. When the Screen submits, the Request uses this control's default value unless the Request participant changes it. When using a Request variable in the Default Value setting, consider the following:

  • If the Request variable is empty, the control does not display any value by default.

  • When the Request variable is assigned a value for the first time, this value becomes the permanent default value of the control.

  • Any further changes to the Request variable do not affect the default value of the control.

The Default Value setting supports using Request variables in mustache syntax. For example, if the Default Value setting is {{ FirstName }} {{ LastName }} from which a Request participant entered her first name and last name in separate controls (respectively) earlier in that Request, this control displays the contents of those controls by default during the Request.

There are two ways to enter the default value this control displays.

Visibility Rule

Note the following regarding how to use visibility rules:

Device Visibility

Select on which device types this control displays:

  • Desktop: The control displays only on desktop devices. Enable the Show for Desktop toggle key.

  • Mobile: The control displays only on mobile devices. Enable the Show for Mobile toggle key.

Custom Format String

Date, SSN and Phone mask pattern display as examples.

Use the following mask components to compose your mask pattern:

Examples

  • Additionally, to ensure that users enter the correct number of digits, use Validation Rules to set Max Length and Min Length of this control to 9.

  • Additionally, use the Min Length and Max Length Validation Rules to define character length boundaries for this control.

  • Additionally, use the Min Length and Max Length Validation Rules to define character length boundaries for this control.

This custom format input overrides any other formatting set by default, including the one described when using scripts.

CSS Selector Name
Aria Label

Enter the string that provides a text alternative to this control for the following purposes:

  • Assistive technology, such as screen readers, read the Aria Label setting value.

  • This control has a visual indication of its purpose, such as a button that uses a graphic instead of text, but still needs to clarify that purpose for anyone who cannot access the visual indication.

Tab Order

Tab order determines the sequential navigation order to navigate a Screen's controls using a keyboard interface. Assistive technology users often use a keyboard for navigation.

See best practices for setting the tab order for a Screen's controls.

Last updated

© Copyright 2000-2024 ProcessMaker Inc. All rights reserved.