Page History

The SimpleForm API This class provides methods for customizing 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 . For example, changing values in of the fields or clear clearing the fields).

s_form.addErrorMessage(message)

This method displays the error message at the top of the form.

Parameter(s):

SimpleForm(table, sys_id)

Instantiates a new SimpleForm object.

Return:

Example:

window.s_widget_form.addErrorMessage('Need more information');

s_form.addInfoMessage(message, duration)

This method adds an informational message to the top of the form. The message is expirable, its expire period should be specified by $duration parameter.

Parameter(s):

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:

Example:

s_form.addInfoMessage('Record successfully created');

s_form.addOption(fieldName, choiceValue, choiceLabel)

This method adds a choice option to the end of the choice list field.

Parameter(s):

Global variable usage

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

s_form.addErrorMessage(message)

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

Parameter(s):

Return:

Example:

s_form.addOptionaddErrorMessage('priority' , 'low' , 'Low'Please enter a valid email address using the following format: joe@example.com');

s_form.

addInfoMessage(message, durationMilliseconds)

This method removes informational messages or error messages in the top of the form.

Return:

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):

s_form.clearOptions(fieldName)

This method allows removing all options from the choice list.

Parameter(s):

Return:

Example:

s_form.clearOptionsaddInfoMessage('contact_type'Link copied to clipboard', 2000);

s_form.

addSuccessMessage(

message, durationMilliseconds)

This method allows removing any value from any fielddisplays 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):

Return:

Example:

s_form.getValueaddSuccessMessage('sprint') === null ? s_form.clearValue('points') : falseRecord was successfully added!', 3000);

s_form.

addWarningMessage(

message, durationMilliseconds)

This method returns the text value of the field labeldisplays 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):

Return:

Example:

s_form.getLabelOf('assigned_user');addWarningMessage('This record has been modified by another user', 3000);

s_form.

addOption(fieldName, choiceValue)

This method allows returning the array of the sections.

Return:

s_form.getSectionNames()

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.

Parameter(s):

Return:

s_form.getUniqueValue()

Returns the unique ID (sys_id) of the record displayed on the form.

Return:

Example:

const states = ['-1', '0', '2', '5'];

s_form.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:

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):

Return:

Example:

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 'false' if it is unable to clear the value of the field 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 'true', then the field will be cleared.

Parameter(s):

Return:

Example:

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.

Parameter(s):

Return:

Example:

if (s_form.isFieldChanged('state') && s_form.getValue('state') != 'new') {
  return false; // abort form submit
}

s_form.formId

This class property returns 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:

Example:

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.

Return:

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):

Return:

Example:

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):

Return:

Example:

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):

Return:

Example:

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):

Return:

Example:

if (s_form.getREMValue('model')) {
  s_form.hideFieldMsg('model');
}

s_form.getSections()

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

Return:

s_form.getSectionNames()

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

Return:

s_form.getTableName()

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

Return:

const TABLE_NAME = s_form.getTableName();
console.log(TABLE_NAME);

s_form.getUniqueValue()

This method returns the unique record ID (sys_id).

Return:

Example:

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.

Parameter(s):

Return:

Example:

const callerId = s_form.getValue('caller_id');
if (!callerId) {
  const callerRecord = new SimpleRecord('employee');
  callerRecord.get(callerId, ()=> {
    if (callerRecord.sys_id &&
      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):

Return:

Example:

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:

Example:

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.

Return:

Example:

if (s_form.isChanged()) {
  s_form.save().then(() => s_form.goBack());
} else {
  s_form.goBack();
}

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):

Return:

Example:

if (s_form.getValue('state')) {
  s_form.hideFieldMsg('state');
}

s_form.hideRelatedLists()

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

Return:

Example:

if (s_form.getValue('type') == 'internal') {
  s_form.hideRelatedLists();
}

s_form.isMandatory(fieldName)

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

Parameter(s):

Return:

Example:

if (s_form.isMandatory('state') && !s_form.getValue('state')) {
  s_form.addInfoMessage('State cannot be None');
}

s_form.hideRelatedList(relListTitle)

Using this method, you can specify a related list you want to hide.

Parameter(s):

Return:

Example:

if (s_form.getValue('type') == 'external') {
  s_form.hideRelatedList('Customer');
}

s_form.isNewRecord()

If the record was never saved, this method returns 'true'; otherwise, it returns 'false'.

Return:

Example:

if (s_form.isNewRecord()) {
  await s_form.setValue('state', 'new');
  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):

Return:

Example:

if (!s_form.isReadonly('state')) {
  await s_form.setValue('state', 'new');
}

s_form.isSectionVisible(sectionName)

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

Parameter(s):

Return:

if (s_form.isSectionVisible('Instructions')) {
  s_form.addInfoMessage('Check out the "Instructions" section', 5000);
}

s_form.isValid()

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

Return:

Example:

if (!s_form.isValid()) {
  s_form.addErrorMessage('This form is invalid');
}

s_form.isVisible(fieldName)

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

Parameter(s):

Return:

Example:

if (s_form.isVisible('state')) {
  s_form.setSectionDisplay('Controls', true);
}

s_form.refreshUiActions()

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

Return:

const stateValue = s_form.getValue('state');
if (stateValue == 'in-progress') {
    s_form.refreshUiActions();
}

s_form.removeOption(fieldName, choiceValue)

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

Parameter(s):

Return:

Example:

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.

Return:

Example:

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):

Return:

Example:

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):

Return:

Example:

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.

Parameter(s):

Return:

Example:

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):

Return:

Example:

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 making the field specified by REM attribute mandatory.

Parameter(s):

Return:

Example:

const isDeliveryFilled = !!s_form.getValue('delivery');
s_form.setREMMandatory('phone', isDeliveryFilled);

s_form.setREMReadOnly(fieldName, readOnly)

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

Parameter(s):

s_form.getValue(fieldName, isDisplayValue)

Returns the value of the specified field.

Parameter(s):

Return:

Example:

if (s_form.isNewRecord()) {
  s_form.getValuesetREMValue('caller_id');state', 'new');
  s_form.setREMReadOnly('state', true);
}

s_form.

setREMValue(fieldName, databaseValue)

This method allows hiding all related lists on the form.

Return:

setting the value of the REM attribute label.

s_form.hideRelatedList(relListTitle)

Parameter(s):

Return:

Example:

s_form.hideRelatedList('Note');

s_form.isNewRecord()

Return:

Example:

await s_form.isNewRecord() ? alertsetREMValue('New recordstate'), : alert('Not new record'');
s_form.save();

s_form.

setREMVisible(

fieldName, display)

This method returns TRUE if the section is visible; otherwise, it returns FALSEallows defining visibility of the field specified by REM attribute.

Parameter(s):

Return:

Example:

s_form.isSectionVisiblesetREMVisible('Notesadditional_info') ? alert('Visible') : alert('Not visible')', !s_form.isNewRecord());

s_form.

setSectionDisplay(

sectionName,

display)

This method removes the selected option from the listUsing this method, you can specify the section you want to hide.

Parameter(s):

Return:

Example:

if (s_form.removeOptiongetValue('prioritystate') ,== 'low7'); { // Completed
  s_form.

This method saves the record without going away (just updating).

Return:

setSectionDisplay('Closure Information', true);
  s_form.

This method sets the text value of the field label.

Parameter(s):

Return:

Example:

s_form.getLabelOf('assigned_user', 'Assigned User');

s_form.setMandatory(fieldName, mandatory)

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.setValue(fieldName, databaseValue)

This method sets the field value. 

Parameter(s):

Return:

Example:

await s_form.setValue('state', '7'); // Completed
await s_form.setValue('closure_notes', articleBodies.join('\n'));
await s_form.isNewRecord() ? s_form.setMandatory('subject' , true) : s_form.setMandatory('subject' , false);

s_form.setReadOnly(fieldName, readOnly)

This method allows making the specified field read-only or editable.

Use UI policy instead of this method if possible.

To make a mandatory field read-only, formerly make it non-mandatory using the setMandatory() method.

Parameter(s):

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 manage displaying of the fields that were added to the form through 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.

Example:

s_form.setReadOnly('priority' , true);

s_form.setSectionDisplay(sectionName, display)

This method allows to show or hide a section.

Parameter(s):

Return:

Example:

if (!s_form.isNewRecord()) {
  s_form.setSectionDisplaysetVisible('Notessubject' , 'New Notes'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. 

This method sets the field value.

For reference fields or list fields, three arguments are in use: the value argument sets as a value name and the displayValue argument displays in the field.

For fields of the other types, the value argument uses to display value in the field and sets the value name.

If the form elements contain links to other pages, they can be defined via the link parameter

Parameter(s):

Return:

ExamplesExample:

s_form.showFieldMsg('subject', 'Cannot be empty', 'info');

s_form.showFieldMsg('subject', 'Cannot be empty', 'warningsetValue('caller_id' , 2 , 'System Administrator');

s_form.setValueshowFieldMsg('subject'priority, 'Cannot be empty', 'lowerror');

s_form.

showRelatedLists(

)

This method allows making a field visible or hidden.

If the fieid is hidden, then the space is left blank. This method cannot hide mandatory field without any value.

displaying all lists related to the form.

Return:

s_form.showRelatedList(listTitle)

This method allows displaying the specified lists related to the formUse UI policy instead of this method if possible.

Parameter(s):

Return:

Example:

s_form.isNewRecord() ? s_form.setVisible('chronology' , false) : s_form.setVisible('chronology' , trueshowRelatedList('UI Action');

s_form.

submit(

)

This method displays an informational message or an error message in the specified form field.

Parameter(s):

Return:

Example:

s_form.showFieldMsg('subject' , 'Cannot be empty',  'info');

allows submitting the record form.

Return:

Deprecated methods

s_form.fieldHasChanges(fieldName)

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

Parameter(s):

Return:

getLabelOfsconsole.log(s_form.showFieldMsgfieldHasChanges('subject' , 'Cannot be empty',  'error');
state'));

s_form.

hasChanges()

This method allows displaying all lists related to the form.Return:

getting information whether a record form has been changed or not.

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

Parameter(s):

Return:

s_form.submit()

This method saves the record with navigating away from the form.

Return:

Return:

Example:

if (s_form.hasChanges()) {
  s_form.save().then(() => s_form.goBack());
} else {
  s_form.goBack();
}