Difference between revisions of "Execute JavaScript from rules"

From Resco's Wiki
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Bridge TOC}}
 
{{Bridge TOC}}
The [[Resco platform]] offers two main options for adding [[business logic]] to your projects:
+
The [[Resco platform]] offers two main options for adding client-side [[business logic]] to your projects:
 
* [[Rules editor|Rules]] which represent the no-code approach for simpler use cases
 
* [[Rules editor|Rules]] which represent the no-code approach for simpler use cases
 
* [[Resco JavaScript Bridge]] that allows you to write custom scripts to modify UI, data, and access additional functions
 
* [[Resco JavaScript Bridge]] that allows you to write custom scripts to modify UI, data, and access additional functions
Line 6: Line 6:
 
The option to execute scripts directly from rules combines these two options. It aims to simplify writing JavaScript for Mobile CRM by removing the need for boilerplate code, and it should open a path for creating reusable JavaScript libraries with additional functionality for Resco mobile apps, e.g., additional math, date, or string operations, and also business logic.
 
The option to execute scripts directly from rules combines these two options. It aims to simplify writing JavaScript for Mobile CRM by removing the need for boilerplate code, and it should open a path for creating reusable JavaScript libraries with additional functionality for Resco mobile apps, e.g., additional math, date, or string operations, and also business logic.
  
{{Note|For now, this option is supported for form rules. Do not attempt to use the ExecuteJS function in other rules, for example, in views.|Warning}}
+
{{Note|For now, this option is supported for form rules and questionnaires. Do not attempt to use the ExecuteJS function in other rules, for example, in views.|Warning}}
  
 
== Offline HTML ==
 
== Offline HTML ==
Line 19: Line 19:
 
# Click '''Add IFrame''' and link to the file script that you uploaded to the offline HTML folder in the previous section.
 
# Click '''Add IFrame''' and link to the file script that you uploaded to the offline HTML folder in the previous section.
 
# Next, open the rules editor for an event, for example, '''On Save'''.
 
# Next, open the rules editor for an event, for example, '''On Save'''.
# Create a new variable and use the operation ExecuteJS.
+
# Create a new variable and use the [[Rules_editor#Operations|operation '''ExecuteJS''']].
  
 
[[File:Sample executejs rule.png|600px]]
 
[[File:Sample executejs rule.png|600px]]
Line 29: Line 29:
 
* The serialized MobileCRM.UI.EntityForm object is automatically passed as a parameter to the function. You cannot pass a custom input parameter.
 
* The serialized MobileCRM.UI.EntityForm object is automatically passed as a parameter to the function. You cannot pass a custom input parameter.
 
* The implementation supports also ''promises'' for asynchronous result return from functions.
 
* The implementation supports also ''promises'' for asynchronous result return from functions.
 +
* [[Releases/Autumn_2021|Release 14.2]] change: Before this release, values returned from JSBridge were wrapped in an extra set of quotation marks (for example, <code>"123"</code> for numbers or <code>""text""</code> for strings). After the release, one pair of quotation marks is gone (<code>123</code>, <code>"text"</code>). If you're switching from an older version of JSBridge.js, please update your scripts.
 +
 +
== Questionnaire specifics ==
 +
 +
The behavior of the ExecuteJS operator in questionnaire rules is similar to forms:
 +
* It is supported for variables and also whenever you can enter a value; for example for Question.Value.
 +
* In the first argument, simply select the value "IFrame". (Questionnaires don't have multiple tabs for selecting.)
 +
 +
[[File:Execute javascript in questionnaire rules.png|600px]]
  
 
== Example ==
 
== Example ==

Latest revision as of 12:18, 11 October 2021

Resco JavaScript Bridge

The Resco platform offers two main options for adding client-side business logic to your projects:

  • Rules which represent the no-code approach for simpler use cases
  • Resco JavaScript Bridge that allows you to write custom scripts to modify UI, data, and access additional functions

The option to execute scripts directly from rules combines these two options. It aims to simplify writing JavaScript for Mobile CRM by removing the need for boilerplate code, and it should open a path for creating reusable JavaScript libraries with additional functionality for Resco mobile apps, e.g., additional math, date, or string operations, and also business logic.

Warning For now, this option is supported for form rules and questionnaires. Do not attempt to use the ExecuteJS function in other rules, for example, in views.

Offline HTML

In the Offline HTML section of Woodford, you need to add the following:

  • JSBridge.js (the file provided by Resco that contains the method to execute JS desired function from Woodford rule editor)
  • An HTML file with scripts. An example of such a script is available below.

Add function call to form rules

  1. Edit a form in Woodford.
  2. Click Add IFrame and link to the file script that you uploaded to the offline HTML folder in the previous section.
  3. Next, open the rules editor for an event, for example, On Save.
  4. Create a new variable and use the operation ExecuteJS.

Sample executejs rule.png

Additional information

  • The operator ExecuteJS is supported only for variables of the following types: Boolean, String, Integer, Double, Float, Decimal, Money, DateTime, StringList, Entity, Lookup.
  • In the first argument, select the IFrame form tab that links to the script. In the second argument, enter the name of the JavaScript function.
  • The serialized MobileCRM.UI.EntityForm object is automatically passed as a parameter to the function. You cannot pass a custom input parameter.
  • The implementation supports also promises for asynchronous result return from functions.
  • Release 14.2 change: Before this release, values returned from JSBridge were wrapped in an extra set of quotation marks (for example, "123" for numbers or ""text"" for strings). After the release, one pair of quotation marks is gone (123, "text"). If you're switching from an older version of JSBridge.js, please update your scripts.

Questionnaire specifics

The behavior of the ExecuteJS operator in questionnaire rules is similar to forms:

  • It is supported for variables and also whenever you can enter a value; for example for Question.Value.
  • In the first argument, simply select the value "IFrame". (Questionnaires don't have multiple tabs for selecting.)

Execute javascript in questionnaire rules.png

Example

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title>JS from Resco rules</title>
    <meta http-equiv='X-UA-Compatible' content='IE=edge' />
    <meta name='viewport' content='initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no'>
    <script type='text/javascript' src='JSBridge.js'></script>
</head>
<body>
    <script>
        function getAccountEntity() {
            return new Promise(function(resolve, reject) {
                var account = new MobileCRM.FetchXml.Entity("account"); // NOTE: If we save to shared variable of type entity ACCOUNT, we need to create/fetch account entity.
                account.addAttributes();

 

                var fetch = new MobileCRM.FetchXml.Fetch(account);
                fetch.execute("DynamicEntities", function (res) {
                    var current = res[getRandomInt(res.length)];
                    var entity = new MobileCRM.DynamicEntity(current.entityName, current.id, current.primaryName, clearInvalidProps(current.properties));
                    resolve(entity);
                }, reject, null);
            });
        }

 

        function getContactEntity() {
            return new Promise(function (resolve, reject) {
                var contact = new MobileCRM.FetchXml.Entity("contact"); // NOTE: If we save to shared variable of type entity ACCOUNT, we need to create/fetch account entity.
                contact.addAttributes();

 

                var fetch = new MobileCRM.FetchXml.Fetch(contact);
                fetch.execute("DynamicEntities", function (res) {
                    var current = res[getRandomInt(res.length)];

 


                    var entity = new MobileCRM.DynamicEntity(current.entityName, current.id, current.primaryName, clearInvalidProps(current.properties));
                    resolve(entity);
                }, reject, null);
            });
        }

 

        function modifyCurrentEntitySimple(entityForm) {
            entityForm.entity.properties.fax = getRandomInt(10);
        }

 

        function getLookUp() {
            return new Promise(function(resolve, reject) {
                var contact = new MobileCRM.FetchXml.Entity("contact");
                contact.addAttributes();

 

                var fetch = new MobileCRM.FetchXml.Fetch(contact);
                fetch.execute("DynamicEntities", function (res) {
                    var current = res[getRandomInt(res.length)];
                    resolve(new MobileCRM.Reference(current.entityName, current.id, current.primaryName));
                }, reject, null);
            });
        }

 

        function getInteger() { return getRandomInt(128); }
        function getString() { return getRandomString(); }
        function getDecimal() {
            var precision = 100; // 2 decimals
            return Math.floor(Math.random() * (10 * precision - 1 * precision) + 1 * precision) / (1 * precision);
        }
        function getStringList() {
            var res = [];
            for (var i = 0; i < getRandomInt(); i++)
                res.push(getRandomString());

 

            return res;
        }
        function getDateTime() {
            var dt = new Date();
            return dt.toLocaleTimeString();
        }

 

        // **** Helpers ****

 

        function getRandomString(length) {
            var len = length || 7;
            return Math.random().toString(36).substring(len);
        }
        function getRandomInt(maximum) {
            var max = maximum || 4;
            return Math.floor(Math.random() * Math.floor(max));
        }
    </script>
</body>
</html>