FSM Mobile Element Properties

Note:

This topic is intended for administrators and developers who configure element properties in Field Service Management (FSM) Mobile.

Properties configure an element's displayed label, stored value, validation, and input behavior. All elements except the display-only heading element support the common properties. For additional properties by element type, see Element-Specific Properties. Resource preparation properties and shared-list elements are described separately.

This topic includes the following sections:

Common Element Properties

Except for the display-only heading element, every element supports the following common properties. The common properties supported by heading are type, name, parent, label, and hidden. It also supports the type-specific level property. For more information, see Element-Specific Properties and FSM Mobile Element Properties and Defaults by Type.

Property

Description

Format and Accepted Values

Expressions

Default

type

The element type. Include it in each manually defined element.

String

One of the types in FSM Mobile Element Types.

No (structural property)

Required for a manually defined element. A loaded form supplies its generated type.

name

Stable identifier used to store and reference the element value.

String

A unique element identifier within the resource, including its table children.

No (structural property)

Supplied by the property name in the resource's element object.

parent

Identifies the parent table that owns this column element.

String

The name of a top-level table element. The named parent must be "type": "table". Omit this property for top-level elements.

No (structural property)

Omitted (top-level element)

value

Sets a static default for a new record, or a calculated value when configured as an expression. A static value doesn't replace a saved value when an existing record is opened.

Type-specific

For information about the element's format type, see FSM Mobile Element Types.

Yes (result must match the element format).

A loaded form can supply an initial value. Otherwise, use the type-specific fallback in the element table.

label

Label shown with the element.

String

Any display text.

Yes (String result).

""

required

Requires a nonempty accepted value before the form can be completed.

Boolean

true, false

Yes (Boolean result).

false

disabled

Displays the element but prevents user input.

Boolean

true, false

Yes (Boolean result).

false

hidden

Doesn't display the element.

Boolean

true, false

Yes (Boolean result).

false

readonly

Displays the value without allowing edits.

Boolean

true, false

Yes (Boolean result).

false

class

Additional supported style class tokens. Use only documented styling tokens.

String

A supported class token string.

Yes (String result).

""

Element-Specific Properties

The following table lists additional properties for specific element types. Each property is supported only for the listed types.

Property

Description

Supported Types

Accepted Values and Expressions

Default

accept

Sets the file-type filter shown by the browser file picker.

file, image

Comma-separated extensions or MIME-type specifiers. Configure, for example, "accept": ".pdf,.docx" or "accept": ".jpg,.jpeg,.png".

Expressions: Yes (String result).

file: omitted, so no picker filter. image: .bmp,.gif,.jpg,.jpeg,.pjpg,.pjpeg,.png,.tiff,.tif

autoselect

Selects the only option automatically when no option is marked selected. Applies only to single-select lists.

select

true, false

Expressions: Yes (Boolean result).

Set explicitly. For information about select defaults and stored values, see Select Defaults and Stored Values.

barcode

Enables device barcode scanning where the device or browser can provide camera access.

select, text

true, false

Expressions: Yes (Boolean result).

false

camera

Enables image capture from the device camera.

image

true, false

Expressions: Yes (Boolean result).

false

column

Selects an element for a list column and controls column order. For a top-level element, this affects the Resource Index. For a table child, it affects the table list.

Top-level elements and direct children of table elements

A numeric position, such as 1 or 2. null doesn't reliably exclude a column.

Expressions: No (list structure)

FSM can assign columns to the first visible elements when fewer than two have been configured.

cols

Sets the visible text width.

html, textarea

Positive integer.

Expressions: Yes (positive integer result).

null

downsample

Sets the maximum width or height, in pixels, for images in supported formats before upload. FSM Mobile preserves the image proportions. This is not a file-size limit.

file, image

Positive whole-number pixel value, for example 1080.

Expressions: Yes (positive integer result).

Resource imagesize value. The standard FSM Mobile default is 1080 pixels.

height

Sets the signature input height.

signature

Positive pixel value.

Expressions: Yes (positive integer result).

148 pixels

level

Sets the heading level.

heading

1, 2, 3

Expressions: Yes (integer result from 1 through 3).

1

max

Sets the maximum permitted numeric, date, or time value. It doesn't set a text character limit. Use maxlength for that purpose.

date, datetime, number, time

Number for number, otherwise the canonical value format for that type.

Expressions: Yes (result must match the element type).

null (no maximum), unless supplied by configuration. Form loading doesn't read a NetSuite field's maximum restriction.

maxlength

Sets the maximum character count for editable text entry.

html, text, textarea

Positive integer.

Expressions: Yes (positive integer result).

text: 300, textarea: 4000, html: no configured limit. Generated form fields and aliases can supply different values.

maxsize

Sets the client-side size limit, in KB, for non-bitmap files selected through a File element. It is not applied by an Image element. Recognized bitmap files selected through a File element are down-sampled instead and bypass this limit.

file, image

Positive whole-number KB value.

Expressions: Yes (positive integer result).

10240 KB (10 MB). The Image input doesn't apply this value.

min

Sets the minimum permitted numeric, date, or time value.

date, datetime, number, time

Number for number, otherwise the canonical value format for that type.

Expressions: Yes (result must match the element type).

null (no minimum), unless supplied by configuration. Form loading doesn't read a NetSuite field's minimum restriction.

multiple

Allows more than one option to be selected. The selected value must match the resulting selection mode.

select

true, false

Expressions: Yes (Boolean result).

false

options

Defines the options that a Select element presents. Hidden shared-list elements can also supply options to other elements.

select, hidden shared-list elements described in Shared Option Lists and URI References

A static list is an array of option objects. A configured option source or expression must resolve to an array of option objects. For information about configuring select options, see Configuring FSM Mobile Select Elements.

Expressions: Yes (array result for Select inputs).

[] for a Select input.

pattern

Validates input against a regular expression during article validation. Email retains its built-in live email-format check. A configured pattern doesn't replace that check in the editable Email input.

email, password, tel, text, url

Valid regular-expression source string.

Expressions: Yes (valid regular-expression String result).

"" (no configured pattern validation)

placeholder

Displays hint text when the field has no value.

email, html, password, select, tel, text, textarea, url

String.

Expressions: Yes (String result).

""

precision

Sets the maximum number of decimal places in the editable control and display when no unit precision or step display precision applies.

number

Whole number from 0 through 8.

Expressions: Yes (whole-number result from 0 through 8).

8

remote

Loads Select options from the server on demand. Requires a connection and an option source configured for the request. With search: true, the option source can use the entered search text. This is separate from resource-level remote.

select

true, false

Expressions: Yes (Boolean result).

false

rows

Sets the visible text height.

html, textarea

Positive integer.

Expressions: Yes (positive integer result).

textarea: 6, html: 3. Generated form fields and aliases can supply different values.

search

Enables search within this element's Select list. This is separate from resource-level search on the Resource Index.

select

true, false

Expressions: Yes (Boolean result).

false

step

Sets the permitted increment.

date, datetime, number, time

Positive number for number, positive whole number for date and time values. Date uses days. Datetime and time use seconds.

Expressions: Yes (result must meet the type-specific increment rule).

null for date and number, 1 for datetime, 60 for time

stepper

Shows numeric increment and decrement controls.

number

true, false

Expressions: Yes (Boolean result).

false

text

Provides display text for a read-only web address. The address remains the value.

url

String.

Expressions: Yes (String result).

""

unit

Selects the unit used for number display formatting.

number

Unit identifier string.

Expressions: Yes (String result).

""

width

Sets the signature input width.

signature

Positive pixel value.

Expressions: Yes (positive integer result).

448 pixels

Element Definition and List Properties

The following properties control resource preparation and list presentation. These properties are separate from the input properties in the preceding tables.

Property

Purpose

Accepted Value

Default

index

Inserts the element at a position in the resource's element order. Use 0 for the first position. It doesn't set the Resource Index column order.

Nonnegative whole number.

Element definition order.

title

Uses this element's displayed value, with its label when present, as the individual record page title. Set title on one top-level element that has a value. A hidden element can supply the title.

true or false.

No configured title element.

map

Supplies this element's field mapping when the resource uses automap and its article map doesn't already contain an entry for the element.

A valid field mapping for the element's data shape.

A mapping derived from the element name and type when automatic mapping is enabled.

uri

Registers a loaded supporting element for expressions in other resources. The uniform resource identifier (URI) can differ from the element's name.

A unique string that is a valid JavaScript identifier, such as services.

Not registered for cross-resource references unless configured.

textenhance

Selects the Text Enhance prompt for an editable textarea element when Enhanced Technician Notes is enabled.

Prompt internal ID as a string. Use "" to turn off enhancement for this element.

The configured cleanup prompt when the feature is enabled, or "" otherwise.

Use fixed values for index, title, and uri. An explicit article map takes precedence over an element's automatic mapping. For mapping syntax and record searches, see FSM Searches and Field Mapping. For the resource's automap property, see FSM Mobile Resource Properties Reference.

For Text Enhance enablement, prompt setup, and availability, see Enhanced Technician Notes. Setting an element's prompt doesn't itself enable that feature.

Shared Option Lists and URI References

A hidden Text element can hold shared options for other elements without providing an interactive Select input. Its uri registers the element for cross-resource references.

During rendering, FSM removes an option array if the element's hidden and value properties both contain values treated as true. This applies when options is already an array at that stage, including a static option list. An empty array or object in value is also treated as true. Omit value when defining a hidden shared-list element whose option array must remain available. This removal happens before option-search resolution. It doesn't remove every hidden element's options.

For the complete supplier and consuming Select examples, resource-loading rules, and refresh behavior, see Sharing Data Between Resources. For information about URI reference syntax and expression scope, see FSM Expressions and Template Tags. Each consuming Select still needs its own selected value and save mapping.

File and Image Selection and Upload Behavior

Use accept to filter the file types offered by the device's file picker. Specify a comma-separated string of extensions or MIME-type specifiers. For example, this fragment defines two elements:

            {
  "attachment": {
    "type": "file",
    "accept": ".pdf,.docx,.xlsx",
    "maxsize": 10240
  },
  "photo": {
    "type": "image",
    "accept": ".jpg,.jpeg,.png"
  }
} 

          

The following table compares the default and configured picker filters.

Element Type

Default Picker Filter

Explicit accept Behavior

file

No filter.

Applies the configured filter.

image

.bmp,.gif,.jpg,.jpeg,.pjpg,.pjpeg,.png,.tiff,.tif

Replaces the default filter for existing-file selection. With camera: true, the camera selection path uses image/*.

Important:

accept guides file selection. It doesn't validate the upload. Device and browser behavior can allow files outside the filter. Don't rely on this property to enforce permitted file types.

downsample limits the largest image dimension and preserves the image proportions. It processes PNG, JPG/JPEG, GIF, and BMP images. It doesn't convert other file formats. The standard routes/mobile.imagesize value is 1080 pixels. Set downsample on an element to override this value.

maxsize applies to non-bitmap files selected through a File element. The selected file must be smaller than the configured limit in KB. For example, 10240 specifies 10 MB. Recognized bitmap images use image processing instead and bypass this check. Image elements don't enforce maxsize. Neither property guarantees that NetSuite will accept the file during upload.

The device and browser determine how camera capture is offered. Don't assume that camera: true selects a particular camera or guarantees that existing files cannot be selected.

Additional Information

Related Topics

General Notices