Button Click

Rules and examples
On Load On Change On Save On Create Select Form Row Script On Execute On Can Execute Cell Click Button Click On Item Added On Item Completed On Repeat On Delete Form rules Rules on the bulk update form Command rules Questionnaire Designer examples Rules editor Global constants

Rules are client-side scripts (no-code business logic) that are executed when a user of the mobile app interacts with the app. The Button Click rules are executed when a row button is clicked. Rules are managed using the rules editor, usually in Woodford.
Button Click rules are available on the:

Button Click variables

Handled: If false (default) the standard behavior is executed after the rule. If True, it is skipped.

Handled	Assign	False

DirectEdit

Controls how the changes to the entity are handled (if there are any).

True and the entity is dirty after the rule executes, the entity is saved to storage (OnSave rule is run).
False, if a property is changed the ChangeRule is run and the entity is added to the list of dirty entities to be saved on user command.
Null (not-set, default), changes are ignored.

Example: create a new order or appointment

These two examples, showcase custom buttons on the account form.

First, we click Add button and fill in the name of the button (Click text, Label):

.

Then, set up a Button Click rule. Changeditem is the button's item binding (set in properties). We create a variable that will be a new instance of order or appointment and assign the customer id from the account. In the end, we open a new appointment/order record.

You can fill out the new forms further. In the new order, we set the account's address as the shipping address.

In the new appointment, we add the date of creation and name of the appointment by concatenating "Meeting with:" and the account's primary contact.

OpenForm with JSON options

Note that the OpenForm operation allows specifying options in JSON format. For example, you can use the following syntax:

{ "@initialize": { "name": "MyOrder", "discountamount": "100" } }

The opened form is not marked as "dirty". You can use the @dirty parameter to override this behavior.

	<definition e="false">
		<var>var1</var>
		<func>LoadFetch</func>
		<type>Entity</type>
		<arg>String:invoice</arg>
		<arg>Fetch:&lt;fetch&gt;&lt;entity name=&apos;invoice&apos;/&gt;&lt;/fetch&gt;</arg>
	</definition>
	<function e="false">
		<var>var1.@this</var>
		<func>OpenForm</func>
		<arg>String:{ &quot;@initialize&quot;: { &quot;name&quot;: &quot;MyOrder&quot;, &quot;discountamount&quot;: &quot;100&quot; } }</arg>
	</function>

You can use OpenForm to launch a questionnaire; however, the JSON options are ignored.

Example: start questionnaire by clicking the button

Clicking the Inspections button opens up a new questionnaire.

If the button is clicked, we fetch questionnaire template which is published and its name equals "Equipment checkup". If this fetch contains data, the questionnaire is opened.

Used Fetch:

To see the rule execution in the app, click here.

Example: Save and close form

In this example, we execute a simple JavaScript function from rules that saves and closes the current form.

Add an offline HTML file to your form with the following script (taken straight from our GitHub wiki).

function saveAndCloseForm() {
	MobileCRM.UI.EntityForm.requestObject(function (entityForm) {
		/// <param name="entityForm" type="MobileCRM.UI.EntityForm"/>
		if (entityForm)
			MobileCRM.UI.EntityForm.saveAndClose();
	}, function (err) {
		MobileCRM.bridge.alert("An error occurred: " + err);
	}, null);
}

Add a button to your form.

Add a button click rule. In the example below, "funwithforms" refers to the name of the script file.