Create a standard list
There are 4 standard list templates:
Using a predefined list makes it easier to build dashboards.
When creating a template list, the attributes labels will be in the same language as what you are currently using the web app in. So if you want the list attributes to appear in French, you need to select French as the language of the web app on the top language selection.
When creating a template list, you can’t delete a standard attribute, you can only hide it if you don’t want the mobile user to view it.
Create a custom list
You can as well start from scratch to define a list. Click on the + button to get started. Once a list is created, all the parameters can be edited using the edit icon.
Each list is defined by:
a list id (system generated)
Define the list scope
The scope parameter is used to determine who can view and perform the following actions on a list item:
The scope can take 5 options, each scope value restricts who can access the item:
Global - all users of the client
Multiple Teams - all users of the multiple teams to which the item has been assigned to
Single team - all users of the single team to which the item has been assigned to
Multiple Mobile users - all users to which the item has been assigned to
Single Mobile user - a unique user to which the team has been assigned to
This is a very important parameter to define, as it has an implication of the KPIs that can be calculated
A change of scope will remove all the existing ownerships. If you need to proceed to a change of scope, kindly download the list and re-assign the items accordingly.
Define access rights
Access rights for mobile or web users can either be:
Full access - users can add, edit and delete items on the list
Read-only - users can only view list items
Define item title
This is to determine how the item will appear on the mobile app. use a $ between each tag to define the titles.
Define the attributes of the list
Attributes of the list are the fields that will structure it. Each attribute has:
A key. A unique tag, lower case, all attached
A name that will be displayed on the mobile/web app
A type, among the following options:
Integer - Whole numbers
Decimal - Whole numbers with decimal points i.e products prices (cents)- 457.89
Text - Alphanumeric characters
Single choice - Select one choice from a range of options
Multiple choice - Select several choices from a range of options
For single and multiple-choice attributes, the different options can be uploaded in bulk using the bulk button. You then just need to upload a CSV file with two columns, the tag and the label of each option, saving you time.
You can also download the list of option tags and labels using the download icon
Picture - Take a picture inside the list
GPS - Capture GPS on the list
Boolean - A question with a binary result (Yes / No)
Date - Capture dates on the list
Signature - Capture signatures
Phone number - Capture phone number
Barcode scanner - scan a barcode
Single choice on list - attribute which picks from an existing list. Used mainly for single choice attributes with lots of options i.e Territories. Users can apply filters on it and can search for an option/item easily.
Attributes can be reordered with a drag and drop functionality, both on the web and mobile app
How to use the single choice on list attribute
Select on list attributes are created the same way other attributes are, except that for 'Select on the list' you have to create a different list first then attach it to the attribute. Before adding the attribute, please create a list on the same client.
Once you have created a list, go to the list that you wanted to add a 'select on list' attribute then click on the edit icon/pen. Once on the list edit page, click on the + icon to add a new attribute, input the attribute key (tag) and name then select 'single choice on list' as the attribute type and attach the list that you just created.
After, click on ADD then save the list.
How to use the multiple-choice attribute for route management
Use the multiple-choice attribute called "_route" in the default Place list
For each Place, assign it the routes it belongs to. Let's say a Place needs to be visited on Monday and Wednesday, you assign both values
You might need to add more fields:
If the list is in scope with more than one user, a single choice attribute so that the user selects his area
An open text field with the order in which the Place must be visited
Options for the attributes
Validation rule using the regex syntax. This rule defines or restricts what a user inputs/fill on the input questions (Input text, Integer, decimal, etc). Refer to this article for more details.
Validation error message if the syntax is not respected
SQL query defining the value of the attribute
How to use SQL query to set the values of an attribute
You can define an attribute in a list based on a SQL query. It is very useful as you can use the data from the workflow to define attributes in the lists.
For example, you can define customer status based on workflow activity. Customer status changes to active once the customer has made an order/sale done and their status changes to Inactive if they haven’t made any order for a long time.
Mandatory attribute - if the user has to fill it or not
If a place list is already created, and a new mandatory attribute is added, mobile users will be forced to fill it the next time they check in a place. A message saying “Update all fields” will be displayed, as below
Attribute to hide from mobile user - if the user does not need to see it
Unique value - Activating this option will ensure that there is only one value for this attribute in the list among all items. This can be useful if you want to ensure there is no duplicate, like for an outlet code serving as the primary key.
Value locked - Used to make list attributes read-only for the Mobile users. Often comes with an SQL - Query defined.
Conditions. Just like the workflow's conditions, it is possible to define conditions to list attributes, to ensure an attribute is displayed based on the value of another attribute. For example to ask additional information based on the Place type. To add a condition, simply click on the add icon located on the conditions tab.
You can define an attribute that is dependent on a condition to be displayed as mandatory, the mobile user will only be required to fill it if the condition is active
Define the important attributes
Important attributes are the ones that will appear in the item card on the mobile app. They are defined in the list schema in this section. Add new attributes by clicking on the + icon.
In the item card, only the important attributes will be displayed in the list. To view all attributes, click on more.
Search on the mobile app applies to all important attributes, so it is key that the ones used to find an item are added.
Understanding the list schema
By viewing the list of the attributes, we have put some visual indications to understand what parameters have been applied to the attribute:
Attribute in bold: the attribute is mandatory
eye icon: the attribute is hidden
chart icon: the attribute is a calculated attribute
*: the attribute has a condition attached to it
key icon: the attribute serves as a primary key, it has been defined as unique
Viewing the list schema
Even if a web user cannot edit a list schema, he can still view it by clicking on the More button.
Reorganizing the order of the attributes (list schema)
It is possible to drag and drop each attributes to change the order at which they appear on the mobile and web. Just click on an attribute and drop it where you want in the list compared to the other attributes.
Define the filter attributes
Attributes to be used as filters on the mobile application. Only these attributes can be added:
attribute based on a query
Picture field to be used for the item profile
Single choice attributes to be used as categories. This is useful for a matrix to navigate among items. Categories serve as headers.
Workflows linked to this list
This section will show you the workflows to which the list is attached.
If a list is not attached to a workflow, it won’t be accessible for mobile users.
Upload and download a list in JSON format
A list can be downloaded and uploaded in JSON format using the button at the bottom of the modal.
Archive a list
A list can be archived using the archive icon. Archived lists can be displayed using the “Display archived list” option in the menu.