Barcode Component

Function

a!barcodeField( label, labelPosition, instructions, acceptedTypes, value, saveInto, refreshAfter, required, requiredMessage, readOnly, disabled, validations, validationGroup, align, placeholder, helpTooltip, masked, accessibilityText, showWhen )

Displays and allows entry of a barcode value using a barcode scanner or manual input.

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page.
Instructions	`instructions`	Text	Supplemental text about this field.
Accepted Types	`acceptedTypes`	List of Text String	Determines the types of barcodes that are accepted in the field. Null results in all types being accepted. Valid values: `"CODE39"`, `"CODE93"`, `"CODE128"`, `"DATAMATRIX"`, `"EAN8"`, `"EAN13"`, `"PDF417"`, `"QRCODE"`, `"UPCA"`, `"UPCE"`.
Display Value	`value`	Text	Text to display in the field.
Save Input To	`saveInto`	List of Save	One or more variables that are updated with the text when the user changes it. Use a!save() to save a modified or alternative value to a variable.
Refresh After	`refreshAfter`	Text	Determines when the interface is refreshed with the saved value from the barcode 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: false.
Required Message	`requiredMessage`	Text	Custom message to display when the field's value is required and not provided.
Read-only	`readOnly`	Boolean	Determines if the field should display as not editable. Default: false.
Disabled	`disabled`	Boolean	Determines if the field should display as potentially editable but grayed out. Default: false.
Validations	`validations`	List of Text String	Validation errors to display below the field when the value is not null.
Validation Group	`validationGroup`	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, `“validation group”` is not a valid value. You need to add an underscore between words: `“validation_group”`. See the following recipes for more information: Configure Buttons with Conditional Requiredness Validation Groups for Buttons with Multiple Validation Rules'
Alignment	`align`	Text	Determines alignment of the text value. Valid values: `"LEFT"` (default), `"CENTER"`, `"RIGHT"`.
Placeholder	`placeholder`	Text	Text to display in the field when it is empty. Does not show if the field is read only.
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"`.
Masked	`masked`	Boolean	Determines if the value is obscured from view. Default: false.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
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.

Usage considerations

Scanning on different devices

The native device's camera is used on mobile devices to scan barcodes.
The masked parameter is ignored on offline interfaces on Android devices. All barcode components are shown un-masked in this case.
The barcode component does not support barcode scanning on Appian's web user interfaces. Instead, users can manually enter barcode values.

Using the acceptedTypes parameter

Use the acceptedTypes parameter to specify one or more type(s) of barcode.

Examples

To experiment with examples, copy and paste the expression into an interface object.

Without masking

Use the interactive editor below to test out your code:

Displays the following on Appian's browser user interfaces:

screenshot of a barcode without masking in a browser

Displays the following on Appian Mobile iOS application:

screenshot of a barcode without masking on the mobile app on iOS

Displays the following on Appian Mobile Android application:

screenshot of a barcode without masking on the mobile app on Android

With masking

Use the interactive editor below to test out your code:

Displays the following on Appian's web user interfaces:

screenshot of a barcode with masking in a browser

Displays the following on Appian Mobile iOS application:

screenshot of a barcode with masking on the mobile app on iOS

Displays the following on Appian Mobile Android application:

screenshot of a barcode with masking on the mobile app on Android

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
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.

Feedback

Was this page helpful?