Summary: Output components allow you create output results that behave in a special way on a mobile client.
Clicking a link will scroll the page to the relevant section.
Overview of Output Components
The output components that are currently available include:
- Audio Output (Mobile) – Takes a binary property that contains an audio clip and creates a result that will invoke the audio listening control on the mobile device. For example, a task reads an audio instruction to the end user.
- Text to Audio Output (Mobile) – Takes a chunk of English-language text and creates a result from it. On the mobile device, the text is shown as text and read in a voice-over.
Note: Examples for using these components is available in "Protocols/Mobile/Developer/Outputs".
The Mobile Collection includes a set of components that make it easy to generate simple, readable, device-optimized, mobilized reports. As a developer, you will want to get familiar with these components and use them to create compelling results for your users.
If you are familiar with the Reporting collection, you might recognize most of the available component types. The difference is that these output components have highly-simplified interfaces (for ease of use) and are optimized to display well even on small-screen devices such as an iPhone.
The set of available components is smaller than what is available in the Reporting collection, because it is still under development, and to encourage simplicity in the results. The smaller real-estate available on mobile devices puts a premium on the old adage "less is more".
Note: If you designed protocols that use the standard Reporting collection, or if you prefer not to learn another variant, this should not pose a major problem. Almost all standard reporting protocols will work when published for mobile access. However, the results are not optimized for mobile delivery. As a result, some outputs might feel unnatural on the mobile device and might be difficult to read and interact with.
Open the folder "Component/Mobile/Reporting", shown here:
The "Charts" folder contains components for creating simple mobile-optimized charts (described below).
The "Text" folder contains components to add text and HTML fragments to your output document (described below).
Of special note is the HTML Output (Mobile) component, which assembles the parts of the document into the final HTML5 page, opening that page in a viewer. This component is needed as the last step whenever you use any mobile reporting component.
The Mobile Collection includes a set of components that make it easy to generate simple, readable, device-optimized, mobilized charts. As a developer, you will want to get familiar with these components and use them to create compelling charts for your users.
If you are familiar with the Reporting collection, you might recognize most of the available chart types. The difference is that these charts have highly-simplified interfaces (for ease of use) and are optimized to display well even on small-screen devices such as the iPhone.
The mobile charts that are currently available include:
- Bar Chart (Mobile)
- Categorical Histogram (Mobile)
- Gauges (Mobile)
- Geo Chart (Mobile)
- Line Chart (Mobile)
- Numerical Histogram (Mobile)
- Pie Chart (Mobile)
- Sortable Table (Mobile)
- XY Scatter Plot (Mobile)
The easiest way to learn how to use a particular mobile chart component is to look at the developer examples in "Protocols/Mobile/Developer/Charts". This directory includes an example for each chart type, with sticky notes to help walk you through using them.
The text components allow you to add text elements, in combination with your charts, to your mobile output. If you know HTML, then these components should be straightforward to use.
The mobile text components that are currently available include:
- Break (Mobile) – Generates a HTML break (
<br>) that can be used to separate text elements.
- Font (Mobile) – Adjusts font characteristics of text.
- HTML (Mobile) – Injects a preformatted chunk of HTML into the final document.
- Text (Mobile) – Creates a piece of text content wrapped within the HTML tag of your choice. For example,
<code>(computer code), etc.
Note: Other HTML Reporting (Mobile) components are used in the examples that are not described here. These other components are prototypes that are still under development. To locate them for testing, search the "Components/Mobile/Utilities/Prototypes/Reporting" folder. Be aware that these components might change in the future.
The Utilities folder contains one subfolder ("Prototypes"). It contains components that are still undergoing active development. You are encouraged to check them out and even use them for testing. (Some are quite useful.) However, be aware that their interfaces might change in the future and these enhancements would require that you replace some of the components at a later time.
The utilities components that are currently available are organized in the following folders:
- Barcodes – Utilities for creating barcode images
- Filters – Utilities for determining whether a protocol is being run on a mobile device
- Location and Maps – Utilities for manipulating location and map data
- Multistep Tasks – Utilities for passing data between two separately-run protocols
- Reporting – Additional prototype mobile reporting components
The Utilities/Prototypes folder structure is shown here: