Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This class provides methods to configure forms. These methods These methods can only be used on the client side only.

You can also use these methods to configure the dependencies between fields and values. For example, changing values in of the fields or clear clearing the fields.

SimpleForm(table, sys_id)


Instantiates a new SimpleForm object.

NameTypeMandatoryDefault Value
tableStringYN
sys_idStringYN


Code Block
languagejs
themeEclipse
titleSimpleForm
linenumberstrue
window.s_widget_custom.submit = async function () {
  await s_widget.serverUpdate();
  const tableName = s_widget.getFieldValue('table_name');
  const recordId = s_widget.getFieldValue('record_id');

  const builtInForm = new SimpleForm(tableName, recordId);
  
  await builtInForm.save().then(s_form.save());
  s_modal.setShow(false);
  s_go.reloadWindow();
}


Return:

TypeDescription
ObjectThis method returns a form object.

s_form.addErrorMessage(message)

This method displays the error toast message in the bottom right corner.

Parameter(s):

NameTypeMandatoryDefault ValuemessageStringYN

Return:

TypeDescriptionVoidThis method does not return a value.

Global variable usage


Within any record form, you can use predefined global variables.

Variable

Description

currentFieldLabel

Defines a link to a Wrapper object for a field. The variable is used with the getColumnId() method.
For example, window.currentFieldLabel.getColumnId().

One of the usage cases of this variable is the field context menu call. 

Image Added

currentUiAction

Contains an object with an ID of the UI action record. It is used when the context menu is called.

One of the usage cases is receiving information about UI actions when calling the context menu.

Image Added

s_form.addErrorMessage(message)


This method displays the error toast message in the bottom right corner.


Example:

Code Block
languagejs
themeEclipse
titleaddErrorMessage
linenumberstrue
s_form.addErrorMessage('Need more information');

s_form.addInfoMessage(message, durationMilliseconds)

This method displays an informational toast message in the bottom right corner. The message is expirable, its expire period (in milliseconds) should be specified by second parameter.

Parameter(s):

NameTypeMandatoryDefault Value
messageStringYN
durationMillisecondsNumber
YN


Return:

TypeDescription
VoidThis method does not return
a
value.


Example:

Code Block
languagejs
themeEclipse
titleaddInfoMessageaddErrorMessage
linenumberstrue
s_form.addInfoMessageaddErrorMessage('Record successfully created', 1000Please enter a valid email address using the following format: joe@example.com');

s_form.

addOption

addInfoMessage(

fieldName

message,

choiceValue

durationMilliseconds)


This method adds a choice option to the end of the choice list field (if option with passed choiceValue defined for fieldName for current table options set).

Note

Please note that this method is asynchronous; for better performing, use the await keyword like shown in the code example below.

Parameter(s):

displays an informational toast message at the bottom right corner. The message disappears after a certain period of time. Specify this period in milliseconds in the second parameter.


Parameter(s):

NameTypeMandatoryDefault Value
fieldName
messageStringYN
choiceValue
durationMilliseconds
String
Number
Y
NN


Return:

TypeDescription
VoidThis method does not return
a
value.


Example:

const states = ['-1', '0', '2', '5'];
Code Block
languagejs
themeEclipse
titleaddOptionaddInfoMessage
linenumberstrue
s_form.addInfoMessage('Link copied to clipboard', 2000);

s_form.addSuccessMessage(message, durationMilliseconds)


This method displays a message about a successul action in the bottom right corner. The message disappears after a certain period of time. Specify this period in milliseconds in the second parameter.


Parameter(s):

NameTypeMandatoryDefault Value
messageStringYN
durationMillisecondsNumberNN


Return:

TypeDescription
VoidThis method does not return value.


Example:

Code Block
languagejs
themeEclipse
titleaddSuccessMessage
linenumberstrue
s_form.addSuccessMessage('Record was successfully added!', 3000);

s_form.addWarningMessage(message, durationMilliseconds)


This method displays a warning message in the bottom right corner. The message disappears after a certain period of time. Specify this period in milliseconds in the second parameter.

Parameter(s):

NameTypeMandatoryDefault Value
messageStringYN
durationMillisecondsNumberNN


Return:

TypeDescription
VoidThis method does not return value.


Example:

Code Block
languagejs
themeEclipse
titleaddWarningMessage
linenumberstrue
s_form.addWarningMessage('This record has been modified by another user', 3000);

s_form.addOption(fieldName, choiceValue)


This method adds a choice option to the end of the choice list field if option with passed choiceValue defined for fieldName for current table options set.

Note

Please note that this method is asynchronous; for better performance, use the await keyword as shown in the code example below.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
choiceValueStringYN


Return:

TypeDescription
PromiseThis method returns a Promise object.


Example:

Code Block
languagejs
themeEclipse
titleaddOption
linenumberstrue
const states = ['-1', '0', '2', '5'];

s_form.clearOptions('state');
clearOptions('state');
states.forEach(async (stateValue) => {
  await s_form.addOption('state', stateValue);
})

s_form.clearMessages()


This method is used to close all kinds of messages (both informational and error) in the form.


Return:

TypeDescription
VoidThis method does not return a value.


Code Block
languagejs
themeEclipse
titleclearMessages()
linenumberstrue
s_i18n.getMessage('End date time cannot be less than start date time', (response) => {
  s_form.clearMessages();
  s_form.addErrorMessage(response);
});
return false; // abort form submit

s_form.clearOptions(fieldName)


Using this method, you can remove all options from the choice list.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleclearOptions
linenumberstrue
const choices = [
  "Phone",
  "Email",
  "Self-service"
];

s_form.clearOptions('contact_type');
choices.forEach(async (choiceValue) => {
  await s_form.addOption('contact_type', choiceValue);
});

s_form.clearValue(fieldName) 
Anchor
s_form.clearValue
s_form.clearValue


This method is used to clear out any field, i.e., delete its value.

Using this method you can select a value and remove it from the field.

It returns 'truefalse'  if if it is able unable to clear the value from of the field .It returns 'true' in in the following cases:

  • if the column_type is either Boolean or Record Class;.
  • if the column_name is equal to 'sys_id';.
  • if the column_type is Choice and it does not have a default value.

If the method returns 'falsetrue', then the field will not be cleared.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN


Return:

TypeDescription
BooleanThis method returns the boolean value ('true' or 'false') in the cases described above.


Example:

Code Block
languagejs
themeEclipse
titleclearValue
linenumberstrue
if (!s_form.getValue('sprint')) {
  s_form.clearValue('points');
}

s_form.isFieldChanged(fieldName)


This method is used to check if the specified field has been changed or not.


Info

If there is a client script running on the specified form and changing it, this method this method will return 'true'. That is, it It is not necessary that the change is made by a user, the form can be changed by a script.

Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN


Return:

TypeDescription
Boolean

This method returns 'true' if the specified field has been changed; otherwise returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titles_form.isFieldChanged
linenumberstrue
if (s_form.isFieldChanged('state') && s_form.getValue('state') != 'new') {
  return false; // abort form submit
}

s_form.formId


This class property returns the current the current form ID for the current user. The form view ID is an ID of the record in the UI Forms (sys_ui_form) dictionary.

Return:

Type

Description

StringThis method returns the record form view ID (ID of the record in the UI Forms (sys_ui_form) dictionary).


Example:

Code Block
languagejs
themeEclipse
titleformId
linenumberstrue
const url = new URL(`${API_BASE_URL}/export/excel`);
if (typeof s_form !== "undefined") {
  url.searchParams.set('form_id', s_form.formId);
}
window.open(url, "_blank");

s_form.getChanges()


This method is used to retrieve information about changed fields: field name, previous value, current value.

Info

If there is a client script running on this form and changing it, the getChangesthe getChanges() method will include such fields in the array. That It is , it is not necessary that the change is made by a user, it can be done by a script.

Return:

TypeDescription
Array

This method returns an array of objects with field changes. Object contains field name, previous value and the current value.


Code Block
languagejs
themeEclipse
titles_form.getChanges
linenumberstrue
if (s_form.isChanged()) {
  const changedFields = s_form.getChanges();
  let payload = {};
  changedFields.forEach((field) => {
    payload[field.fieldName] = field.currentValue;
  });
  SimpleStorage.setItem('payload', payload);
}


s_form.getLabelOf(fieldName)


The method returns the label text value.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN


Return:

TypeDescription
StringThis method returns a string containing the attribute label value.


Example:

Code Block
languagejs
themeEclipse
titlegetLabelOf
linenumberstrue
const FIELD_LABEL = s_form.getLabelOf('username');
s_form.addErrorMessage(`Field "${FIELD_LABEL}" contains invalid characters.`);

s_form.getREMDisplayValue(fieldName)


This method gets the displayable REM attribute value.


Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN

Return:

Type

Description

StringThis method returns the attribute displayable value.

Example:

Code Block
languagejs
themeEclipse
titlegetREMDisplayValue
s_form.addErrorMessage(`Service "${s_form.getREMDisplayValue('service')}" is not available`);


s_form.getREMLabelOf(fieldName)


This method gets the label text value of the REM attribute.


Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN


Return:

Type

Description

StringThis method returns a string containing the attribute label value.

Example:

Code Block
languagejs
themeEclipse
titlegetREMLabelOf
linenumberstrue
const FIELD_LABEL = s_form.getREMLabelOf('phone');
s_form.addErrorMessage(`Field "${FIELD_LABEL}" contains invalid characters.`);

s_form.getREMValue(fieldName)


This method gets the REM attribute value.

Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN

Return:

Type

Description

StringThis method returns the internal database value of the specified field.

Example:

Code Block
languagejs
themeEclipse
titlegetREMValue
linenumberstrue
if (s_form.getREMValue('model')) {
  s_form.hideFieldMsg('model');
}

s_form.getSections()


Using this method, you can get an array of sections.


Return:

TypeDescription
Array of HTML elementsThe form sections.

s_form.getSectionNames()


This method allows returning an array, which will contain the names of all sections, visible or not.


Return:

TypeDescription
Array of stringsThis method returns an array containing section names.

s_form.getTableName()


This method returns the table name to which the specified record relates.

Note

The method returns the system table name, not the table title. Example:

Table nameitsm_incident
Table titleIncidents


Return:

TypeDescription
StringSystem table name.


Example:
Code Block
languagejs
themeEclipse
titlegetTableName
linenumberstrue
const TABLE_NAME = s_form.getTableName();
console.log(TABLE_NAME);

s_form.getUniqueValue()


This method returns the unique record ID (sys_id).


Return:

TypeDescription
StringThis method returns the record ID; otherwise, returns NULL.


Example:

Code Block
languagejs
themeEclipse
titlegetUniqueValue
linenumberstrue
const TABLE_NAME = s_form.getTableName();
const RECORD_ID = s_form.getUniqueValue();
const currentRecord = new SimpleRecord(TABLE_NAME);
currentRecord.get(RECORD_ID, ()=> {
  if (currentRecord.sys_id === RECORD_ID) {
    s_form.addInfoMessage(currentRecord.sys_created_at);
  }
});

s_form.getValue(fieldName)


This method returns the database value of the specified field.

WarningIsDisplayValue parameter was maintained in earlier versions but has been deprecated from version 1.1 and no longer valid. Avoid using it in your scripts. To get a displayed value of a field, use the s_form.getDisplayValue method

of the specified field.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN


Return:

TypeDescription
String

This method returns the database value of the specified field.


Example:

Code Block
languagejs
themeEclipse
titlegetValue
linenumberstrue
const callerId = s_form.getValue('caller_id');
if (!callerId) {
  const callerRecord = new SimpleRecord('employee');
  callerRecord.get(callerId, ()=> {
    if (callerRecord.sys_id &&
      callerRecord.personal_schedule) {
    if (callerRecord.sys_id &&  await s_form.setValue('schedule', callerRecord.personal_schedule);
    } else {
      s_form.addInfoMessage('Users schedule is not defined');
      callerRecord.personal_schedule) {
      await s_form.setValue('schedule', callerRecord.personal_schedule);
    } else {
      s_form.addInfoMessage('Users schedule is not defined');
    }
  });
}

s_form.getDisplayValue(fieldName)

This method returns the displayed value of the field.

Parameter(s):

NameTypeMandatoryDefault valuefieldNameStringYN
}
  });
}

s_form.getDisplayValue(fieldName)


This method returns the displayed value of the field.


Parameter(s):

NameTypeMandatoryDefault value
fieldNameStringYN


Return:

TypeDescription
StringThe displayed value of the specified field.


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValue
linenumberstrue
s_form.addInfoMessage(`Service "${s_form.getDisplayValue('service')}" is not available`);

s_form.goBack()


This method allows performing redirect to the previous page; if not possible then redirect to the list view of the current essence, for example, to a list of incidents out of a incident record.


Return:

Type

Description

StringThe displayed value of the specified field
VoidThis method does not return value.


Example:

Code Block
languagejs
themeEclipse
titlegetDisplayValue
linenumberstrue
goBack
linenumberstrue
if (s_form.isChanged()) {
  s_form.addInfoMessage(`Service "${.save().then(() => s_form.getDisplayValuegoBack('service'));
}" else is{
 not available` s_form.goBack();
}


s_form.

goBack

isChanged()


This method allows to perform redirect to the previous page; if not possible then redirect direction is a list view of the current essence (for example, to a list of incidents out of a incident record)get information whether a record form has been changed or not.


Return:

Type

Description

Void
Boolean
This method does not return a value
The method returns 'true' if any changes were made on the record form; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlegoBackisChanged
linenumberstrue
if (s_form.isChanged()) {
  s_form.save().then(() => s_form.goBack());
} else {
  s_form.goBack();
}

s_form.isChanged()

This method allows to get information whether a record form has been changed or not.

}

s_form.hideFieldMsg(fieldName)


This method, as opposed to the s_form.showFieldMsg() method, allows hidding informational or error messages in the specified form field.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN


Return:

TypeDescription
Boolean
Void
The method returns 'true' if any changes were made on the record form; otherwise, it returns 'false'
This method does not return value.


Example:

Code Block
languagejs
themeEclipse
titleisChangedhideFieldMsg
linenumberstrue
if (s_form.isChanged()) {
  s_form.save().then(() => if (s_form.goBackgetValue('state'));
} else {
  s_form.goBackhideFieldMsg('state');
}

s_form.

hideFieldMsg

hideRelatedLists(

fieldName

)

This method, as opposed to the s_form.showFieldMsg() method, allows to hide informational or error messages on the specified form field.

Parameter(s):

NameTypeMandatoryDefault ValuefieldNameStringYN

Using this method, you can hide all related lists on the form.


Return:

TypeDescription
VoidThis method does not return
a
value.


Example:

Code Block
languagejs
themeEclipse
titlehideFieldMsghideRelatedList
linenumberstrue
if (s_form.getValue('statetype') == 'internal') {
  s_form.hideFieldMsghideRelatedLists('state');
}

s_form.

hideRelatedLists

isMandatory(fieldName)

Using this method, you can hide all related lists on the form.


This method is used to check if the specified field is mandatory or not.

Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN

Return:

TypeDescription
Void
BooleanThis method
does not return a value
returns 'true' if the field is mandatory; otherwise returns 'false'.

Example:

Code Block
languagejs
themeEclipse
titlehideRelatedLists_form.isMandatory
linenumberstrue
if (s_form.isMandatory('state') && !s_form.getValue('typestate') == 'internal') {
  s_form.hideRelatedLists(addInfoMessage('State cannot be None');
}

s_form.

isMandatory

hideRelatedList(

fieldName

relListTitle)


This method is used to check if the specified field is mandatory or notUsing this method, you can specify a related list you want to hide.


Parameter(s):

NameTypeMandatoryDefault Value
fieldName
relListTitleStringYN


Return:

TypeDescription
Boolean
VoidThis method
returns 'true' if the field is mandatory; otherwise returns 'false'
does not return value.


Example:

Code Block
languagejs
themeEclipse
titles_form.isMandatoryhideRelatedList
linenumberstrue
if (if (s_form.isMandatory('state') && !s_form.getValue('statetype') == 'external') {
  s_form.addInfoMessagehideRelatedList('State cannot be NoneCustomer');
}

s_form.

hideRelatedList

isNewRecord(

relListTitle

)


Using If the record was never saved, this method , you can specify a related list you want to hide.

Parameter(s):

NameTypeMandatoryDefault ValuerelListTitleStringYN

returns 'true'; otherwise, it returns 'false'.


Return:

TypeDescription
VoidThis method does not return a value
BooleanIf the record was never saved then this method returns 'true'; otherwise, it returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titlehideRelatedListisNewRecord
linenumberstrue
if (s_form.isNewRecord()) {
  await s_form.getValuesetValue('typestate', 'new');
 == 'external') {
  s_form.hideRelatedList('Customer');
}

s_form.isNewRecord()

If the record was never saved, this method returns 'true'; otherwise, it returns 'false'.
 s_form.setReadOnly('state', true);
}

s_form.isReadonly(fieldName)


This method is used to check if the specified field is editable or read-only.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN


Return:

TypeDescription
Boolean
If the record was never saved then this
This method returns 'true'
; otherwise, it
if the field is read-only; otherwise returns 'false'.


Example:

Code Block
languagejs
themeEclipse
titleisNewRecords_from.isReadonly
linenumberstrue
if (!s_form.isNewRecord(isReadonly('state')) {
  await s_form.setValue('state', 'new');
  s_form.setReadOnly('state', true);
}

s_form.

isReadonly

isSectionVisible(

fieldName

sectionName)


This method is used to check if the specified field is editable or read-onlydefines if a specified section is visible or not.


Parameter(s):

NameTypeMandatoryDefault Value
fieldName
sectionName
String
stringYN


Return:

TypeDescription
BooleanThis method returns 'true' if the
field
section is
read-only
visible; otherwise, it returns 'false'.
Example:


Code Block
languagejs
themeEclipse
titles_from.isReadonlygetSectionNames
linenumberstrue
if (!s_form.isReadonlyisSectionVisible('stateInstructions')) {
  await s_form.setValueaddInfoMessage('stateCheck out the "Instructions" section', 'new'5000);
}

s_form.

isSectionVisible

isValid(

sectionName

)


This method defines if a specified section is visible or not.

Parameter(s):

NameTypeMandatoryDefault ValuesectionNamestringYN

is used to check if the specified form is valid or not.


Return:

TypeDescription
BooleanThis method returns 'true' if the
section
form is
visible
valid; otherwise,
it
returns 'false'.


Note

It makes sense to use this method if the form contains fields of the Date, Date/Time and Date/Time Specific types, due the method does not support validation checks for fields of other types.


Example:

Code Block
languagejs
themeEclipse
titlegetSectionNamess_form.isValid
linenumberstrue
if (!s_form.isSectionVisibleisValid('Instructions')) {
  s_form.addInfoMessageaddErrorMessage('CheckThis outform the "Instructions" section', 5000is invalid');
}

s_form.

isValid

isVisible(fieldName)


This method is used to check if the specified form field is valid visible or not.

Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN

Return:

It makes sense to use this method if a form contains fields of the Date, Date/Time and Date/Time Specific types, due the method does not support validation checks for fields of other types
TypeDescription
BooleanThis The method returns 'true' if the form is valid; otherwise, returns 'false'.
Note
the field is visible; otherwise returns 'false'.

Example:

Code Block
languagejs
themeEclipse
titles_form.isValidisVisible
linenumberstrue
if (!s_form.isValidisVisible('state')) {
  s_form.addErrorMessagesetSectionDisplay('Controls'This form is invalid', true);
}

s_form.

isVisible

refreshUiActions(

fieldName

)


This method is used to check if the specified field is visible or not.

Parameter(s):

NameTypeMandatoryDefault ValuefieldNameStringYN

reloads all UI actions on the form and recalculates the server condition defined for these UI actions without refreshing the page.

Return:

Boolean
TypeDescription
VoidThe method returns 'true' if the field is visible; otherwise returns 'false'.

Example:

This method does not return a value.


Code Block
languagejs
themeEclipse
titles_form.isVisiblerefreshUiActions()
linenumberstrue
ifconst stateValue = (s_form.isVisiblegetValue('state');
if (stateValue == 'in-progress') {
    s_form.setSectionDisplay('Controls', truerefreshUiActions();
}


s_form.removeOption(fieldName, choiceValue)


Using this method, you can specify and delete an option from the list.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
choiceValueStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleremoveOption
linenumberstrue
const serviceId = s_form.getValue('service');
if (serviceId) {
  const service = new SimpleRecord('sys_cmdb_ci_service');
  service.get(serviceId, ()=> {
    if (service.business_criticality > '1') {
      s_form.removeOption('impact', 'low');
      s_form.removeOption('urgency', 'low');
    }
  });
}


s_form.save()


This method saves the record without leaving its form (just updating).


Return:

TypeDescription
ObjectStringThis method returns a promise containing specific datathe ID of the saved record.


Example:

Code Block
languagejs
themeEclipse
titlesave()
linenumberstrue
const sysId = await s_form.save().finally(__resolveServerResponse);
await s_user.setPreference(preferenceApplicationName, packApplicationId);
await s_user.setPreference(preferenceLocalPackName, sysId);
await s_pref.refresh();


s_form.setLabelOf(fieldName, value)


This method sets the text value of the field label.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
valueStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetLabelOf
linenumberstrue
if (s_form.getTableName() == "employee") {  
  s_form.setLabelOf("email", "Personal Email");
  s_form.setLabelOf("manager.email", "Manager's Email");
} else {
  s_form.setLabelOf("email", "Email");
}


s_form.setMandatory(fieldName, mandatory)


This method is used to change a specified field to a mandatory field, i.e., it cannot be null.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
mandatoryBooleanYNNtrue


Return:

TypeDescription
VoidThis method does not return a value
Boolean

This method returns 'true' if its execution has been successful; otherwise, it returns 'false'.

This method returns false in the following cases:

  • If a field is read-only and does not contain any value.
  • If a field is mandatory, it is impossible to clear the Mandatory checkbox with the s_form.setMandatory('some_field', false) method.



Example:

Code Block
languagejs
themeEclipse
titlesetMandatory
linenumberstrue
const scriptType = s_form.getValue('type');
const mandatoryColumn = ['onChange', 'onCellEdit'].includes(scriptType);
s_form.setVisible('column_id', mandatoryColumn);
s_form.setMandatory('column_id', mandatoryColumn);

s_form.setReadOnly(fieldName, readOnly)

This method is used to change a specified field to read-only or editable.

)


This method is used to change a specified field to read-only or editableIf an empty field is mandatory, it cannot be set to read-only. Apply the s_form.setMandatory() method to the field first.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
readOnlyBooleanYNNtrue


Return:

TypeDescription
VoidThis method does not return a value
Boolean

This method returns 'true' if its execution has been successful; otherwise, it returns 'false'.

This method returns false in the following cases:

  • If a field is read-only, it is impossible to clear the Read Only checkbox with the s_form.setReadOnly('some_field', false) method.
  • If a mandatory field is empty and read-only.

Example:

Code Block
languagejs
themeEclipse
titlesetReadOnly
linenumberstrue
if (s_form.getValue('any_tables')){
  s_form.setMandatory('table_id', false);
  s_form.setReadOnly('table_id', true);
  s_form.setVisible('table_id', false);
}

s_form.setREMLabelOf(fieldName, value)


This message sets the plain text value of the REM attribute label.


Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN
valueStringYN


Return:

Type

Description

StringThis method does not return a returns the set value.


Example:

Code Block
languagejs
themeEclipse
titlesetREMLabelOf
linenumberstrue
if (s_form.getTableName() == 'user') {
  s_form.setREMLabelOf('email', 'Email');
} else {
  s_form.setREMLabelOf('email', 'Personal Email');
}


s_form.setREMMandatory(fieldName, mandatory)


This method allows to make a making the field specified by REM attribute mandatory.


Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN
mandatoryBooleanY'true'


Return:

Type

Description

Boolean

This method returns 'true' if its execution has been successful; otherwise, it returns 'false'.

This method returns

'true' if its execution has been successful; otherwise, it returns 'false'

false in the following cases:

  • If a field is read-only and does not contain any value.
  • If a field is mandatory, it is impossible to clear the Mandatory checkbox with the s_form.setMandatory('some_field', false) method.


Example:

Code Block
languagejs
themeEclipse
titlesetREMMandatory
linenumberstrue
const isDeliveryFilled = !!s_form.getValue('delivery');
s_form.setREMMandatory('phone', isDeliveryFilled);


s_form.setREMReadOnly(fieldName, readOnly)


This method allows to make a making the field specified by REM attribute read-only.


Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN
readOnlyBooleanY'true'


Return:

Type

Description

'true'

Return:

Boolean

This method returns 'true' if its execution has been successful; otherwise, it returns 'false'.

This method returns false in the following cases:

  • If a mandatory field is empty and set to read-only.
  • If a field is read-only, it is impossible to clear the Read Only checkbox with the s_form.setReadOnly('some_field', false) method

Type

Description

BooleanThis method returns 'true' if its execution has been successful; otherwise, it returns 'false'
  • .

Example:

Code Block
languagejs
themeEclipse
titlesetREMReadOnly
linenumberstrue
if (s_form.isNewRecord()) {
  s_form.setREMValue('state', 'new');
  s_form.setREMReadOnly('state', true);
}

s_form.setREMValue(fieldName, databaseValue)


This method allows to set a setting the value of the REM attribute label.

Note

Please note that this method is asynchronous; for better performance, use the await keyword as shown in the code example below.

Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN
databaseValueObjectAnyYN


Return:

Type

Description

VoidThis method does not return a value.

Example:

Code Block
languagejs
themeEclipse
titlesetREMValue
linenumberstruetrue
awaitif (s_form.isNewRecord()) {
  s_form.setREMValue('state', 'new');
}s_form.save();


s_form.setREMVisible(fieldName, display)


This method allows to define defining visibility of the field specified by REM attribute.


Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN
displayBooleanYN


Return:

Type

Description

VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetREMVisible
s_form.setREMVisible('additional_info', !s_form.isNewRecord());

s_form.setSectionDisplay(sectionName, display)


Using this method, you can specify a the section you want to hide.


Parameter(s):

NameTypeMandatoryDefault Value
sectionNameStringYN
displayBooleanYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetSectionDisplay
linenumberstrue
if (s_form.getValue('state') == '7') { // Completed
  s_form.setSectionDisplay('Closure Information', true);
  s_form.setSectionMandatory('Closure Information', true);
  s_form.setMandatory('closure_code', true);
  s_form.setMandatory('closure_notes', true);
} else {
  s_form.setMandatory('closure_code', false);
  s_form.setMandatory('closure_notes', false);
  s_form.setSectionDisplay('Closure Information', false);
  s_form.setSectionMandatory('Closure Information', false);
}

s_form.setValue(fieldName, databaseValue)


This method sets the field value. 


Note

Use s_form.clearValue() method for field clearing instead of setting an empty string value.

Also please note that this method is asynchronous; for better performingperformance, use the await keyword like as shown in the code example below.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
databaseValueStringYN


Return:

TypeDescription
VoidThis method returns a Promise object.


Example:

Code Block
languagejs
themeEclipse
titlesetValue
linenumberstrue
await s_form.setValue('state', '7'); // Completed
await s_form.setValue('closure_notes', articleBodies.join('\n'));
await s_form.setValue('closure_code', '1'); // Solved 1st Level
s_form.save()
  .then(() => {
    s_i18n.getMessage(`The typical solution is applied`, (e) => {
      s_form.addInfoMessage(e);
    })
  });

s_form.setVisible(fieldName, display)


This method allows to manage displaying of the fields that were added to the form through the the Form Layout. With this method, you can hide or show the field. The hidden field state is similar as if this field has been removed from the form view.

Note

Hiding a field for which the mandatory attribute is set on a column level (including the mandatory override described in the Column Overriding article article) will lead to validation errors after the form submitting is submitted from the client-side.


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
displayBooleanYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titlesetVisible
linenumberstrue
if (!s_form.isNewRecord()) {
  s_form.setVisible('subject', true);
  s_form.setVisible('reason', false);
}

s_form.showFieldMsg(fieldName, message, type)


This method is used to display a message containing 'info', 'error', or 'warning' value under the specified form field. 


Parameter(s):

NameTypeMandatoryDefault Value
fieldNameStringYN
messageStringYN
typeStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleshowFieldMsg
linenumberstrue
s_form.showFieldMsg('subject', 'Cannot be empty', 'info');


Code Block
languagejs
themeEclipse
titleshowFieldMsg
linenumberstrue
s_form.showFieldMsg('subject', 'Cannot be empty', 'warning');


Code Block
languagejs
themeEclipse
titleshowFieldMsg
linenumberstrue
s_form.showFieldMsg('subject', 'Cannot be empty', 'error');

s_form.showRelatedLists()


This method allows displaying all lists related to the form.


Return:

TypeDescription
VoidThis method does not return a value.

s_form.showRelatedList(listTitle)


This method allows displaying the specified lists related to the form.


Parameter(s):

NameTypeMandatoryDefault Value

listTitle

StringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleshowRelatedList
linenumberstrue
s_form.showRelatedList('UI Action');

s_form.submit()


This method allows to submit submitting the record form.


Return:

TypeDescription
VoidThis method does not return a value.


Deprecated methods


This subsection contains methods that are not recommended to use in application design. They were are deprecated as the platform evolves; new methods are developed instead every of each of them.

s_form.fieldHasChanges(fieldName)


This method is used to check if the specified field has been changed or not.

Warning

This method is deprecated and not recommended to use. Use the s_form.isFieldChanged(fieldName) method instead.


Info

If there is a client script running on the specified form and changing it, the s_form.fieldHasChanges(fieldname) method returns 'true'. That is, it is not necessary that the change is made by a user, the form can be changed by a script.

Parameter(s):

Name

Type

Mandatory

Default Value

fieldNameStringYN

Return:

Type

Description

Boolean

This method returns 'true' if the specified field has been changed; otherwise, it returns 'false'.


Code Block
languagejs
themeEclipse
titlefieldHasChanges
linenumberstrue
console.log(s_form.fieldHasChanges('state'));

s_form.hasChanges()


This method allows to get getting information whether a record form has been changed or not.

Warning

This method is deprecated and not recommended to use. Use the s_form.isChanged() method instead.


Return:

Type

Description

BooleanThe method returns 'true' if any changes were made on the record form; otherwise, it returns 'false'.

Example:

Code Block
languagejs
themeEclipse
titlehasChanges
linenumberstrue
if (s_form.hasChanges()) {
  s_form.save().then(() => s_form.goBack());
} else {
  s_form.goBack();
}


Table of Contents
absoluteUrltrue