Checklist Elements

Source: This article refers to Checklist Elements

Intro

The following is an overview of the template elements that can be used in checklist templates created and managed in the Knowledge Management 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 checklist 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 predfined source (example: ServiceCall.OriginCode). Valid values can also be selected by from the list of values denoted by the horizontal ellipsis ....
Multinline Checkbox. By selecting, the text input field will break into multiple lines.
Required Checkbox. By selecting, the text input field will be required.

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 checklist 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 checklist 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 checklist 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.

Attachments

Attachment elements can be used to provide images for the users that complete the checklist.

Structure:Image elements allow the user to attach a picture, which will be visible to the technician. Allowed files types: PNG and JPEG.

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.

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. Besides the elements which form the content of the series element a series element has a title and a description (e.g. Title: “Please describe broken elements”; Description: “Make particularly sure that the flux capacitor is getting the needed 1.21 gigawatt”).

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 * Trigger status of the fire extinguisher (Good/Bad) * etc.

For this, the template designer adds a series element. Then he adds other elements to the series (checkboxes/textinputs/etc.). 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.

The clients that allow filling in checklists series elements are required to display the title, description and, after filling, for each instance of the series, the series instance description (see below).

Dynamic Description

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

  • Checkbox
  • Text Input
  • Number Input
  • Dropdown
  • Date Input
  • Object Picker
  • Status
  • Calculation

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

Basic Settings



Field Description
Title The tile 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.
Series Elements Add one or more supported series elements in the series.
Note: Please refer to the applicable checklist element section for more information.

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 checklist 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 arithitmetic calculation is needed that is based on the values entered by the user in other fields contained in the checklist.

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 checklist. 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.

Rounding Function

There are three rounding functions you can use on the calculation element:

ROUND: The ROUND function requires two arguments:

  • The first argument is the number to be rounded. This can be a formula consisting of numbers or IDs of number input elements from the same checklist or a mix of both.
  • The second argument is the number of decimal places to which you want to round the result.

Example: ROUND(Number1+Number2, 3)

ROUNDUP:The ROUNDUP function requires two arguments:

  • The first argument is the number to be rounded. This can be a formula consisting of numbers or IDs of number input elements from the same checklist or a mix of both.
  • The second argument is the number of decimal places to which you want to round the result.

Example: ROUNDUP((Number1*Number2) * 0.5, 2)

ROUNDDOWN:The ROUNDDOWN function requires two arguments:

  • The first argument is the number to be rounded. This can be a formula consisting of numbers or IDs of number input elements from the same checklist or a mix of both.
  • The second argument is the number of decimal places to which you want to round the result.
  • Example: ROUNDDOWN(Number1/Number2, 3)

As a general rule, when you round a number that has no fractional part (a whole number), you subtract the length from the number of significant digits to which you want to round.

Example: To round 2345678 down to 3 significant digits, you use the ROUNDDOWN function with the parameter -4, as follows: = ROUNDDOWN(2345678,-4). This rounds the number down to 2340000, with the “234” portion as the significant digits.

Note: For information on calculations in table elements, refer to the table section.


Calculation Element in template.xml File

The calculation element is serialized in the template.xml file as follows:

<div>
   <span class="kw">&lt;calculation</span>
   <span class="ot">elementID=</span>
   <span class="st">"Calculation1"</span>
   <span class="ot">title=</span>
   <span class="st">"@localized\ expression="</span>
   <span class="er">(Number1</span>
   <span class="er">*</span>
   <span class="ot">Number2</span>
   <span class="er">)</span>
   <span class="er">+</span>
   <span class="er">5"</span>
   <span class="er">internal</span>
   <span class="ot">=</span>
   <span class="st">"false"</span>
   <span class="ot">rangeType=</span>
   <span class="st">"NumericInterval"</span>
   <span class="ot">range=</span>
   <span class="st">"[-9999.9999, 9999.9999]"</span>
   <span class="kw">/&gt;</span>
</div>

The expression attribute holds the calculation formula. The checklist designer can specify an expected range for the result of the calculation expression. Currently, calculation expressions can only have a real value as a result and support expected ranges in the form of a real number interval. So the rangeType attribute can only be NumericInterval for the moment.


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
  • AVEDEV (average deviation)
  • STDEVA (standard deviation)
  • MIN (minimum)
  • MAX (maximum)
Scenario Sample
It is possible to define a calculation element to be the square root of number element(s) or a calculation of several number elements. SQRT((D6+E6)/F6)
It is possible to define a calculation element to be the result of a conditional function of number or text input or lable element(s) or a calculation of several number elements. IF(D8<E8;F8;G8) where F8 and G8 could be also a text input or lable element IF(D10<E10;(D10-E10)/D10;(E10-D10)/E10)
It is possible to define a calculation element to be the absolute value of number element(s) or a calculation of several number elements. ABS(D11)

Basic Settings



Field Description
Title The tile of the calculation element. This title will display above the element in the checklist.
ID The ID of the calculation element. This ID is used in the XML template that can be generated for translation.
Calculation List of values. Select the checklist element contained in the current checklist instance on which the caluclation will be performed.
Value Min. Number entry. The minimum value of the calculation.
Value Max. Number entry. The maxium value of the calculation.

Sample Checklist with Calculation Functions

The following template is an example of calulation functions in a checklist template. This template can be used to see how these functions are constructed.

You can then drag and drop this .zip into the Import Templates section located bottom-right on the Checklist Templates view.


Table

The table element is used to create a table with several columns and rows.

Structure:Table elements consist of a column Header and a column element:

  • The column header, in turn, consists of a title and a dynamically filled ID.
  • The column element, in turn, consists of a column type, a title, a predefined text, a required, multi-line and internal checkbox and a dynamically pre-filled ID.

In the Column element you can select one of the following column types:

  • Check box
  • Text input
  • Number input
  • Drop-down
  • Status
  • Date/Time
  • Picker
  • Attachment picker
  • Signature
  • Label
  • Calculation
  • Attachment
  • Row description

Table Column and Row Description Colors

When creating a table element in Template Designer, you can highlight specific columns or rows by changing the font and/or background color of table column headers and row descriptions. These column header and row description colors are managed in the Row Settings tab.



These colors are displayed in the iOS and Android Field Service Mobile Applications and helps to visually highlight specific rows or columns and aid in filling in checklists:




Calculation Column Element

If you select the Calculation type for your column, you can perform calculations on table rows/columns. In the example below, Columns 1 and 2 are of the Number input type. Column 3 is of the Drop-down type and Column 4 (“Total”) is of the Calculation type. Since the Total column is of the Calculation type, I can now perform calculations there.

Available Operators

The following operators are allowed in calculations:

  • +, -, *, /, round, roundUp, roundDown, sum, avg.
  • round, roundUp and roundDown work as described in Rounding functions.
  • sum sums up all values in a column.
  • avg calculates the arithmetic mean of a column.

Example Our table ID is Table1. Our table consists of four columns. In the Total column, you want to show the result of the calculation of Column 1 and Column 2. To calculate this, enter the following in the Calculation field: “table.col[0] * table.col[1]”

Keep in mind that in order to refer to the first column, you must enter col[0]. To refer to the second column, you must enter col[1], etc.

Row Description Column Element

If you select the Row Description type for your column, you can define a fix text per row. Please note that the Row description column element can only be selected when the table has a fix number of rows defined (i.e. if the minimum number of rows equals the maximum number of rows). Once you have used the Row description column element in one of the table columns, you can no longer edit the minimum and maximum number of rows individually. Instead, you can only edit the total number of row.

Table References

Expression of the calculation element can refer to table’s columns, rows or a single cells. Example below shows how could we sum up or average values used in one row/column and use single cell’s values as arguments. Calculation element could be used inside a table element footer (see details here) - but it’s not limited to.

Example

<calculation elementID=“calc1” exp=“table1.col[0].row[0] + sum(table1.col[0]) + sum(table1.row[0]) + element1” ... colIndex="2" />
    <calculation elementID=“calc1” exp=“table1.col[0].row[0] + avg(table1.col[0]) + avg(table1.row[0]) + element1” ... colIndex="2" />

The following table references are possible:

Reference Description
Refer to an Entire Column Example: sum(table1.col[0]) will sum all values in the the first column.
Refer to an Entire Row Example: avg(table1.row[0]) will compute the simple average of the first row of the table.
Refer to a Single Cell Example: table1.col[0].row[0] + table1.col[0].row[currentRowIndex]

For this example we assume that the above expression is used in a calculation element that is placed in one of the table columns (but not in footer).

  • table1.col[0].row[0] refers the top-left table cell.table1.col[0].row[currentRowIndex] will be replaced with the index of the row on which the calculation element appears, for each row of the table.
  • The calculation element value of the first row will be: table1.col[0].row[0] + table1.col[0].row[0]
  • The calculation element value of the second row will be: table1.col[0].row[0] + table1.col[0].row[1] and so on.

And the following are examples of calculations using table references:

Sample Description
Specific 3 cells in a table FUNCTION(table1.col[1].row[0];Table1.col[2].row[0];Table1.col[3].row[0])
Specific 3 cells standard elements (outside of table) FUNCTION(Calculation1;Number20;Number34)
Range of cells (first row and second to fifth column) in a table FUNCTION(table1.col[1].row[0]:Table1.col[4].row[0])
Range of cells (second column and third to seventh column) in a table FUNCTION(table1.col[1].row[2]:Table1.col[1].row[6])
All columns of the first row in a table FUNCTION(table1.row[0])
All rows of the second column in a table FUNCTION(table1.column[1])

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
  • AVEDEV (average deviation)
  • STDEVA (standard deviation)
  • MIN (minimum)
  • MAX (maximum)

It is possible to define a calculation element to be the square root of number element(s) or a calculation of several number elements.

Sample: SQRT((D6+E6)/F6)

It is possible to define a calculation element to be the result of a conditional function of number or text input or lable element(s) or a calculation of several number elements.

Sample: IF(D8<E8;F8;G8) where F8 and G8 could be also a text input or lable element IF(D10<E10;(D10-E10)/D10;(E10-D10)/E10)

It is possible to define a calculation element to be the absolute value of number element(s) or a calculation of several number elements.

Sample: ABS(D11)


Table Restrictions

  • It is not allowed to use currentRowIndex in table operations that reference entire rows or columns. E.g. sum(table1.row[currentRowIndex])
  • It is not allowed to use currentRowIndex in table footer calculation elements.
  • It is not allowed to use id’s of numeric elements that are table column elements in calculations. Use the table reference syntax instead.

Basic Settings



Field Description
Title The tile of the table element. This title will display above the element in the checklist.
ID The ID of the table element. This ID is used in the XML template that can be generated for translation.
Number of Table Rows
Number Between (min-max) If selected, enter the mininum and maximum number of table rows that could be created for the table element.
Exactly If selected, enter the exact number of rows desired for the table element.
Column Name The name of the column.
Edit Footer By selecting, the application will display the Footer Details view and prompt you to select a supported element type. Refer to the relevant checklist section for more information.

Page Break

Use the page break element to create a page break in a custom checklist report.

This element is not visible when filling in checklists from the mobile apps (iOS, Android, Windows) and will only appear in the report generated for the checklist.


Advanced Settings

Advanced settings are used to add futher nuance and control to the element

Field Description
Internal For internal use only. By selecting, the element will not be included in the customer report that is generated from the checklist.
Read only By selecting, the element will be read only and can only be filled from a web service. It cannot be filled or edited manually.
Visibility Condition The element will only display when the conditions have been fulfilled. For more information refer to the Visibility Condition section.

Visibility Condition

For information on Visiblity Conditions, please refer to the following topic:

Visibility Condition

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.