Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

CommCare Mobile Workers are the accounts people will use to log in on their phones and submit data to your project space. CommCare mobile workers can also log in to CommCareHQ, but they can only see the same information they have access to on their phones. (Your application must be Web Apps-enabled for this to work. See Web Apps for more information).

...

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

    Info

    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)





    1. If you have Custom User Data or Locations that are required, you also have to add that 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 is listed below:

...

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)

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 users at once

...

  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:
    1. Role
    2. Name or Username
    3. Location
    4. Active/Deactivated
    5. Columns


  4. Click Download to download the user.xlsx file. You can see how many users and how many groups you are downloading.

    This file contains all of your current user data: 
    1. The first tab contains a row for each mobile worker with the following data:
      1. Basic columns: username, password, name, phone number, email, user_id, language, role, is_active
      2. Read-only columns: IMEI, date registered, date of last sync, date of last form submission
      3. Any custom user data fields configured for your project
      4. User location code, if your project uses organizations
    2. 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
borderColorblack
borderStylesolid
titleBulk Upload Tips and Advanced Info

Sample bulk users excel template

usernamelanguagepassworduser_idis_active
newuser01en123
TRUE

***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 as long as any number of * are kept in that column contains only *s. If text is set in this column, then the password for the user will be update updated to match the text string.  
  • 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.

Advanced
  • 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.

...

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

...

If a deactivated user submits a form, the following will occur:

  • If your app is using secure submissions, deactivated users' 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 Users

...