Difference between revisions of "Form Scripts"

From AgileApps Support Wiki
imported>Aeric
 
(94 intermediate revisions by 2 users not shown)
Line 12: Line 12:
::*At this event, optionally perform custom front-end validations before sending the data to the server
::*At this event, optionally perform custom front-end validations before sending the data to the server
::*Return false to cancel the save
::*Return false to cancel the save
:*;Resusable Script Functions:
:*;Reusable Script Functions:
::*Available to be called from the On Load or On Save event form scripts
::*Available to be called from the On Load or On Save event form scripts
::*Also available to be called from the On Change and On Focus event field scripts
::*Also available to be called from the On Change and On Focus event field scripts
Line 21: Line 21:


===Working with Form Scripts===
===Working with Form Scripts===
{{Note| Please note that all the examples listed in this page are limited to the legacy AgileApps UI and not the new runtime AgileApps UI.}}


====Editing Form Scripts====
====Editing Form Scripts====
Follow these steps to add or change scripting in a form:
Follow these steps to add or change scripting in a form:
{{Note|To run the JavaScript in the LongJump UI and the legacy AgileApps UI, enter the script in the '''Legacy UI Script''' tab. To run the JavaScript in the New AgileApps UI, enter the script in the '''New UI Script''' tab.}}
# Click '''[Form Script]'''
# Click '''[Form Script]'''
# Click '''[Edit]'''
# Click '''[Edit]'''
Line 30: Line 31:
# Click '''[Save]'''
# Click '''[Save]'''


==== Referencing Fields ====
==== Writing JavaScript ====
Using JavaScript, you can
Using JavaScript, you can
:* [[Referencing Fields in JavaScript|Reference Fields]] in the current form.
:* [[Referencing Form Fields in JavaScript|Reference Fields]] in the current form.
:* Use [[AJAX and REST]] to communicate with the platform.
:* Use [[AJAX and REST]] to communicate with the platform.


====On Load Examples====
===On Load Examples===
Convert the current date into day name, month name, and day number format and puts the resulting value in the <tt>account_order</tt> field.
 
:{|
These examples perform operations when a form is loaded.
 
====Add a Help Button to an Arbitrary Form====
This code works for forms in all objects, including Cases, Tasks, and custom objects. And it works when adding a new record, as well as when viewing an existing record.
For information about adding a help button to a form, see the tech community article [https://tech.forums.softwareag.com/t/adding-a-custom-button-to-an-arbitrary-form-using-form-script/237542 Adding a Custom Button to an Arbitrary Form using Form Script].
 
====Convert a Date====
Create readable date string from the current date for display in the <tt>order_date</tt> field.
:{| border="0" cellpadding="5" cellspacing="0"
<pre>
<pre>
var form = document.mainForm;
var v1 = new Date();  
var v1 = new Date();  
var v2 = new Array('Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thurs', 'Fri', 'Sat', 'Sun');  
var v2 = new Array('Sun', 'Mon', 'Tues', 'Wed', 'Thu', 'Fri', 'Sat');  
var v3 = new Array('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec');  
var v3 = new Array('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',  
form.account_order.value = v2[v1.getDay()] + " " + v3[v1.getMonth()] + " " + v1.getDate();  
                  'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec');  
date_string = v2[v1.getDay()] + " " + v3[v1.getMonth()] + " " + v1.getDate();
setTextFieldValue(_sdForm, "order_date", date_string);
</pre>
</pre>
|}
|}


=====Trigger on a Specific Action=====
====Trigger on a Specific Action====
To invoke a script On Load + Action (View, Update, Add or Clone a record):
To invoke a script On Load + Action (View, Update, Add or Clone a record):
{{Note|For new UI, see the section '''Variables and Methods Introduced in the Revamped UI ''' in [[JavaScript Field Type Reference for New AgileApps User Interface]]}}


Trigger on record ''View'':
Trigger on record ''View'':
:{| border="0" cellpadding="5" cellspacing="0"
:{| border="0" cellpadding="5" cellspacing="0"
|<pre>
|<pre>
var action = document.mainForm.a.value;
var action = _sdForm.get(0).a.value;
if ( action == "view") {
if ( action == "view") {
// java script to be triggered on the view of the record only
  // java script to be triggered on the view of the record only
<!--...-->
  ...
}
}
</pre>
</pre>
Line 65: Line 75:
:{| border="0" cellpadding="5" cellspacing="0"
:{| border="0" cellpadding="5" cellspacing="0"
|<pre>
|<pre>
var action = document.mainForm.a.value;
var action = _sdForm.get(0).a.value;
if ( action == "update") {
if ( action == "update") {
// java script to be triggered on the update of the record only
  // java script to be triggered on the update of the record only
<!--...-->
  ...
}
}
</pre>
</pre>
Line 75: Line 85:
Trigger on record ''Add'' or ''Clone'':
Trigger on record ''Add'' or ''Clone'':
:{| border="0" cellpadding="5" cellspacing="0"
:{| border="0" cellpadding="5" cellspacing="0"
|<pre>var action = document.mainForm.a.value;  
|<pre>var action = _sdForm.get(0).a.value;  
if ( action == "add") {
if ( action == "add") {
//java script to be triggered on the add or clone of the record only
  //java script to be triggered on the add or clone of the record only
<!--...-->
  ...
}
</pre>
|}
 
===="On Save" Examples====
 
Make sure there is a contact when creating a record in a "Leads" object.
:{|
<pre>
var form = document.mainForm;
if (form.reference_type[form.reference_type.selectedIndex].value == 'Lead')
{
    if (form.contact_id.value == "")
    {
      alert("Please enter Contact Name");
      return false; // cancel the save operation
    }
}
</pre>
|}
 
If a user checked the "Done" radio button in a radio button group named <tt>technical_spec_completed</tt>, set the <tt>spec_date</tt> field with the current date formatted as month number, day number, and year.
:{|
<pre>
var form = document.mainForm;
function formatDate(value)
{
    return value.getMonth()+1 + "/" + value.getDate() + "/" + value.getFullYear();
}
for (var i=0; i<form.technical_spec_completed.length; i++) {
    if(form.technical_spec_completed[i].checked &&
        form.technical_spec_completed[i].value == 'Done' && form.spec_date.value == '')
    {
        t = new Date();
        form.spec_date.value = formatDate(t);
    }
}
}
</pre>
</pre>
|}
|}


The email address field on a form is not mandatory, but you want to encourage users to enter it. If the user clicks OK in the confirm dialog, it cancels the save so they can then enter the email address. If they click cancel, the save proceeds.
===On Save Examples===
:{|
<pre>
var form = document.mainForm;
 
if(form.email.value=="")
    if (confirm("While the Email field is optional, we recommend that you
enter a value"))
    {
        //User clicked OK: do not proceed with save
      return false;
    else
    {
        //User clicked cancel: let save happen
        return true;
    }
}
</pre>
|}


{{:Change Checkbox Value Script}}
For examples related to the On Save action, see the tech community article [https://tech.forums.softwareag.com/t/perform-custom-validations-using-form-script-in-agileapps/237545 Perform Custom Validations using Form Script in AgileApps].


===Learn More===
===Learn More===
:* [[JavaScript Field Type Reference for New AgileApps User Interface]]
:* [[Referencing Form Fields in JavaScript]]
:* [[Field Name|Field Name and Field Value]] syntax
:* [[Field Name|Field Name and Field Value]] syntax
:* Use [[AJAX and REST]] to communicate with the platform in JavaScript code.
:* Use [[AJAX and REST]] to communicate with the platform in JavaScript code.
:* [[Global JavaScript Variables]]
:* [[JavaScript Functions]]
:* [[JavaScript#Accessing_Additional_Lookup_Variables_in_a_Form|Accessing Additional Lookup Variables in a Form]]
:* [[JavaScript#Accessing_Additional_Lookup_Variables_in_a_Form|Accessing Additional Lookup Variables in a Form]]
<noinclude>
<noinclude>

Latest revision as of 05:12, 17 May 2024

About Form Scripts

Form Scripting lets you specify JavaScript code to execute when a Form is loaded or saved.

JavaScript code can be invoked at these form-level events:

  • On Load
  • This event happens when the form loads
  • By default, the On Load scripts are triggered on any record action (View, Add, Update)
Optionally, invoke the script on a specific action (View or Add or Update)
Learn more: Trigger on a Specific Action
  • On Save
  • This event happens when a user clicks the [Submit] button on a form
  • At this event, optionally perform custom front-end validations before sending the data to the server
  • Return false to cancel the save
  • Reusable Script Functions
  • Available to be called from the On Load or On Save event form scripts
  • Also available to be called from the On Change and On Focus event field scripts
Learn more:

Working with Form Scripts

Notepad.png

Note: Please note that all the examples listed in this page are limited to the legacy AgileApps UI and not the new runtime AgileApps UI.

Editing Form Scripts

Follow these steps to add or change scripting in a form:

Notepad.png

Note: To run the JavaScript in the LongJump UI and the legacy AgileApps UI, enter the script in the Legacy UI Script tab. To run the JavaScript in the New AgileApps UI, enter the script in the New UI Script tab.

  1. Click [Form Script]
  2. Click [Edit]
  3. Enter or change the JavaScript in On Load Script, On Save Script, and/or Reusable Script Functions
  4. Click [Save]

Writing JavaScript

Using JavaScript, you can

On Load Examples

These examples perform operations when a form is loaded.

Add a Help Button to an Arbitrary Form

This code works for forms in all objects, including Cases, Tasks, and custom objects. And it works when adding a new record, as well as when viewing an existing record. For information about adding a help button to a form, see the tech community article Adding a Custom Button to an Arbitrary Form using Form Script.

Convert a Date

Create readable date string from the current date for display in the order_date field.

var v1 = new Date(); 
var v2 = new Array('Sun', 'Mon', 'Tues', 'Wed', 'Thu', 'Fri', 'Sat'); 
var v3 = new Array('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 
                   'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'); 
date_string = v2[v1.getDay()] + " " + v3[v1.getMonth()] + " " + v1.getDate(); 
setTextFieldValue(_sdForm, "order_date", date_string);

Trigger on a Specific Action

To invoke a script On Load + Action (View, Update, Add or Clone a record):

Notepad.png

Note: For new UI, see the section Variables and Methods Introduced in the Revamped UI in JavaScript Field Type Reference for New AgileApps User Interface

Trigger on record View:

var action = _sdForm.get(0).a.value;
if ( action == "view") {
   // java script to be triggered on the view of the record only
   ...
}

Trigger on record Update:

var action = _sdForm.get(0).a.value;
if ( action == "update") {
   // java script to be triggered on the update of the record only
   ...
}

Trigger on record Add or Clone:

var action = _sdForm.get(0).a.value; 
if ( action == "add") {
   //java script to be triggered on the add or clone of the record only
   ...
}

On Save Examples

For examples related to the On Save action, see the tech community article Perform Custom Validations using Form Script in AgileApps.

Learn More