What's New in V4

Changes in Naming

The naming used in the Data Model XML, Views XML and some JavaScript functions are changed to be more consistent and intuitive.

For the complete list, see the Naming Details section.

The data model and view XML changes are handled automatically by the migration process. However, the JavaScript changes have to be performed manually.

It is now longer required to define link elements explicitly. Instead, call the links by path with link.link_path(). The same function can now also be called directly from the on-press attribute in the view XML, optionally passing view variables as arguments. This replaces the need for the link attribute on buttons.

<view title="Main Menu">
    <button label="New User" on-press="link.new_user()" />
<view title="Select Task">
    <var type="query:task" name="tasks" />
    <object-list label="View Task" query="tasks">
        <action on-press="link.view_task($selection)" />

It is no longer required to use return link.some_view() - instead just use link.some_view(). The link function now throws an exception, that is used for navigation.

For details, see the Linking Views section.

New โ€˜resumeโ€™ Callback

Instead of defining ondismiss actions on links, you can now define a single resume function per view. If defined, this is called whenever the user returns to the view, both via a dismiss call and via the back button.

function resume(from) {
    if(from.dismissed && from.path == 'user/new') {
        dialog("New User", "A new user has been created");

For details, see the Linking Views section.

New Choice Types

enum has been renamed to single-choice-integer, and enum_set has been renamed to multiple-choice-integer. Additionally, these types now take explicit keys for each option.

<field name="color" type="single-choice-integer">
    <option key="2">Red</option>
    <option key="6">Green</option>
    <option key="4">Blue</option>
    <option key="5">Yellow</option>

There are also three new choice types:


Like single-choice-integer, but takes string keys. This is recommended over single-choice-integer.

<field name="color" type="single-choice">
    <option key="red">Red</option>
    <option key="green">Green</option>
    <option key="blue">Blue</option>
    <option key="yellow">Yellow</option>


Like single-choice-integer, but has exactly two boolean options.

<field name="confirmed" type="boolean" />
<!-- If not specified, default options are:
    <option key="false">No</option>
    <option key="true">Yes</option>

<field name="acceptance" type="boolean">
    <option key="true">Accepted</option>
    <option key="false">Not Accepted</option>


Like multiple-choice-integer, but takes string keys. This is recommended over multiple-choice-integer.

<field name="colors" type="multiple-choice">
    <option key="red">Red</option>
    <option key="green">Green</option>
    <option key="blue">Blue</option>
    <option key="yellow">Yellow</option>

โ€˜Dayโ€™ Objects

date fields now use a Day object instead of Date object to represent the value. The Day object represents only the Gregorian day, with no time or timezone.

var today = Day.today();
var today = new Day(); // Same as Date.today()
var day = new Day("2014-01-05") // Parse some day.
var day = new Day(new Date());  // Convert Date to Day, in local timezone.
day.startOfDay();	// Start of day in local timezone, as a Date
day.endOfDay();	// End of day in local timezone, as a Date
day.toString();		// โ€œ2014-01-05โ€
day.toISOString();	// โ€œ2014-01-05โ€
day.toJSON();		// โ€œ2014-01-05โ€
day.valueOf();		// 1388880000000
day.getYear() // 2014
day.getMonth() // 1 (0 - 11)
day.getDay() // 5

New Label Behavior

If no label is specified on an input component, it is now inferred from the Data Model. Will be blank for direct view variables, since they do not have any label. This that you can have more concise view components, for example:

<text-input bind="my_form.field1" />
<text-input bind="my_form.field2" />
<single-choice-dropdown bind="my_form.choice3" />

To explicitly create an input without any label, use label="". This will remove it completely (no whitespace). To still have some whitespace, use label=" " (a single space in the label).

The placeholder text of text inputs may now be customized by specifying placeholder="My placeholder". This may be used to create more compact forms, for example:

<text-input bind="address_street" label="" placeholder="Street" />
<text-input bind="address_city" label="" placeholder="City" />
<text-input bind="address_code" label="" placeholder="Postal Code" />

New V4 JourneyApps API

The JourneyApps API has been upgraded significantly, and is now available in V4.

Please see the documentation for the Backend API or refer to the section about Updating to the V4 API.

Naming Details

Data Model

These changes are automatically applied by the migration process.

For details, see the syntax section under What is the data model?

Field Types

These changes are automatically applied by the migration process.

Component Names

These changes are automatically applied by the migration process.

JavaScript Functions

These changes are not automatically applied by the migration process, and have to be applied manually.

Last updated