You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

WARNING: This page is internal-only

Prior to releasing this feature:

  • Make sure that viewing restrictions are removed
  • Check to make sure that contents are correct and easy-to-follow
  • Remove this warning message

This feature requires a CommCare Software Plan

This feature (CloudCare) is only available to CommCare users with a Pro Plan or higher. For more details, see the CommCare Software Plan page.

 

Report: Message Log  

Overview

The Message Log is a cumulative list of all the sent and received messages.

It is the most complete data set for the history of all SMS-interaction and it can be filtered by date and message type.

  • To access the Message Log, go to Reports, and find the Messaging section. 

Message Log includes: 

  • Timestamp - date/time from the server (shown in the project's timezone.)

  • User Name - name of the case or user

  • Phone Number - phone number of the phone involved in the interaction

  • Direction - incoming or outgoing message

  • Message - the actual text sent out or received in the message

  • Type of message 

There are many Types of SMS messages captured in the log. 

  • Broadcast - outgoing message content
  • Reminder - scheduled messages
  • Survey - collects data from incoming messages
  • Keyword - a word or letter that triggers an action in HQ including opening a form, sends a reply, escalates an alert. 
  • Other - messages from an unrecognized source

Don't forget that a single message can be tagged as multiple types.  For example, a survey that is submitted as a structured keyword will be tagged as survey and keyword.   

Filtering the Report

The report will let you filter to view a specific set of messages.  You can filter by:

  • Date range of the message
  • Type of message (Broadcast message, keyword, reminder, survey, etc.)
  • Location

After applying the filter you can choose "export to Excel" if you'd like more complex analysis.

Use of the Feature

  • This is the first place you should go when investigating the use of Messaging in your project space.
  • The report can be filtered: to a specific data range, certain types of messages, and on locations.  

Notes and Limitations

  • You cannot delete messages from the message log.

Report: Message History 

Overview

The Messaging History report allows you to view all of the messaging related activity for a project - it will list any successful and attempted messages to help you troubleshoot and understand your messaging project.   For unsuccessful messages, the report will show the reason for failure (missing phone number, duplicate phone number, etc.).  

To access it, go to the Reports Tab, and go to Messaging, then select Messaging History

 Or navigate directly using https://www.commcarehq.org/a/project/reports/messaging_events/


For unsuccessful messages, the report will show the reason for failure (missing phone number, duplicate phone number, etc.).  

Filtering the Report

The report will let you filter to view a specific set of messages.  You can filter by:

  • Date range of the message
  • Type of message (Broadcast message, keyword, reminder, survey, etc.)
  • Status - Completed, In Progress (for two way surveys), Error
  • Phone Number for Message

View Message Details

The report will list individual messaging events - an event could contain multiple messages (ex. an SMS survey will contain many messages between CommCareHQ and the participant, but will only be listed once).  

  • View Details: Link to individual event will show the specific messages that are part of that event (and the status of each).  

  • Recipient name: Link to a case data page.  

  • Content: Link to the reminder set-up that triggered the message.


Report: SMS Usage Report 

Overview

Describe the feature in simple language, including:

  • A brief general description
  • Common use cases
  • Key relationships to other features
  • Use of the Feature

Filtering the Report

The report will let you filter to view a specific set of messages.  You can filter by:

  • Reporting group
  • Date range of the message

Use the Report

The report provides a high level summary for each user, with three columns

  1. Number of messages received
  2. Number of messages sent 
  3. Number of Phone Numbers used 


Describe the basic steps or you should take to use this feature. Include screenshots wherever useful.

This does not need to be very detailed step-by-step guidance; that is done through a tutorial/guide and will be on a separate page

Notes and Limitations

Only contacts with verified accounts are included in this report. 

  • No labels