Accessing Locations from within a CommCare Supply form

For users already familiar with CommCare's conditional select functionality, referencing locations within a form is very similar.  To access the list of locations from within a CommCare Supply form, you can use the syntax described HERE.

Much like lookup tables in order to reference location data in a form, you must first include a reference to this instance in the forms xml.  To access this xml, enter your form, and in the top righthand corner, under "Tools", select "Edit Source XML"

Open

You'll need to add the following line to the instances in order to reference location data:

<instance id="locations" src="jr://fixture/commtrack:locations"></instance>

Place this just above the first "<instance>" here:

Open

Next you'll need to add a select question to the XML.

It should look something like: 

You can drill down to any level of location within this hierarchy by following this model.  For example, if your hierarchy starts at the regional level, then proceeds to state, then district, then outlet.  You can reference facilities like this:

If you'd like to select a location based on a previously selected location higher up in the location hierarchy, in this example select a facility only from a list of facilities that are in a district that you've already chosen, you can filter use the following XML:

Note that whenever referencing the location hierarchy, only locations with which a mobile user is associated will sync to that users phone.  So, if the mobile user account is linked to outlet 'a', then the only district that will appear on that users phone is the district to which outlet 'a' belongs, and the only state will be the state to which that district belongs.

UPDATE !

In order to set up a single of multiple answer questions on locations, follow these steps:

1. Add a Single/Multiple Answer Lookup Table:
   
   

2. Click on the "Lookup Table Data" question
   
   
   

3. Edit the following fields:
   
   

    

   1. Lookup Table: click on the 3 dots next to the field 

      and complete the following fields.
      
      

       

      1. Query expression: put here your location instance. For example:

         1. if you want to display the list of states: instance('locations')/states/state

         2. if you want to display the list of districts of a previously selected state: instance('locations')/states/state[site_code=/data/state_selected]/districts/district
            where /data/state_selected is the state previously selected.

      2. Instance ID: locations

      3. Instance URI: jr://fixture/commtrack:locations
         
         
         

   2. Value Field: what you want to save as an answer (usually an id or a code). For locations you can use site_code or @id.

   3. Label Field: what you want to display to the user. For locations you can use name

   4. (Optional) Filter: can be used to filter the locations displayed.
      
      
      

 If you don't see the 3 dots (), you need to activate a feature flag in your project settings.

Add the feature preview "Custom Single and Multiple Answer Questions"  to your project