Page History

const formObject = new SimpleForm(s_form.table, s_form.sysId);

s_form.addErrorMessage('Need more information');

s_form.addInfoMessage('Record successfully created', 1000);

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

const states = ['-1', '0', '2', '5'];
s_form.clearOptions('state');
states.forEach(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": "10",
    "Email": "20",
    "Self-service": "30"
  };
const choicesArray = Object.keys(choices);
s_form.clearOptions('contact_type');
choicesArray.forEach((choiceValue) => {
  s_form.addOption('contact_type', choices[choiceValue]);
});

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

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

if (s_form.fieldHasChangesisFieldChanged('state') && s_form.getValue('state') != 'new') {
    return false;
}

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 will include such fields in the array. That is, it is not necessary that the change is made by a user, it can be done by a script.

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

if (s_form.getValue('name').match(/[\/|_*]/g)) {
  s_form.addErrorMessage(`Field "${s_form.getLabelOf('name')}" contains invalid characters.`);
}

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

if (!!s_form.getValue('phone').match(/[^\+\s\d\(\)\-]/g)) {
    s_form.addErrorMessage(`Field "${s_form.getREMLabelOf('phone')}" contains invalid characters.`);
}

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

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

if (['article', 'model'].includes(s_form.getTableName())) {
    s_form.setSectionMandatory('Review', true);
} else {
    s_form.setSectionMandatory('Review', false);
}

const sysId = s_form.getUniqueValue();
const currentRecord = new SimpleRecord(s_form.table);
currentRecord.get(sysId, ()=> {
  if (currentRecord.type == 'unavailable') {
    return false; // abort form submit
  }
});

IsDisplayValue 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.

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 no available`);

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

if (s_form.hasChangesisChanged()) {
    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 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.

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

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

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().finally(__resolveServerResponse);

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

const mandatoryColumn =
  (scriptType == 'onChange' || scriptType == 'onCellEdit');
s_form.setMandatory('column_id', mandatoryColumn);

if (!!s_form.getValue('any_tables')){
  s_form.setReadOnly('table_id', true);
  s_form.setMandatory('table_id', false);
  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);
}

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

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

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

IsDisplayValue parameter has been maintained in earlier versions but will be deprecated after version 1.1. Avoid using it in your scripts.

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 performing, use the await keyword like 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 mandatory override described in the Column Overriding article) will lead to validation errors after the form submitting 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');