Versions Compared


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

Multiexcerpt include macro
nameSoftware Plan - Advanced
page[Internal] CommCare Public Management


  • Question ID: as usual

  • Intent ID: intent action for your activity - for example "android.intent.action.DIAL" to launch the phone dialer

  • Extra: keys and paths to form fields containing the values of arguments for the intent activity

    • The paths point to the location of this data - no hard-coding of values. The paths can point to hidden values that calculate the desired value

  • Response: any extra values for ODK to store, along with the paths of where to store them


titleAdvanced (Update text / intent type)

CommCare additionally supports customizing the button text and setting intent type by editing the underlying XForm XML and setting the following attributes on the odkx:intent element:

  • button-label 

  • type

As an example, the following XML sets the intent type to "" and the button label to "Send SMS". 

Code Block
<odkx:intent xmlns:odkx="" id="send_sms" class="android.intent.action.VIEW" button-label="Send SMS" type="">


For the source code referred to in this document please refer to this application.  (Additionally, you may also refer to this standalone Android application provides demo of API integrations that are provided by CommCare.)

First, in our AndroidManifest.xml we will need to register an intent-filter to listen for CommCare's call out. This will look like:

Code Block
            android:label="@string/app_name" >
                    <action android:name="android.intent.action.MAIN" />
                    <action android:name="" />


Next, in the activity's onCreate() method we parse the Extras from the intent bundle:
Code Block
    protected void onCreate(Bundle savedInstanceState) {
        Bundle mBundle = getIntent().getExtras();
        //this is how we read in values sent by CommCare
        String caseid = mBundle.getString("case_id", null);


Finally, after this external application has done all of its work, we package up our results in a response. There are two ways of adding resultant data:

Code Block
                String text = entryBox.getText().toString();
                Intent data = new Intent();

                //this is how you would add responses to the default bundle.
                Bundle responses = new Bundle();
                responses.putString("example_id", "Example text");
                data.putExtra("odk_intent_bundle", responses);

                // this is the value that CommCare will use as the result of the intent question
                data.putExtra("odk_intent_data", text);
                setResult(Activity.RESULT_OK, data);