Barcode Component

Barcode

Function: a!barcodeField()

Displays a field that 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, this field is only validated when a button in the same validation group is pressed. See the documentation for more information about how to use validation groups.

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.

Notes

  • 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.
  • Use the Accepted Types parameter to specify one or more type(s) of barcode.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Without Masking

1
2
3
4

=a!barcodeField(
  label: "Product Barcode",
  instructions: "Scan a barcode from a product box"
)

Displays the following on Appian's web user interfaces:

And the following on iOS:

And the following on Android:

With Masking

1
2
3
4
5

=a!barcodeField(
  label: "Product Barcode",
  instructions: "Scan a barcode from a product box",
  masked: true
)

Displays the following on Appian's web user interfaces:

And the following on iOS:

And the following on Android:

Open in Github

On This Page

FEEDBACK