JavaScript Field Type Reference for New AgileApps User Interface

Accessing and Updating Different Field Types

The following table shows how to access and update the different field types for the revamped AgileApps user interface, where:

• _sdForm is the variable that references the current form
• field is a string containing the name of the field
  (as with all strings, literal values must be in quotes)
• value is a value you specify (generally a string)
• value is language keyword, typed exactly as shown--as in this line,
  for example, which gets the value from a field called email_address:

_sdForm.email_address.value

Note: Form data is in User Format. Data entered into the Form must be in that format, as well. Data going to and from the platform, on the other hand, must be in Database Format. Learn more: Localization#JavaScript Programming

Note: JavaScript functions mentioned in the table does not support Web Forms.

Type	Getter	Setter	New UI Support	Scripts supported only with New UI
Auto Number	n/a	n/a	n/a
Checkbox	getCheckBoxState(_sdForm, field) Returns: true or false	setCheckboxState(_sdForm, field, state) state: true or false Example: setCheckboxState(_sdForm, "item_approved", true);	Yes
Currency	getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
Date	_sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
Date time	_sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
Dependent Picklist	getPickListSelectedValue(_sdForm, field) Returns: selected String containing value	setPickListValue(_sdForm, field, value) value: String containing new value	Yes
Email Address	getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
External Lookup	n/a	n/a	n/a
File Field	n/a	n/a	n/a
Formula	n/a	n/a	n/a
Geolocation	getTextFieldValue(_sdForm, field) Returns: A string containing a latitude and longitude,     separated by a comma and a space. Ex: 37.403930662906106, -121.97971165820213	setTextFieldValue(_sdForm, field, value) value: A string containing the new geolocation value	Yes
Global Picklist	getPickListSelectedValue(_sdForm, field) Returns: selected String containing value	setPickListValue(_sdForm, field, value) value: String containing new value	Yes
Image Field	n/a	n/a	n/a
Lookup	getLookupFieldValue(_sdForm, field) Returns: String containing record ID getLookupFieldText(_sdForm, field) Returns: String containing the displayed text getDependentLookupFieldsData(_sdForm, fieldName) Returns: String containing the displayed text	setLookupValue(_sdForm, field, value, text) value: String containing record ID text: String containing the text to display	Yes	Example for Get dependent lookup field data: var promise = getDependentLookupFieldsData(_sdForm, 'fieldColumnName); promise.then(function(dependentLookupData) { console.log(dependentLookupData) }, function(errorMessage){ console.log(errorMessage) });
Lookup-Derived_Fields	getDependentLookupFieldValue(_sdForm, fieldName) Returns: String containing record ID	n/a	Yes	Example for Get dependent lookup field value: var promise = getDependentLookupFieldsData(_sdForm, 'fieldColumnName); promise.then(function(dependentLookupData) { console.log(dependentLookupData) }, function(errorMessage){ console.log(errorMessage) });
Multiple Checkboxes	getMultiCheckBoxValue(_sdForm, field) Returns: An array of values, one for each checked box getMultiCheckBoxValue(_sdForm, field, index) index: 0 for the first checkbox,       1 for the second, and so on. Returns: The value of the box if selected, else an empty string	setMultiCheckBoxValue(form, field, [value1, ...]) Argument: Array of values to set Example: setMultiCheckBoxValue(_sdForm, field, ["A", "B"]) (Checkboxes for all other values are turned off)	Yes
Multi Object Lookup	n/a	n/a	n/a
Multi Select Picklist	getMultiPickListSelectedValue(_sdForm, field) Returns: Array of strings, with selected values Example: ["A", "C"]	setMultiPickListValue(_sdForm, field, [value1, ...]) Argument: Array of values to select Example: setMultiPickListValue(_sdForm, field, ["A", "B"] )	Yes
Number	_sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value, or a number	Yes
Number with decimals	sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value, or a float	Yes
Percentage	sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
Phone/Fax	sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
Picklist	getPickListSelectedValue(_sdForm, field) Returns: selected String containing value	setPickListValue(_sdForm, field, value) value: String containing new value Example: setPickListValue(_sdForm, "status", "Closed");	Yes
		setFieldCustomIcons(_sdForm, field, arrayOfCustomIconObject) Note:This is available only in the revamped user interface.	Yes	Use the following script to set custom field icons: var arrayOfCustomIconObject = [ { value: '2', url: 'https://companies.mybroadband.co.za/files/2015/07/Software-AG-logo.jpg>', altText: 'abcd', iconPosition: 'right' } ]; where; value - this is the picklist value that you want to use. url - this is the path to the image file which you want to use an icon. altText - this is the text you want to display when you move the cursor over the icon image. iconPosition - this is the icon position you want to use. You can choose right or left.
Radio Buttons	getRadioButtonValue(_sdForm, field) Returns: String containing selected value	setRadioButtonValue(_sdForm, field, value) value: String containing new value to select Example: setRadioButtonValue(_sdForm, "color", "Black");	Yes
Rich Text Area	getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value Example: setTextFieldValue(_sdForm, "detailed_description", "test description");	Yes
Rollup Summary Field	n/a	n/a	n/a
TextArea	_sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
TextField	_sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value Example: setTextFieldValue(_sdForm, "first_name", "Adam");	Yes
Time	_sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes
URL	_sdForm.fieldname.value -or- getTextFieldValue(_sdForm, field) Returns: String containing value	setTextFieldValue(_sdForm, field, value) value: String containing new value	Yes

Variables and Methods Introduced in the Revamped UI

The following variables and methods are introduced in the revamped UI for Form scripts:

Variables

• objectID - Use this variable to retrieve the object ID.
• recordID - Use this variable to retrieve the record ID.
• formAction - Use this variable to get the form action mode. The possible return values are add or update.

Methods

• getDependentLookupFieldValue(): This method provides the derived lookup field data corresponding to the field column name (fieldId) asynchronously. It returns the Promise object with fulfilled or rejected, the respective handler function (onFulfilled or onRejected) is called asynchronously.
• getDependentLookupFieldsData(): Get all the dependent(derived) lookup field data for a record using the parent lookup field. It returns the Promise object with fulfilled or rejected, the respective handler function (onFulfilled or onRejected) is called asynchronously.
• getUserRoleNames() - Use this method to retrieve user role names.
• isUserHasRole("roleName") - Use this method to find out if a user is assigned to a particular role. For example, to find out if a user has an Admin role, use the method: isUserHasRole("Admin").
• getUserActiveRole() - Use this method to get the currently active role name.
• hideQuickResponseMessages() - Use this method to hide the quick text responses or email templates in the Notes Editor. For example, hideQuickResponseMessages(["c37ce2afe3e24a178bf6d558353cd05a","56fe26ccbd4945a184f6b0dd85a2d548"]); where c37ce2afe3e24a178bf6d558353cd05a can be the ID of the text response or the email template.

Methods Deprecated in the Revamped UI

The following method is deprecated in the revamped UI:

• hideClaimAndAssignButtons(['assignOwnerShipButton','assignTeamOwnerShipButton','claimOwnerShipButton']);

This is deprecated as the ownership details are included in a single place in the new UI, and is now part of the People menu in the record details.

Considerations for Existing Custom Script Methods

For Form Scripts

1. hideActionsMenuItems(['assignOwnerShipButton','assignTeamOwnerShipButton']);

• In the new UI, we show the ownership change option in instead of the Actions menu.

When you click the Change link in the new UI and provide any input, the application searches in the "Users" and "Teams" objects.

• If we hide "assignOwnerShipButton", no search is performed in the users list.
• If we hide "assignTeamOwnerShipButton", no search is performed in the teams list.
• If we hide "claimOwnerShipButton", the Assign to me option is not visible.

Note: If we hide the above three options from form script, the Change link does not appear on the UI.

The following screenshot provides details of the Action menu described here: