Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Background

The CloudCare instance viewer is a (currently feature flagged) The Data Preview is an advanced tool that will allow you to view the current state of the instance XML your form data as you perform form entry. This can be found on Web Apps and on App Preview. You can view either the XML structure itself with values filled in, or the questions in a pretty UI. Further clearer user interface. Additionally, you can enter XPath's to see how they evaluate against the current XML form structure.

Activation

You can activate this feature via the Feature Flag UI under the Admin tab.

Important: If you are testing with a mobile worker you must enter the email of the mobile worker into the feature flag. Email will be: username@project-space-name.commcarehq.org.

Image Removed

...

Please note that this feature only works with the role setting “edit_data permissions”

Table of Contents

Basic Usage

Form entry is performed as usual

Image Removed

Question Viewer

You can view a list of the current questions and the current responsesand you will notice a bar at the bottom of the page that says Data Preview. This can also be found on the Image Added icon in App Preview.

...

To open data preview, simply click the dark blue bar at the bottom to open it. Below you'll see a screen with the form data shown. This is useful for complex figuring out calculations in on hidden values , obviating the need for debug labelswithout submitting the form to the server

Image Removed

XML Viewer

The XML viewer shows the same information as above, but also allows you to see the current tree structure. This can be useful for debugging complex XPath traversals. 

Image Removed

XPath Evaluator

This dialog allows you to entry plain text XPath that are evaluated against the current instance. 

Image Removed

Next Steps

In addition to the usual feedback on bugs and UI suggestions, we're interested in feedback from the field team and other power users about what enhancements or extensions would be useful for the next iteration of this feature. This is a feature that could evolve in many ways and we want to be directed about how we invest in this feature. Possible next steps are:

  1. Ability to inspect external instances (IE casedb, fixtures, ledgerdb, etc.)
  2. Click on XML, get XPath
  3. Perform calculations on XPaths

 

...

The debugger is also available in live preview. You can access it when you are in a form. Look for a data table icon in the bottom right.

...

Advanced Usage

In most scenarios, viewing just the form data is enough to get insight on your application. However, Data Preview also offers the ability to query your data as well as view the raw xml of the form.

Evaluate XPath

The Evaluate XPath tab allows users to evaluate arbitrary XPath clauses on their data. This is useful to test different conditions or expressions with the form in the current state. Note: you need to use /data/... syntax rather than the #form/... syntax as you would in Formbuilder!

...

Form XML

In other cases, you may desire to see the actual form XML that is being generated by the form. You can do this by selecting the Form XML tab.

...