Page History

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();
}

s_form.addErrorMessage('Please enter a valid email address using the following format: joe@example.com');

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

s_form.addSuccessMessage('Record was successfully added!', 3000);

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

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

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

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

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

const choices = [
  "Phone",
  "Email",
  "Self-service"
];

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

if (!s_form.getValue('sprint')) {
  s_form.clearValue('points');
}

If there is a client script running on the specified form and changing it, this method returns 'true'.  Both a user and a script can initiate the changes.

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

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");

If there is a client script running on this form and changing it, the getChanges() method must include such fields in the array. Both a user and a script can initiate the changes.

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

const FIELD_LABEL = s_form.getLabelOf('username');
s_form.addErrorMessage(`Field "${FIELD_LABEL}" contains invalid characters.`);

s_form.addErrorMessage(`Service "${s_form.getREMDisplayValue('service')}" is not available`);

const FIELD_LABEL = s_form.getREMLabelOf('phone');
s_form.addErrorMessage(`Field "${FIELD_LABEL}" contains invalid characters.`);

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

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

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

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);
  }
});

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.addInfoMessage(`Service "${s_form.getDisplayValue('service')}" is not available`);

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

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

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

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

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

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

if (s_form.isNewRecord()) {
  await s_form.setValue('state', 'new');
  s_form.setReadOnly('state', true);
}

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

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

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

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

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

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

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');
    }
  });
}

const sysId = await s_form.save().finally(__resolveServerResponse;
await s_user.setPreference(preferenceApplicationName, packApplicationId);
await s_user.setPreference(preferenceLocalPackName, sysId);
await s_pref.refresh();

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");
}

const scriptType = s_form.getValue('type');
const mandatoryColumn = ['onChange', 'onCellEdit'].includes(scriptType);
s_form.setVisible('column_id', mandatoryColumn);
s_form.setMandatory('column_id', mandatoryColumn);

if (s_form.getValue('any_tables')){
  s_form.setMandatory('table_id', false);
  s_form.setReadOnly('table_id', true);
  s_form.setVisible('table_id', false);
}

if (s_form.getTableName() == 'user') {
  s_form.setREMLabelOf('email', 'Email');
} else {
  s_form.setREMLabelOf('email', 'Personal Email');
}

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

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

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

await s_form.setREMValue('state', 'new');
s_form.save();

s_form.setREMVisible('additional_info', !s_form.isNewRecord());

if (s_form.getValue('state') == '7') { // Completed
  s_form.setSectionDisplay('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);
}

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

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

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);
    })
  });

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

if (!s_form.isNewRecord()) {
  s_form.setVisible('subject', true);
  s_form.setVisible('reason', false);
}

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

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

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

s_form.showRelatedList('UI Action');

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

If there is a client script running on the specified form and changing it, the s_form.fieldHasChanges(fieldname) method returns 'true'. Both a user and a script can make changes to the form.

console.log(s_form.fieldHasChanges('state'));

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

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