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.
Name | Type | Mandatory | Default Value |
---|---|---|---|
table | String | Y | N |
sys_id | String | Y | N |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const formObject = new SimpleForm(s_form.table, s_form.sysId); |
Return:
s_form.addErrorMessage(message)
This method displays the error toast message in the bottom right corner.
Parameter(s):
Return:
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();
} |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Return:
Type | Description |
---|
Object | This method |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
s_form.addInfoMessage('Record successfully created', 1000); |
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).
returns a form object. |
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. One of the usage cases of this variable is the field context menu call.
|
currentUiAction |
s_form.addErrorMessage(message)
This method displays the error toast message in the bottom right corner.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
message | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return |
value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const states = ['-1', '0', '2', '5']; s_form.clearOptionsaddErrorMessage('state'); states.forEach(stateValue => { await s_form.addOption('state', stateValue); }Please enter a valid email address using the following format: joe@example.com'); |
s_form.
clearMessagesaddInfoMessage(message, durationMilliseconds)
This method is used to close all kinds of messages (both informational and error) in the form.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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
message | String | Y | N |
durationMilliseconds | Number | N | N |
Return:
Type | Description |
---|---|
Void | This method does not return |
value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
s_i18nform.getMessageaddInfoMessage('EndLink datecopied time cannot be less than start date time', (response) => { s_form.clearMessages(); s_form.addErrorMessage(response); return false; // abort form submit });to clipboard', 2000); |
s_form.
clearOptionsaddSuccessMessage(
fieldNamemessage, durationMilliseconds)
Using this method, you can remove all options from the choice listThis 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):
Name | Type | Mandatory | Default Value |
---|
message | String | Y | N |
durationMilliseconds | Number | N | N |
Return:
Type | Description |
---|---|
Void | This method does not return |
value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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]);
}); |
s_form.clearValue(fieldName)
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 TRUE if it is able to clear the value from the field.
It returns FALSE 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 FALSE, then the field. will not be cleared.
Parameter(s):
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
message | String | Y | N |
durationMilliseconds | Number | N | N |
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
choiceValue | |||
Name | Type | Mandatory | Default Value |
fieldName | String | Y | N |
Return:
Type | Description |
---|
Promise | This method returns |
a Promise object. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!s_form.getValue('sprint')) const states = ['-1', '0', '2', '5']; s_form.clearOptions('state'); states.forEach(async (stateValue) => { await s_form.clearValueaddOption('pointsstate', stateValue); }) |
s_form.
formIdclearMessages()
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.method is used to close all kinds of messages (both informational and error) in the form.
Return:Return:
Type | Description |
---|
Example:
Void | This method does not return value. |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const url = new URL(`${API_BASE_URL}/export/excel`); if (typeof s_form !== "undefined")s_i18n.getMessage('End date time cannot be less than start date time', (response) => { url.searchParams.set('form_id',s_form.clearMessages(); s_form.formIdaddErrorMessage(response); } window.open(url, "_blank");); return false; // abort form submit |
s_form.
getLabelOfclearOptions(fieldName)
The method returns the label text valueUsing this method, you can remove all options from the choice list.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (const choices = [ "Phone", "Email", "Self-service" ]; s_form.getValueclearOptions('namecontact_type').match(/[\/|_*]/g)); choices.forEach(async (choiceValue) => { s_form.addErrorMessage(`Field "await s_form.getLabelOfaddOption('name')" contains invalid characters.`contact_type', choiceValue); }); |
s_form.
getREMDisplayValueclearValue(fieldName)
This method gets the displayable REM attribute value.
Parameter(s):
Name
Type
Mandatory
Default Value
Return:
Type
Description
Anchor s_form.clearValue s_form.clearValue
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
Example:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
s_form.addInfoMessage(`Service "${s_form.getREMDisplayValue('service')}" is not available`); |
s_form.getREMLabelOf(fieldName)
This message gets the plain text value of the REM attribute label.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|
Boolean | This method returns |
the boolean value ('true' or 'false') in the cases described above. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!s_form.getValue('name').match(/[\/|_*]/gsprint')) { s_form.addErrorMessage(`Field "s_form.getREMLabelOf('name')" contains invalid characters.`clearValue('points'); } |
s_form.
getREMValueisFieldChanged(fieldName)
This method
gets the attribute value.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 will return 'true'. It is not necessary that the change is made by a user, the form can be changed by a script. |
Parameter(s):
Parameter(s):
Name
Type
Name | Type |
---|
Mandatory | Default Value | ||
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|
Boolean | This method returns |
'true' if the specified field has been changed; otherwise returns 'false'. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!!s_form.getREMValueisFieldChanged('state')) { && s_form.hideFieldMsggetValue('state') != 'new') { return false; // abort form submit } |
s_form.formId
This class property returns the current form
.getSections()Using this method, you can get an array of sectionsID 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 |
---|
s_form.getSectionNames()
This method allows returning an array, which will contain the names of all sections, visible or not.
Return:
String | This method returns the record form view ID (ID of the record in the UI Forms (sys_ui_form) dictionary). |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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 getChanges() method will include such fields in the array. It is not necessary that the change is made by a user, it can be done by a script. |
s_form.getTableName()
This method returns the table name to which the specified record relates.
The method returns system table name, not the table title. Example:
Return:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (['article', 'model'].includes(s_form.getTableName())) {
s_form.setSectionMandatory('Review', true);
} else {
s_form.setSectionMandatory('Review', false);
} |
s_form.getUniqueValue()
This method returns the unique record ID (sys_id).Return:
Type | Description |
---|
Array | This method returns an array of objects with field changes. Object contains field name, previous value and the current value. |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const sysId = if (s_form.getUniqueValueisChanged()); { const currentRecordchangedFields = new SimpleRecord(s_form.tablegetChanges(); currentRecord.get(sysId, () let payload = {}; changedFields.forEach((field) => { if (currentRecord.type payload[field.fieldName] == 'unavailable') { field.currentValue; }); return false; // abort form submit } });SimpleStorage.setItem('payload', payload); } |
s_form.
getValuegetLabelOf(fieldName)
This The method returns the internal (written down to the database) value of the specified field.
Warning |
---|
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. |
Parameter(s):
Return:
This method returns the internal (written down to the database) value of the specified field.
label text value.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|---|
String | This method returns a string containing the attribute label value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default |
---|---|---|---|
Value | |||
fieldName | String | Y | N |
Return:
Type | Description |
---|---|
String |
This method returns the attribute displayable value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
s_form.addInfoMessageaddErrorMessage(`Service "${s_form.getDisplayValuegetREMDisplayValue('service')}" is nonot available`); |
s_form.
goBackgetREMLabelOf(fieldName)
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).gets the label text value of the REM attribute.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|---|
VoidString | This method does not return a returns a string containing the attribute label value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
ifconst (s_form.hasChanges()) { FIELD_LABEL = s_form.savegetREMLabelOf().then(() => 'phone'); s_form.goBack()); } else { s_form.goBack(); }addErrorMessage(`Field "${FIELD_LABEL}" contains invalid characters.`); |
s_form.
hasChangesgetREMValue(fieldName)
This method allows to get information whether a record form has been changed or not.gets the REM attribute value.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|
String |
This method returns |
the database value of the specified field. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.hasChangesgetREMValue('model')) { s_form.savehideFieldMsg().then(() => 'model'); } |
s_form.
goBack()); } else { s_form.goBack(); }getSections()
Using this method, you can get an array of sections.
Return:
Type | Description |
---|---|
Array of HTML elements | The form sections. |
s_form.
hideFieldMsggetSectionNames(
input)
This method , as opposed to the s_form.showFieldMsg() method, allows to hide informational or error messages on the specified form field.
Parameter(s):
allows returning an array, which will contain the names of all sections, visible or not.
Return:
Type | Description |
---|---|
Array of strings | This 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:
|
Return:
Type | Description |
---|
String | System table name. |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!!const TABLE_NAME = s_form.getValuegetTableName('state')) { s_form.hideFieldMsg('state'); }); console.log(TABLE_NAME); |
s_form.
hideRelatedListsgetUniqueValue()
Using this method, you can hide all related lists on the formThis method returns the unique record ID (sys_id).
Return:
Type | Description |
---|
String | This method |
returns the record ID; otherwise, returns NULL. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (const TABLE_NAME = s_form.getValuegetTableName('type') == 'internal') { ; const RECORD_ID = s_form.hideRelatedListsgetUniqueValue(); } |
s_form.hideRelatedList(relListTitle)
Using this method, you can specify a related list you want to hide.
Parameter(s):
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):
Name | Name | Type | Mandatory | Default Value |
---|---|---|---|---|
relListTitlefieldName | String | Y | N |
Return:
Type | Description |
---|
String | This method |
returns the database value of the specified field. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
ifconst callerId = (s_form.getValue('typecaller_id') == 'external'; if (!callerId) { const s_form.hideRelatedListcallerRecord = new SimpleRecord('Customeremployee'); } |
s_form.isNewRecord()
If the record was never saved, this method returns TRUE; otherwise, it returns FALSE.
Return:
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!!s_form.isNewRecord() callerRecord.get(callerId, ()=> { if (callerRecord.sys_id && callerRecord.personal_schedule) { await s_form.setValue('stateschedule', 'new'); callerRecord.personal_schedule); } else { s_form.setReadOnlyaddInfoMessage('state', trueUsers schedule is not defined'); } }); } |
s_form.
isSectionVisiblegetDisplayValue(
sectionNamefieldName)
This method defines if a specified section is visible or notreturns the displayed value of the field.
Parameter(s):
Name | Type | Mandatory | Default |
---|
value |
---|
fieldName |
String | Y | N |
Return:
Type | Description |
---|
String | The displayed value of the specified field. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.isSectionVisible('Instructions')) { addInfoMessage(`Service "${s_form.addInfoMessagegetDisplayValue('service'Check)}" outis the "Instructions" section', 5000not available`); } |
s_form.
removeOptiongoBack(
fieldName, choiceValue)
Using this method, you can specify and delete an option from the list.
Parameter(s):
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 |
---|---|
Void | This method does not return |
value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const serviceId = if (s_form.getValueisChanged('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()
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 notThis method saves the record without leaving its form (just updating).
Return:
Type | Description |
---|
Boolean |
The method returns 'true' if any changes were made on the record form; otherwise, it returns 'false'. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.saveisChanged().finally(__resolveServerResponse);) { s_form.save().then(() => s_form.goBack()); } else { s_form.goBack(); } |
s_form.
setLabelOfhideFieldMsg(fieldName
, value)
This method sets the text value of the field labelmethod, as opposed to the s_form.showFieldMsg() method, allows hidding informational or error messages in the specified form field.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName |
String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return |
value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.table == 'user') { s_form.setLabelOf('email', 'Email'); } elsegetValue('state')) { s_form.setLabelOfhideFieldMsg('email', 'Personal Email'state'); } |
s_form.
setSectionMandatoryhideRelatedLists(
sectionName, mandatory)
This method allows making the specified section mandatory.
Parameter(s):
Return:
Using this method, you can hide all related lists on the form.
Return:
Type | Description |
---|---|
Void | This method does not return |
value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.getValue('statetype') == '7internal') { // Completed s_form.setSectionDisplay('Closure Information', truehideRelatedLists(); } |
s_form.
setSectionMandatory('Closure Information', true); s_form.setMandatory('closure_code', true); s_form.setMandatory('closure_notes', true); }isMandatory(fieldName)
This method is used to check if the specified field is mandatory or not.
Parameter(s)
s_form.setMandatory(fieldName, mandatory)
This method is used to change a specified field to mandatory field, i.e., it cannot be null.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|
Boolean | This method |
returns 'true' if the field is mandatory; otherwise returns 'false'. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const mandatoryColumn = (scriptType == 'onChange' || scriptType == 'onCellEdit'); if (s_form.isMandatory('state') && !s_form.getValue('state')) { s_form.setMandatoryaddInfoMessage('column_id', mandatoryColumn);State cannot be None'); } |
s_form.
setReadOnlyhideRelatedList(
fieldName, readOnlyrelListTitle)
This method is used to change a specified field to read-only or editable.
If the field is mandatory, it cannot be set to read-only. First, use the s_form.setMandatory() method and then make it read-only.
Using this method, you can specify a related list you want to hide.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
relListTitle | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return |
value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!!s_form.getValue('any_tablestype') == 'external') { s_form.setReadOnlyhideRelatedList('table_id', trueCustomer'); } |
s_form.
setMandatory('table_id', false); s_form.setVisible('table_id', false); }isNewRecord()
If the record was never saved, this method returns 'true'; otherwise, it returns 'false'.
Return:
Type | Description |
---|---|
Boolean | If the record was never saved then this method returns 'true'; otherwise, it returns 'false' |
s_form.setREMLabelOf(fieldName, value)
This method allows changing the displayable attribute label.
Parameter(s):
Name
Type
Mandatory
Default Value
Return:
Type
Description
. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.table == 'user'isNewRecord()) { await s_form.setREMLabelOfsetValue('emailstate', 'Emailnew'); } else { s_form.setREMLabelOfsetReadOnly('emailstate', 'Personal Email'true); } |
s_form.
setREMMandatoryisReadonly(fieldName
, mandatory)
This method
allows to make a field specified by REM attribute mandatoryis used to check if the specified field is editable or read-only.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|---|
Boolean | This method returns |
'true |
' if the field is read-only; otherwise returns 'false'. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const mandatoryColumn = (scriptType == 'onChange' || scriptType == 'onCellEdit'); if (!s_form.isReadonly('state')) { await s_form.setREMMandatorysetValue('column_idstate', mandatoryColumn'new'); } |
s_form.
setREMReadOnlyisSectionVisible(
fieldName, readonlysectionName)
This method
allows to makedefines if a
field specified by REM attribute read-onlyspecified section is visible or not.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
sectionName |
string | Y | N |
Return:
Type | Description |
---|---|
Boolean | This method returns |
'true |
' if the section is visible; otherwise, it returns |
'false |
'. |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!!s_form.isNewRecordisSectionVisible('Instructions')) { s_form.setValueaddInfoMessage('state', 'new'); s_form.setREMReadOnly('state', trueCheck out the "Instructions" section', 5000); } |
s_form.
setREMValueisValid(
fieldName, databaseValue)
This method
allows to set a value of the REM attribute label.Parameter(s):
Name
Type
Mandatory
Default Value
Return:
Type
Description
is used to check if the specified form is valid or not.
Return:
Type | Description |
---|---|
Boolean | This method returns 'true' if the form is valid; otherwise, 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 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!!s_form.isNewRecordisValid()) { s_form.setREMValueaddErrorMessage('name', 'Name created by systemThis form is invalid'); } |
s_form.
setREMVisiblleisVisible(fieldName
, display)
This method
allows to define visibility of the field specified by REM attributeis used to check if the specified field is visible or not.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String |
Y | N |
Return:
Type | Description |
---|
Boolean |
The method returns 'true' if the field is visible; otherwise returns 'false'. |
Example:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
s_form.setREMVisible('chronology', !s_form.isNewRecord()); |
s_form.setSectionDisplay(sectionName, display)
Using this method, you can specify a section you want to hide
| |||||
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:
Type | Description |
---|---|
Void | This method does not return a value. |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
choiceValue | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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:
Type | Description |
---|---|
String | This method returns the ID of the saved record. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
value | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
mandatory | Boolean | N | true |
Return:
Type | Description |
---|---|
Boolean | This method returns 'true' if its execution has been successful; otherwise, it returns 'false'. This method returns false in the following cases:
|
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
readOnly | Boolean | N | true |
Return:
Type | Description |
---|---|
Boolean | This method returns 'true' if its execution has been successful; otherwise, it returns 'false'. This method returns false in the following cases:
|
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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 |
---|---|---|---|
fieldName | String | Y | N |
value | String | Y | N |
Return:
Type | Description |
---|---|
String | This method returns the set value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
mandatory | Boolean | Y | 'true' |
Return:
Type | Description |
---|---|
Boolean | This method returns 'true' if its execution has been successful; otherwise, it returns 'false'. This method returns false in the following cases:
|
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
readOnly | Boolean | Y | 'true' |
Return:
Type | Description |
---|---|
Boolean | This method returns 'true' if its execution has been successful; otherwise, it returns 'false'. This method returns false in the following cases:
|
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.isNewRecord()) {
s_form.setREMValue('state', 'new');
s_form.setREMReadOnly('state', true);
} |
s_form.setREMValue(fieldName, databaseValue)
This method allows 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 |
---|---|---|---|
fieldName | String | Y | N |
databaseValue | Any | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
await s_form.setREMValue('state', 'new');
s_form.save(); |
s_form.setREMVisible(fieldName, display)
This method allows defining visibility of the field specified by REM attribute.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
display | Boolean | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Example:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
s_form.setREMVisible('additional_info', !s_form.isNewRecord()); |
s_form.setSectionDisplay(sectionName, display)
Using this method, you can specify the section you want to hide.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
sectionName | String | Y | N |
display | Boolean | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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 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 performance, use the await keyword as shown in the code example below. |
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
fieldName | String | Y | N |
databaseValue |
String | Y | N |
Return:
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
ifawait (s_form.getValuesetValue('state'), == '7') {; // Completed s_form.setSectionDisplay('Closure Information', true); s_form.setSectionMandatory('Closure Information', true); await s_form.setMandatorysetValue('closure_codenotes', truearticleBodies.join('\n')); await s_form.setMandatorysetValue('closure_notescode', true'1'); } else// { Solved 1st Level s_form.setMandatory('closure_code', false);save() .then(() => { s_form.setMandatory('closure_notes', false); i18n.getMessage(`The typical solution is applied`, (e) => { s_form.setSectionDisplay('Closure Information', falseaddInfoMessage(e); s_form.setSectionMandatory('Closure Information', false}); }); |
s_form.
setValuesetVisible(fieldName,
databaseValuedisplay)
This method sets the field value.
Warning |
---|
IsDisplayValue parameter has been maintained in earlier versions but will be deprecated after version 1.1. Avoid using it in your scripts. |
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.
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) will lead to validation errors after the form is submitted from the client-side |
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 performing, use the await keyword like shown in the code example below. |
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
display |
Boolean | Y | N |
Return:
Type | Description |
---|---|
Void | This method |
does not return value. |
Example:
Code Block | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
if (!s_form.isNewRecord()) { s_form.setVisible('subject', true); 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); }) });setVisible('reason', false); } |
s_form.
setVisibleshowFieldMsg(fieldName, message,
displaytype)
This method allows to 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.
Note |
---|
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. |
Parameter(s):
Return:
is used to display a message containing 'info', 'error', or 'warning' value under the specified form field.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
fieldName | String | Y | N |
message | String | Y | N |
type | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
s_form.showFieldMsg('subject', 'Cannot be empty', 'info'); |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
s_form.showFieldMsg('subject', 'Cannot be empty', 'warning'); |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (!s_form.isNewRecord()) { showFieldMsg('subject', 'Cannot be empty', 'error'); |
s_form.
setVisible('subject', true); s_form.setVisible('reason', false); }showRelatedLists()
This method allows displaying all lists related to the form.
Return:
Type | Description |
---|---|
Void | This method does not return value. |
s_form.
showFieldMsg(fieldName, message, typeshowRelatedList(listTitle)
This method is used to display a message containing 'info', 'error', or 'warning' value under the specified form field. allows displaying the specified lists related to the form.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
listTitle | String | Y | N |
Return:
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
s_form.showRelatedList('UI Action'); |
s_form.submit()
This method allows submitting the record form.
Return:
Type | Description |
---|---|
Void | This method does not return value. |
Deprecated methods
This subsection contains methods that are not recommended to use in application design. They are deprecated as the platform evolves; new methods are developed instead 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 |
---|---|---|---|
fieldName | String | Y | N |
Return:
Type | Description |
---|---|
Boolean | This method returns 'true' if the specified field has been changed; otherwise, it returns 'false'. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
s_form.showFieldMsg('subject', 'Cannot be empty', 'info'); |
language | js |
---|---|
theme | Eclipse |
title | showFieldMsg |
linenumbers | true |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
console.log(s_form.showFieldMsgfieldHasChanges('subject', 'Cannot be empty', 'error'); |
s_form.showRelatedLists()
This method allows displaying all lists related to the form.
Return:state')); |
s_form.
showRelatedListhasChanges(
listTitle)
This method allows displaying the specified lists related to the form.
Parameter(s):
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. |
listTitle
Return:
Type | Description |
---|
Boolean |
The method returns 'true' if any changes were made on the record form; otherwise, it returns 'false'. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
if (s_form.showRelatedListhasChanges('UI Action');)) { s_form.save().then(() => s_form. |
This method allows to submit the record form.
Return:
goBack());
} else {
s_form.goBack();
} |
Table of Contents | ||
---|---|---|
|