Cheat Sheet

By SN Mastery

Published on:

🔹 g_form Cheat Sheet – Essential Methods

MethodDescriptionExample Usage
g_form.getValue(fieldName)Gets the value of a field.var priority = g_form.getValue('priority');
g_form.setValue(fieldName, value)Sets a field’s value.g_form.setValue('priority', '1');
g_form.setVisible(fieldName, true/false)Shows or hides a field.g_form.setVisible('description', false);
g_form.setReadOnly(fieldName, true/false)Makes a field read-only or editable.g_form.setReadOnly('impact', true);
g_form.setMandatory(fieldName, true/false)Sets a field as mandatory or optional.g_form.setMandatory('category', true);
g_form.addInfoMessage(message)Displays an info message on the form.g_form.addInfoMessage('Request submitted successfully.');
g_form.addErrorMessage(message)Displays an error message on the form.g_form.addErrorMessage('Error: Invalid data entered.');
g_form.clearValue(fieldName)Clears the value of a field.g_form.clearValue('description');
g_form.isMandatory(fieldName)Checks if a field is mandatory.if (g_form.isMandatory('category')) { alert('Category is mandatory!'); }
g_form.isReadOnly(fieldName)Checks if a field is read-only.if (g_form.isReadOnly('state')) { alert('State field is read-only.'); }
g_form.isVisible(fieldName)Checks if a field is visible.if (!g_form.isVisible('comments')) { alert('Comments field is hidden!'); }
g_form.showFieldMsg(fieldName, message, type)Shows a message below a field (info, error, or warning).g_form.showFieldMsg('priority', 'Select priority carefully!', 'warning');
g_form.hideFieldMsg(fieldName)Hides a message displayed below a field.g_form.hideFieldMsg('priority');
g_form.getReference(fieldName, callback)Fetches referenced field data asynchronously.g_form.getReference('caller_id', function(user) { alert(user.email); });
g_form.clearOptions(fieldName)Removes all options from a choice field.g_form.clearOptions('category');
g_form.addOption(fieldName, value, label)Adds an option to a choice field.g_form.addOption('category', 'software', 'Software');
g_form.removeOption(fieldName, value)Removes an option from a choice field.g_form.removeOption('category', 'hardware');
g_form.getDisplayValue(fieldName)Gets the display value of a reference field.var userName = g_form.getDisplayValue('caller_id');
g_form.setDisplay(fieldName, true/false)Similar to setVisible(), but also affects mandatory validation.g_form.setDisplay('assignment_group', false);
g_form.save()Saves the form without submitting it.g_form.save();
g_form.submit()Submits the form programmatically.g_form.submit();

🔹 g_user Cheat Sheet – Essential Methods

MethodDescriptionExample Usage
g_user.userIDReturns the sys_id of the logged-in user.var userId = g_user.userID;
g_user.userNameReturns the username of the logged-in user.var username = g_user.userName;
g_user.firstNameReturns the first name of the logged-in user.var firstName = g_user.firstName;
g_user.lastNameReturns the last name of the logged-in user.var lastName = g_user.lastName;
g_user.hasRole('role_name')Checks if the user has a specific role (returns true/false).if (g_user.hasRole('admin')) { alert('You are an admin!'); }
g_user.hasRoles()Checks if the user has any role (returns true/false).if (g_user.hasRoles()) { alert('You have at least one role.'); }
g_user.hasRoleExactly('role_name')Checks if the user only has the specified role (returns true/false).if (g_user.hasRoleExactly('itil')) { alert('You only have the ITIL role.'); }
g_user.getRoles()Returns an array of all roles assigned to the user.var roles = g_user.getRoles(); alert(roles);
g_user.hasRoleFromList('role1,role2,role3')Checks if the user has any role from a given list.if (g_user.hasRoleFromList('admin,itil')) { alert('User has admin or ITIL role.'); }

🔹 GlideSystem User Object (gs.getUser()) Cheat Sheet

MethodDescriptionExample Usage
gs.getUser()Returns the GlideUser object for the current user.var user = gs.getUser();
gs.getUserID()Returns the sys_id of the logged-in user.var userId = gs.getUserID();
gs.getUserName()Returns the username of the logged-in user.var username = gs.getUserName();
gs.getUserDisplayName()Returns the full name of the logged-in user.var fullName = gs.getUserDisplayName();
gs.getUser().getFirstName()Returns the first name of the logged-in user.var firstName = gs.getUser().getFirstName();
gs.getUser().getLastName()Returns the last name of the logged-in user.var lastName = gs.getUser().getLastName();
gs.getUser().hasRole('role_name')Checks if the user has a specific role (returns true/false).if (gs.getUser().hasRole('admin')) { gs.info('User is an admin'); }
gs.getUser().hasRoles()Checks if the user has any role (returns true/false).if (gs.getUser().hasRoles()) { gs.info('User has at least one role'); }
gs.getUser().getRoles()Returns an array of all roles assigned to the user.var roles = gs.getUser().getRoles(); gs.info(roles);
gs.getUser().isMemberOf('group_name')Checks if the user is a member of a specific group (returns true/false).if (gs.getUser().isMemberOf('CAB')) { gs.info('User is in the CAB group'); }
gs.getUser().getCompanyID()Returns the sys_id of the user’s company.var companyId = gs.getUser().getCompanyID();

🔹 GlideRecord Cheat Sheet – Essential Methods

MethodDescriptionExample Usage
var gr = new GlideRecord('table_name');Creates a GlideRecord object for a table.var gr = new GlideRecord('incident');
gr.addQuery('field', 'value');Adds a filter condition (WHERE clause).gr.addQuery('priority', '1');
gr.addEncodedQuery('encoded_query_string');Uses an encoded query to filter results.gr.addEncodedQuery('priority=1^active=true');
gr.orderBy('field');Sorts results in ascending order.gr.orderBy('priority');
gr.orderByDesc('field');Sorts results in descending order.gr.orderByDesc('priority');
gr.query();Executes the query on the database.gr.query(); while (gr.next()) { gs.info(gr.number); }
gr.next();Moves to the next record in the result set.if (gr.next()) { gs.info(gr.short_description); }
gr.get('sys_id');Retrieves a specific record by sys_id.gr.get('1234567890abcdef');
gr.getValue('field');Gets the value of a field.var desc = gr.getValue('short_description');
gr.setValue('field', 'value');Sets a field’s value.gr.setValue('priority', '2');
gr.update();Saves changes to the current record.gr.update();
gr.insert();Inserts a new record into the table.var newID = gr.insert();
gr.deleteRecord();Deletes the current record.gr.deleteRecord();
gr.initialize();Creates a new empty record.gr.initialize(); gr.short_description = 'New Incident'; gr.insert();
gr.setLimit(number);Limits the number of records retrieved.gr.setLimit(5);
gr.updateMultiple();Updates multiple records at once.gr.setValue('state', '3'); gr.updateMultiple();

Leave a comment