Page History

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)

Use this method to return a 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)

Use this method to get a displayable REM attribute value.

Find the values represented in the client scripts according to the field types in the table.

Parameter:

Return:

Example:

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

getREMLabelOf(fieldName)

The Use this method returns to get a label text value of a REM attribute.

Parameter(s):

Return:

Example:

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

s_form.

getREMValue(fieldName)

This Use this method gets to get a displayable REM attribute  attribute value.

Find the values represented in the client scripts according to the field types in the table.

ParameterParameter(s):

Return:

Example:

if (s_form.addErrorMessage(`Service "${getREMValue('model')) {
  s_form.getREMDisplayValuehideFieldMsg('servicemodel')}" is not available`);

s_form.getREMLabelOf(fieldName)

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

Parameter(s):

Name

Type

Mandatory

Default Value

;
}

s_form.getSections()

Use this method to get an array of sections.

Return:

Example:

const FIELD_LABELsectionNames = s_form.getSections().getREMLabelOf('phone'map(section => section.name);
if (sectionNames.length) {
    s_form.addErrorMessageaddInfoMessage(`Field "${FIELD_LABEL}" contains invalid characters.`);`You can move between ${sectionNames.join(', ')}` sections);
}

s_form.

getSectionNames(

)

This method gets a REM attribute value.

Parameter(s):

Name

Type

Mandatory

Default Value

Use this method return an array that contains the names of all sections, visible and hidden.

Return:

Example:

ifconst sectionNames = (s_form.getREMValuegetSectionNames('model'))
if (sectionNames.length) {
    s_form.hideFieldMsg('model');
}

s_form.getSections()

Use this method to get an array of sections.

Return:

s_form.getSectionNames()

This method allows returning an array, which contains the names of all sections, visible and hidden.

Return:

addInfoMessage(`You can move between ${sectionNames.join(', ')}` sections);
}

s_form.getTableName()

This Use this method returns to return a table name that the specified record relates to.

Return:

Example:

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

s_form.getUniqueValue()

This Use this method returns to return a 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 Use this method returns to return the database value of the specified fieldthe specified field .

Find the values represented in the client scripts according to the field types in the table.

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 Use this method returns to return the displayed value of the field.

Find the values represented in the client scripts according to the field types in the table.

Parameter(s):

Return:

Example:

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

s_form.goBack()

This method allows performing Use this method to perform a redirection to the previous page; if . If it is not possible, the redirection leads to the list view of the current instance, for example, to a list of incidents out of a from an 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 Use this method to get information whether a record form has been changed.

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 Use this method to hide 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()

Use this method to hide all related lists on the form.

Return:

Example:

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

s_form.isMandatory(fieldName)

Use this method to check if the specified field is mandatory.

Parameter(s):

Return:

Example:

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

s_form.hideRelatedList(relListTitle)

Use this method to specify a related list you need to hide.

Parameter(s):

Return:

Example:

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

s_form.isNewRecord()

If the record has never been saved, this method returns 'true'; otherwise, it returns 'false'Use this method to find out if the record is new.

Return:

Example:

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

s_form.isReadonly(fieldName)

Use this method to check if verify whether a user can edit the specified field via the interface or the 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 Use this method defines to define if a specified section is visible or not.

Parameter(s):

Return:

Example:

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

s_form.isValid()

Use this method 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)

Use this method 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 Use this method to reload all UI actions  on the form and recalculates the server condition reverifies conditions to display a button that are defined for these UI actions without refreshing the page.

Return:

Example:

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

s_form.removeOption(fieldName, choiceValue)

Use this method to specify and delete an option from the choice list.

Parameter(s)Parameters:

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 Use this method saves to save a 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 Use this method sets to set a 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)

Use this method to change a specified field to a mandatory field, i.e., it that is 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)

Use this method 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 Use this method to set a plain text value of a 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 Use this method to make a field specified by a REM attribute mandatory.

Parameter(s)Parameters:

Return:

Example:

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

s_form.setREMReadOnly(fieldName, readOnly)

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

Parameter(s):

Return:

Example:

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

s_form.setREMValue(fieldName, databaseValue)

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

Parameter(s)Parameters:

Return:

Example:

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

s_form.setREMVisible(fieldName, display)

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

Parameter(s)Parameters:

Return:

Example:

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

s_form.setSectionDisplay(sectionName, display)

Use this method to specify the section you want need to hidedisplay.

Parameter(s):

Return:

Example:

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

s_form.setValue(fieldName, databaseValue)

This Use this method sets to set a field value. 

Parameter(s)Parameters:

Return:

Example:

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)

Use this method to manage displaying of the display of the fields that have been added to the form through the Form Layout. You can hide or show the fields. The hidden field state is similar to being removed from the form view.

Parameter(s)Parameters:

Return:

Example:

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

s_form.showFieldMsg(fieldName, message, type) 

Anchor
fieldmsg fieldmsg

Use this method to display a message containing 'info', 'error', or 'warning' value informantional and warning messages, and messages containing error description under the specified form field. 

Parameter(s)Parameters:

Return:

Example:

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.showRelatedLists()

This method allows displaying all Use this method to display all the lists related to the form.

Return:

Example:

s_form.showRelatedLists();

s_form.showRelatedList(listTitle)

This method allows displaying specified lists Use this method to display a specified list related to the form.

Parameter(s):

Return:

Example:

s_form.showRelatedList('UI Action');

s_form.submit()

This method allows submitting Use this method to submit a record form.

Return:

Example:

s_form.submit();

Deprecated methods

s_form.fieldHasChanges(fieldName)

Use this method to check if This method checks whether the specified field has been changed or not.

Parameter(s):

Return:

Example:

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

s_form.hasChanges()

This method allows getting gets t information whether a record form has been changed or not.

Return:

Example:

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