...
This page provides a high-level overview of how to create and manage Mobile Workers
| Table of Contents |
|---|
Setting Up Your Mobile Worker Roles & Permissions
For an overview about Mobile Worker Roles and Permissions, please visit Roles and Permissions Overview
Create a CommCare Mobile Worker
To manage mobile workers, click on Users in the top navigation bar. You will automatically be taken to the Mobile Workers section.
| Table of Contents |
|---|
Create a CommCare Mobile Worker
1. Navigate to the Mobile Workers page on your CommCareHQ project space.
CommCareHQ > Users > Mobile Workers (the page to manage Mobile Workers will show by default)
...
2. Click on
...
Create Mobile Worker
...
3. In the Window that pops up, add a username and password, and click
...
Create
...
.
...
After clicking
...
Create
...
, your new mobile worker
...
is created; it is NOT necessary to add any additional information unless you choose to.
The username and password you set here will be what the CommCare mobile worker uses to log into the phone
...
application.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Note: All usernames must be in the Roman alphabet, and once created, the username can NOT be changed! ( |
...
For more information on usernames, see choosing a username section below) |
...
a. If you have Custom User Data or Locations that are required, you
...
also have to add that information
...
.
...
| Panel | ||||
|---|---|---|---|---|
| ||||
We recommend you consider carefully what types of usernames you want to use. Here are some different approaches:
|
...
|
...
|
...
|
...
|
...
|
...
Best practices for Mobile Worker Usernames:
|
...
|
...
|
...
You may not use special characters apart from periods '.' as mentioned above
...
Best practices for Mobile Worker Passwords:
- Avoid setting the Mobile Worker’s passwords the same as the Admin password. Technical staff associated with your project will have access to the Admin password and may log in in Admin mode for installation and troubleshooting. The default Admin password is 234. (Note that the Admin password is configurable).
- We recommend keeping passwords simple so Mobile Workers do not forget the password and thus face a barrier in using the application.
Edit a CommCare Mobile Worker
User Information
You can change the First/Last names, E-mail, default language, and role. In general, it is only useful to add the First and Last names as you can see these names in reports, in addition to the username.
It is NOT possible to change the username.
It is possible to add additional information about your users with Custom User Data, an advanced feature. Additional user information you may want to consider are listed below:
- Mobile Phone IMEI number and Device Model for an inventory of the devices handed out to Mobile Workers
- Mobile Worker demographic information such as education, age, literacy for training purposes.
The default language and role are only relevant for mobile workers that are using Web Apps or working on CommCare HQ.
Phone Number
Make sure to add the international country code, without any symbols (do NOT add + or 00). After adding a new number, you will be prompted to verify it. This will send you an SMS to which you must reply.
Change or Reset the password for a mobile worker
On CommCare HQ, you can change or reset the password for any mobile worker by navigating to the "Password" tab and specifying the new password. However, it is important to note that the user login information (username and password) is stored locally on the phone. So, when you change in CommCare HQ, the username and password aren't communicated downward to the phone until the phone "synchronizes with server".
On CommCare, ''Sync with server" is an option on the home page of the phone. So, the CommCare mobile worker must synchronize with the server for the username and/or password change to reflect on the phone side.
...
| Info | ||
|---|---|---|
| ||
This feature (Bulk User Management) is only available to CommCare users with a Standard Plan or higher. For more details, see the CommCare Software Plan page. |
...
- The first tab contains a row for each mobile worker with the following data:
- Basic columns: username, password, name, phone number, email, user_id, language, role, is_active
- Read-only columns: IMEI, date registered, date of last sync, date of last form submission
- Any custom user data fields configured for your project
- User location code, if your project uses organizations
- The second tab contains a row for each group, with its id, name, and whether it is a case sharing group and/or reporting group.
...
| borderColor | black |
|---|---|
| borderStyle | solid |
| title | Bulk Upload Tips and Advanced Info |
Sample bulk users excel template
...
***user_id will be blank if this is a new mobile worker
Tips
- Your first column in excel should say "username", with no spaces. Note that username is required.
- Your second column in excel should say "language". Use the language codes in CommCare, (ex. English = en, French = fra)
- Name and phone number are optional (but recommended!) fields.
- For any new users, the password is required. For existing users that are in the download, the password will be listed as a *********. When uploading the file again, the password for these existing users will not be changed.
- Remember to add the international country code to the phone numbers.
- Add a space between the first and last name of your CommCare user. Do not need to use periods or other punctuation to separate.
- Any additional data can be stored by user by adding columns with 'data: xxxx' in the first row of the column. For instance, village, block, etc can be added, and will be stored. For more information, see Custom User Data
Mobile workers can be assigned a phone number or multiple phone numbers during bulk upload. To do this, add one or more columns with ‘phone-number xxxx’ in the first row of the column, where ‘xxxx’ is a sequential number (not the phone number). For example, if a user has more than one phone number, this can be sequential numbering, such as “phone-number 1”, then “phone-number 2” and so on. For a user with only one phone number in the “phone-number 1” column, that phone number will automatically be marked as ‘primary’ in CommCare. For a user with several phone numbers, the phone number in the “phone-number 1” column will be marked as ‘primary.’ Inversely, if at least one mobile worker has more than one phone number in CommCare, downloading the user.xlsx file as explained above will generate a file that contains N “phone-number” columns, N being the maximum number of phone numbers that a mobile worker has.
- A web user is able to update or delete an existing phone number via bulk upload. To update an existing phone number, the web user needs to edit the phone number in the appropriate cell, save the excel file and upload it. To delete a phone number, the web user simply needs to delete the number in the appropriate cell (leave the cell blank), save the excel file and upload it.
If you neither want to delete nor update the phone numbers for any mobile worker, you can simply remove any "phone-number" columns from the upload. This will cause the phone numbers associated with the mobile workers to remain unchanged.
- Users can be pre-assigned to groups during bulk upload. To do this, any column needs to have the syntax 'group (xxxx)' in the first row of the column. (Note that the 'xxxx' is any identifier, and is not the group name. To keep things simple, this can be sequential numbering, such as "group 1" then "group 2" and so on.) Any user can be a member of multiple groups of different types by simply adding columns with the correct group syntax. For groups, make sure you define the group on the 'groups' tab of the spreadsheet, and indicate which type of group it is. For more detail see Mobile Worker Groups.
- For groups, make sure you define the group on the 'groups' tab of the spreadsheet, and indicate which type of group it is: There are two types of groups: 1) Reporting groups - these groups users to view by group in the Filters on the Reporting section of HQ. For example, you can group all mobile users within one Village or SubCenter. 2) Case sharing groups - these groups allow cases to be shared by different users. For instance, if two mobile users were sharing the same catchment area, case information could be shared between these two users.
Search for Mobile Workers
You can use the search box to find specific mobile workers. Type in any word to search for that term across all columns, or use the syntax below to search in a specific column.
Names
Insert the first name or the last name of the mobile worker that you are searching for.
Dates
You can search by the dates date_joined, last_login, e.g.
date_joined:[2011-01-01 TO 2012-01-01]last_login:[2013-01-01 TO *]date_joined:[2011-01-01 TO *] AND last_login:[2013-01-01 TO *]Searching across multiple columns
Searches can be chained using AND and OR, e.g. but AND and OR must be capitalized.
first_name:parker AND last_login:[2012-01-01 TO *]Partial Searches
"*" can be appended to the end of search terms to perform partial searches, e.g.
if searching for mobile worker with a name that begins with "chris" then type chris*
...
Best practices for Mobile Worker Passwords:
|
Edit a CommCare Mobile Worker
User Information
You can change the First/Last names, E-mail, default language, and role. In general, it is only useful to add the First and Last names, as you can see these names in reports, in addition to the username.
It is NOT possible to change the username.
It is possible to add additional information about your mobile workers with Custom User Data, an advanced feature. Additional user information you may want to consider is listed below:
Mobile Phone IMEI number and Device Model for an inventory of the devices handed out to Mobile Workers
Mobile Worker demographic information such as education, age, and literacy for training purposes.
For a mobile worker to be able to use CommCare on an Andriod device, their Mobile Worker Role must allow mobile endpoint access. (See Roles and Permissions Overview)
Phone Number
Make sure to add the international country code without any symbols (do NOT add + or 00). After adding a new number, you will be prompted to verify it. This will send you an SMS to which you must reply.
...
Change or Reset the password for a mobile worker
On CommCare HQ, you can change or reset the password for any mobile worker by navigating to the Password tab and specifying the new password. However, it is important to note that the user login information (username and password) is stored locally on the phone. So, when you change in CommCare HQ, the username and password aren't communicated downward to the phone until the phone synchronizes with server.
On CommCare, Sync with server is an option on the home page of the phone. So, the CommCare mobile worker must synchronize with the server for the username and/or password change to reflect on the phone side.
Use Bulk Upload to create multiple mobile workers at once
| Multiexcerpt include macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
1. Navigate to the Mobile Workers page on your CommCareHQ project space, as above.
CommCareHQ > Users > Mobile Workers (the page to manage Mobile Workers will show by default)
2. Click on Download Mobile Workers.
...
3. You can filter and download mobile workers.
Filter by:
a. Role
b. Name or Username
c. Location
d. Active/Deactivated
e. Columns
...
4. Click Download to download the user.xlsx file. You can see how many mobile workers and how many groups you are downloading.
This file contains all of your current user data:
a.The first tab contains a row for each mobile worker with the following data:
i.Basic columns: username, password, name, phone number, email, user_id, language, role, is_active
ii. Read-only columns: IMEI, date registered, date of last sync, date of last form submission
iii. Any custom user data fields configured for your project
iv. User location code, if your project uses organizations
b. The second tab contains a row for each group, with its id, name, and whether it is a case sharing group and/or reporting group.
5. Use the downloaded file as a template and populate it with the necessary data. Save the completed file.
6. Click on Bulk Upload.
...
7. Click the Upload mobile workers button to upload the completed file.
...
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Sample bulk users excel template
***user_id will be blank if this is a new mobile worker Tips
Advanced
|
Search for Mobile Workers
You can use the search box to find specific mobile workers. Type in any word to search for that term across all columns or use the syntax below to search in a specific column.
Names
Insert the first name or the last name of the mobile worker that you are searching for.
Deactivate and Delete Mobile Workers
You can unclutter your reports in two different ways. You may either deactivate (formerly "Archive")a user, removing them from the limelight while keeping their data around in the export; , or you can can delete a user removing all their data permanently.
Deactivate
...
mobile workers
This will remove users mobile workers from the report dashboards while keeping their data in the export. Deactivate a user by clicking the "deactivate " button on the main Mobile Workers page. Deactivated users mobile workers will no longer be able to log into a new phone for the first time. (Note that you can deactivate a large number of mobile workers by following the "Bulk deactivation" process below).
If a deactivated user submits a form, the following will occur:
If your app is using secure submissions, deactivated
usersmobile workers' new submissions will be rejected and will stay on the phone
If your app is not using secure submissions, then it behaves like any other submission, and all case transactions are processed.
Note: Secure Submissions are enabled for your project by default. For more information, please see
this help page
Activate Deactivated
...
mobile workers
If you have deactivated usersmobile workers, you can click on the Show Deactivated Usersmobile workers link to display them on the screen. Click on reactivate to start displaying this user's data in the reports once again.
Note: Deactivate mobile worker was formerly called Archive mobile worker. When looking for information in the Commcare User's Forum relevant , relevant discussions may sometimes be described as "archive".
Bulk Deactivation of Mobile workers
If you need to deactivate a large number of mobile workers, follow those steps. Please note that this feature requires a paid software plan.
- Go to the User page, click "Bulk upload", click on "download Mobile workers", get to the downloaded excel spreadsheet
- For the workers you want to deactivate, go to the column "is active" and change the value to false.
- Save the Excel file. Re-upload the excel file.
Delete users
| Warning | ||
|---|---|---|
| ||
You may notice that we make it a bit difficult to delete mobile workers. This is because if you delete a mobile worker you will also be deleting all data that that worker ever submitted. It is not possible to ever get that information back if you delete a mobile worker. We very very strongly recommend deactivating mobile workers if there is any chance you will ever want to see any of the data submitted by that worker. Note: once you delete a mobile worker you can never create a new worker with that username. |
This will remove all of the user’s data permanently. Delete a user by clicking on a user's name and navigating to "Permanent Actions". Then press the "Delete Mobile Worker" button and follow the directions.
Things to keep in mind before deleting users
...
Other Important Information
Admin Users (J2ME ONLY)
You can set your own admin password in the 'Applications' tab. The default password is 234.
Follow these steps to customize the password for admin users:
2. Look for 'Admin password.'
feature requires a paid software plan.
Go to the User page, click Bulk upload, click on download Mobile workers, get to the downloaded excel spreadsheet.
For the workers, you want to deactivate, go to the column "is active" and change the value to false.
Save the Excel file. Re-upload the excel file.
Delete mobile workers
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Deleting mobile workers: Are you sure you want to do that?You may notice that we make it a bit difficult to delete mobile workers. This is because if you delete a mobile worker, you will also be deleting all data that the worker ever submitted. It is not possible to ever get that information back if you delete a mobile worker. We strongly recommend deactivating mobile workers if there is any chance you will ever want to see any of the data submitted by that worker. Note: once you delete a mobile worker, you can never create a new worker with that username. |
This will remove all of the user’s data permanently. Delete a user by clicking on a user's name and navigating to Permanent Actions. Then click the Delete Mobile Worker button and follow the directions.
Things to keep in mind before deleting mobile workers
Let's say that while you were testing your app, you created a mobile worker called "test". You might play around with the user and submit a few forms, but none of that data is real, so it shouldn't interfere with the real data, and you will never need to use this data again. In this case, you may want to delete the user and all their data.
Let's say instead that you have a mobile worker who has submitted some data but who has taken a leave of absence. You do not want them showing up in your reports day-to-day, but you want to keep their data around. Then you would deactivate them.
You can also watch this video for more information:
...