Actions & Events

It is possible to perform actions within a message when an event occurs. These include performing a calculation, capturing location etc. To configure see the ‘Actions’ section under the ‘Extras’ tab in a Template.

Events

Available events include:

Actions

Available actions include:

An example of a JavaScript function being called after a change in the start or finish time (both are Date Item fields).

JavaScript Actions

It is possible to run JavaScript functions to perform calculations on the device and other roles such as more advanced validation and workflow decisions.

The functions should take a single argument that will be a JS object derived from the message data at the level the function is run. For example if the function is run at the root level then it will be all the message data. If the function is run within a list card item then it will only contain that items data. It should return a JS object with a data property that contains the values to be merged back into the current message data.

There are options for running JS function when the ‘done’ button is pressed to exit editing a list card item and to perform extra validation when sending a message or exiting a list card item. You may use this to set a complete flag for the item, as well as performing more complex validation, for example.

Set the content of the JS Functions text area, under the ‘Extras’ tab, with the content of the JS to compile. This can include supporting variables and functions along with the actual function to call from AMS.

When accessing JS values the property is set to the external label. For example a Date Item with external label start would be accessed in the JS function like msgData.start (assuming that ‘msgData’ is the name of the single argument in the function definition). The following are the data types for the values:

An example of a simple time calculation:

 0
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function calculateHours(msgData) {

    var start = msgData.start;
    var finish = msgData.finish;

    var data = {};
    var hours = 0;

    if (start && finish) {
        var time = ((finish - start) / 1000 / 60 / 60);
        if (time < 0) {
            hours = "Error";
        } else {
            hours = time.toFixed(2);
        }
    }

    data['hours'] = hours.toString();
    return {data: data};

}

An example of calculating a score based on answers to questions:

 0
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

// Sample Risk Calculator

var risks = [
"healthImpact", "notCoping", "cutOff", "familyRelationships", "notMuchLonger",
"relationshipStrain", "effort", "break", "share", "depressed", "losingControl",
"increasedDrugs"
];

function calculateCaregiverRisk(msgData) {

    var totalScore = 0;
    var data = { };
    var totalRisks = 0;
    // check message data for all the risks and accumulate their score
    for (var i = 0; i < risks.length; i++) {
        var risk = msgData[risks[i]];
        if (risk && risk.length > 0) { // check if given risk exists and has a value
            totalScore += parseInt(risk[0].trim(), 10);
            totalRisks++;
        }
    }
    // only return a score when all fields have a value

    if (totalRisks == risks.length) {
        var riskText = '';
        if (totalScore < 11) {
            riskText = 'Low';
        } else if (totalScore >= 11 && totalScore <= 16) {
            riskText = 'Moderate';
        } else if (totalScore >= 17 && totalScore <= 22) {
            riskText = 'High';
        } else if (totalScore >= 13 && totalScore <= 30) {
            riskText = 'Very High';
        }
        data['riskScore'] = riskText + ' (' + totalScore + ')'; // convert number back to String for AMS text field
    }
    return { "data": data };

}