Smartform Elements


Intro

The following is an overview of the template elements that can be used in smartform templates created and managed in the Smartforms and Feedback app.


Template Elements

There are several elements that can be used when designing templates. Each element has properties that can be configured to create a specific look and feel of the smartform template form.


Checkbox

Use checkboxes for fields where you want the user to enter Yes/No type answers.

Structure: Checkbox elements consist of title, Boolean (Yes/No) and required features.

Basic Settings



Field Description
Title The tile of the checkbox element. This will display above the field.
ID The ID of the checkbox element. This ID is used in the XML template that can be generated for translation.
Default Value  
None Radio button. If selected, None will be the default checkbox selection.
Checked Radio button. If selected, Checked will be the default checkbox selection.
Unchecked Radio button. If selected, Unchecked will be the default checkbox selection.
Required Checkbox. By selecting, the text input field will be required.

Text Input

Use text input elements for fields where you want the user to fill in free text, e.g. measured voltage of a machine.

Structure: Text input elements consist of title, predefined text, dynamically prefilled property, required and multiline features.

Basic Settings



Field Description
Title The tile of the text input field. This will display above the field.
ID The ID of the text input field. This ID is used in the XML template that can be generated for translation.
Predefined Text If applicable, the value taken from a predefined source (example: ServiceCall.OriginCode). Valid values can also be selected by from the list of values denoted by the horizontal ellipsis ....
It is not only possible to select predefined objects as “Reference Object”, but also as any object picker you defined in the template:
1. Select horizontal ellipsis ... as for the other predefined texts.
2. From the object list, select the picker.
3. Select the property you want to see populated in this text-input.
Result:
Now when one makes a selection in the referenced picker, the attribute value of the selected object will be populated to the text-input.
Multinline Checkbox. By selecting, the text input field will break into multiple lines.
Required Checkbox. By selecting, the text input field will be required.

Allow Barcode Scanner

In the Text Input element, users can also enable barcode scanning. This setting in the Text Input element settings is called Allow barcode scanner. When enabled, this field will trigger a barcode scanner in the SAP Field Service Management mobile application.




Number Input

Use number inputs for fields where you want the user to fill in numbers only (using letters will not be possible).

Structure: Number input elements consist of title, predefined number, required, minimum and maximum decimals, minimum and maximum value features.

Basic Settings



Field Description
Title The tile of the number input field. This will display above the field.
ID The ID of the number input field. This ID is used in the XML template that can be generated for translation.
Predefined Number If applicable, the value taken from a predfined source (example: creditLimitNumber). Valid values can also be selected by from the list of values denoted by the horizontal ellipsis ... .
Decimal Min. The minimum displayed decimal places for a number. For example, when decimal minimum = 2 is entered, when the user inputs 2.1 the number will displayed as 2.10.
Decimal Max. The maximum displayed decimal places for a number. For example, when decimal maximum = 4 is entered, when the user inputs 2.22228 then the number will be rounded up to the 4th decimal, as in 2.2223
Value Min. The minimum number value. Note: negative integers are valid.
Value Max. The maximum number value. Note: negative integers are valid.
Allow Out of Range Values Checkbox. By selecting, out of range values will be considered valid.
Required Checkbox. By selecting, the number input field will be required.

Use drop-down elements for fields where you want the user to choose one from several given options.

Structure: Drop-down elements consist of title, options, add option, default option and required features.

Basic Settings



Field Description
Title The tile of the drop-down field. This will display above the field.
ID The ID of the drop-down field. This ID is used in the XML template that can be generated for translation.
Options Text entry. Enter the values to include in the drop-down list of values. Upon entering a value, the application will display the option of another list of value entry.
Default Value Select the default value that will be selected from the list of values.
Required Checkbox. By selecting, the drop-down field will be required.

Status

Status elements are used for fields where you want the user to indicate the status of a machine he is servicing.

Status elements are similar to drop-down lists: the user can also choose one of several given options. Unlike with drop-down lists though, the user can then add a comment (e.g. about spare parts used or spare parts needed to fix the machine).

Structure: Status elements consist of title, options (these cannot be changed/translated), default option and required features.

Attention: Spare parts in the status element only display items of type sales item.

Basic Settings



Field Description
Title The tile of the status field. This will display above the field.
ID The ID of the status field. This ID is used in the XML template that can be generated for translation.
Default Option The default status option.
Required Checkbox. By selecting, the status field will be required.

Date/Time

Use Date/Time elements for fields where you want the user to indicate a date and/or time.

Structure:Date/time elements consist of title, type (date/time, date and time), predefined value, dynamically prefilled property and required fields. The dynamically prefilled property is available only if the type is date/time or date, and the only option available is Service call DueDateTime.

Basic Settings



Field Description
Title The tile of the date/time field. This will display above the field.
ID The ID of the date/time field. This ID is used in the XML template that can be generated for translation.
Date/Time Radio button. By selecting, the date/time entry field will display fields for both the date and time.
Date Radio button. By selecting, the field will be date only.
Time Radio button. By selecting, the field will be time only.
Predefined Value If applicable, the date/time value taken from a predfined source (example: DueDateTime). Valid values can also be selected by from the list of values denoted by the horizontal ellipsis ... .
Required Checkbox. By selecting, the date/time field will be required.

Picker

Use picker elements for fields where you want the user to select an object from a list.

Structure: Picker elements act like pop-up windows where the user can select an ERP object from a list. Available objects to select are: Business partner, Person, Contact, Address and Item.

Basic Settings



Setting Description
Title The tile of the picker field. This will display above the field.
[Business Object Type] List of values with supported business object types (example: business partner, person, contact, address, item).
Filter By The filter to be used on the applicable business object type. For example, if Person is selected, Employees could then be selected as the filter, meaning that only employees would be displayed in the picker.
Required By selecting this checkbox, the picker element will be required.
Record can only be selected once By selecting this checkbox, the user will be limited to selecting one record per smartform instance. This also means that the list of available records decreases as records have been selected, as the application will only display records that have not been picked before.

Linking Pickers

Two picker elements can be linked together, so that selecting one value of one picker limits the available values of the second picker.

Example Scenario Action
When an address picker is linked to a business partner picker, only the addresses linked to the previously chosen business partner are displayed. Also, if creation is allowed, the address is created for the given business partner. In the template, you can specify for each picker the linked picker id and the property used to fill the possible values of current picker. To link two pickers select a picker and drag it into the design main area [Object type: Business Partner picker]. Select a second picker and drag it into the design main area, under the previous pickers [Object type: Address picker]. Click on the … button. A pop-up window opens. Select the appropriate filter from the drop-down list. In this case it will be Addresses of Business partner.
Linked Pickers. A service call technician is required to fill in a smartform field where he needs to select the customer of the service call. On the Field Service Mobile app he presses Select on the Business Partner. A list of business partners appears (since the designer has chosen the object picker type to be business partner)The technician then selects a business partner. The pop-up closes and the name of the business partner that has been chosen.

Custom Objects in Pickers

Note: Custom objects in pickers is currently available in PREVIEW.

It is now possible to define picker objects for custom objects. This helps extending specific workflows with objects not existing in the FSM standard data model.



  • Object Type: Users can now also select custom objects for the object type.
  • Display Value: Value which is displayed in mobile apps when opening the picker.
  • Filter By: You can filter by any other object picked in any other picker available in the template.
    • Precondition: your custom object has a field holding the ID of the object of the picker you want to filter by.
  • Reference Field: Define the field which is holding the ID of the object of the picker you want to filter by.

Attachments

Attachment elements can be used to provide images for the users that fill-in the smartform instance.

Structure:Image elements allow the user to attach a picture, which will be visible to the technician. Allowed file types: PNG, JPEG, GIF, BMP, PDF, DOC, DOCX, ZIP, PPTX, XLS, XLSX, MP4.

Basic Settings



Field Description
Title The tile of the attachment element. This will display above the field.
ID The ID of the attachment element. This ID is used in the XML template that can be generated for translation.
Choose File File selector. Select the image file to be included in the attachment element.

Attachment Picker

The Attachment Picker element is a prompt to upload image or video attachments from the mobile application.

Structure:With the attachment picker element, technicans can upload one or more image or video attachments.

Basic Settings



Field Description
Title The tile of the attachment picker element. This will display above the field.
ID The ID of the attachment picker element. This ID is used in the XML template that can be generated for translation.
Image Radio button. By selecting, only image formats will be valid.
Video Radio button. By selecting, only video formats will be valid.
Any Radio button. By selecting, both video and image formats will be valid..
Allow Multiple Attachments By selecting, users will be able to select multiple image and/or video files using the attachment picker element.
Required Checkbox. By selecting, the attachment picker element will be required.

Safety Label

The safety label element is used to provide hazard indicators to a smartform, including signal words, hazard symbols, safety symbols, and messages.

General Settings



Field Description
Title The title of the safety label element. Example: “Opening the engine cover”.
ID The ID of the safety label smartform element. This ID is automatically incremented when the Always increment clipboard element IDs with default naming setting is enabled.
Preview In this section, the application will provide a preview of the safety label, including the left and right symbols, signal word, and the indicator message.
Symbol Left The hazard indicator symbol located on the left of the safety label.
Signal Word Required. The signal word associated with the safety label.
Symbol Right The hazard mitigation symbol associated with the safety label. In the example above, the safety gloves symbol has been selected.
Message Required. The message contained in the safety label, such as hazard mitigation instructions or other information.

Series

Structure: Series elements consist of the title, the description, the series instance description and the content. Inside the series element content, all types of elements can be added, except for another series element.

Example: a technician has to go to a company and check all fire extinguishers in that company. For each fire protector that he checks, he has to fill in the same type of data: * Weight of the fire extinguisher *, * Last Inspection Date * etc.

For multiple checks performed on the same type of equipment, the template designer can use a series element. Then he adds other elements (checkboxes/textinputs/etc.) to the series. So the series element is similar to a chapter. The only difference is that, unlike a chapter, a series cannot contain other series elements or chapters. Moreover, the series element on mobile client side can be multiplied as many times as there is equipment to check.



Basic Settings



Field Description
Title The title of the series element. This will display above the field.
ID The ID of the series element. This ID is used in the XML template that can be generated for translation.
Description The description of the series element.
Series Instance Description The description of the series instance.

Worth to remember:

  • It’s possible to add elements to a series only by dragging and dropping from elements list.
  • It’s not possible to drag and drop an element to a series from outside. For example, text input that is already part of a chapter or a different series cannot be dragged and dropped to a series.
  • It’s not possible to drag elements that are part of a series outside of it. For example, it’s not possible to drag text input from a series to a chapter.
  • It’s possible to set visibility conditions only within a series element.
  • It’s not possible to target an element that is part of a series with visibility conditions by an element that is outside of the series.
  • It’s not possible to target an element that is not part of a series from element that is within the series.
  • It’s only possible for an element within a series to have visibility conditions targeting other element of the same series.



Dynamic Description

The clients that allow filling in smartform series elements are required to display the title, description and if filled in designer - dynamic description for each instance of the series.

The series instance description is the string that will be shown as title for each series instance. It can be specified by the template designer as a dynamic string containing placeholders where various elements’ values from inside the series are placed. The placeholders contain information about the element ID whose value will be displayed.



Supported Elements

  • Text Input
  • Label
  • Table
  • Dropdown
  • Signature
  • Date Input
  • Number Input
  • Attachment
  • Attachment Picker
  • Calculation
  • Checkbox
  • Picker
  • Status
  • Page Break
  • Safety Label

Note: Curly brackets {} are used when defining variables.


Label

Use labels to provide a technician with inspection instructions, warnings, etc. A label represents static text that a user will see when he fills in the smartform instance.

Structure:Label elements consist of title, style and dynamically prefilled property features.

Basic Settings



Field Description
Title The tile of the label element.
ID The ID of the label element. This ID is used in the XML template that can be generated for translation.
Style Drop-down. Select the style to apply to the label element. Options include: none, bold, and title.

Calculation

Attention: calculations can only refer to elements in the same chapter and/or series.The Element IDs must be for Number Inputs that are at the same level as the Calculation Element. Being at the same level means:

  • Being in exactly the same chapter or series
  • Calculation elements inside a series or chapter can only refer to number input elements from inside the same series or same chapter
  • calculation element outside of any series can not refers to a number input element from inside any series

Intro

A calculation element can be used in places where an arithmetic calculation is needed that is based on the values entered by the user in other fields contained in the smartform.

Structure:Calculation elements consist of title, calculation, minimum value, maximum value, an internal checkbox and a dynamically prefilled ID. In the Calculation field, you can automate calculations.

Example: You have added two number input elements to your smartform. They have the IDs Number1 and Number2. You want to add up these two numbers and multiply the result with the factor 0.5. To do so, enter “(Number1 + Number2) * 0.5” in the Calculation field.


Supported Mathematical Functions

The following Mathematical functions are supported to be defined for certain or a range of number element(s) outside or inside a table.

  • AVG (average)
  • SUM
  • POWER
  • ROUND
  • ROUNDUP
  • ROUNDDOWN
Attention If there is a calculation that uses a table reference to an entire row or column, then only the cells that are numeric will be used in the calculation.
Scenario Sample
It is possible to define a calculation element to be the power of number element(s) or a calculation of several number elements.
The POWER function requires two arguments:
  1. The base number. This can be a formula consisting of numbers or IDs of number input elements from the same smartform or a mix of both.
  2. The exponent to which the base number is raised.


Note:Square roots can be calculated by setting a power function with 0.5 in the exponent.
Number1 = 7
Calculation: POWER(Number1;2)
Result: 49

Number2 = 9
Calculation: POWER(Number2;0.5)
Result: 3
It is possible to define a calculation element to be a rounded result of a calculation.

The ROUND / ROUNDUP / ROUNDDOWN