GlideRecord Cheat Sheet

GlideRecord(String tableName)

var gr = new GlideRecord('incident');
gr.query();
while (gr.next()){
    gs.info(gr.short_description);
}

Dot walking 101

GlideRecord provides access to fields via "Dot-walking", so when you query for an incident you can use:

gr.short_description instead of gr.getValue('short_description')

and even better, you can dot-walk as deep as you want through Reference fields:

Get a Caller's Company name: gr.caller_id.company.name

or the Country of a Location of an Asset associated to an incident: gr.cmdb_ci.location.country

When you dot-walk to a field you get the GlideElement for that field. So when you use a dot-walked field as a string, it's calling the toString() method on the appropriate GlideElement class for that field.

so gs.info(gr.caller_id) is the same as gs.info(gr.get("caller_id").getValue()) is the same as gs.info(gr.getValue("caller_id"))

getValue vs getDisplayValue

For the following field types, value and display value are different.

Reference
Price & Currency2
Glide List
Translated fields
Journal
Password

var gr = new GlideRecord('incident');
gr.get('sys_id','ef43c6d40a0a0b5700c77f9bf387afe3');
gs.info(gr.caller_id); // 5b7c200d0a640069006b3845b5d0fa7c
gs.info(gr.caller_id.getDisplayValue()); // Jerrod Bennett

Important Use .getDisplayValue() whenever showing a value in the UI, just in case a translation exists for that field value!

Methods

Method	Description
addActiveQuery()	Adds a filter to return active records.
addEncodedQuery(String query)	Adds an encoded query to other queries that may have been set.
addNotNullQuery(String fieldName)	Adds a filter where fieldName values are not null.
addNullQuery(String fieldName)	Adds a filter where fieldName values are null.
addQuery(String fieldName, Object value)	Adds a filter where fieldName is equal to value.
addQuery(String fieldName, String operator, Object value)	Adds a filter. See Operators
Has Access?
canCreate()	Can the user create a record in this table?
canDelete()	Can the user delete from this table?
canRead()	Can the user read from this table?
canWrite()	Can the user write to this table?
Delete
deleteMultiple()	Deletes multiple records that satisfy the query condition.
deleteRecord()	Deletes the current record.
Get
getAttribute(String fieldName)	Returns the dictionary attributes for fieldName.
getDisplayValue()	Returns the display value for the current record.
getDisplayValue(String fieldName)	Returns the display value for fieldName.
getElement(String fieldName)	Returns the GlideElement for fieldName.
getEncodedQuery()	Returns the current query condition as an encoded query string.
getRecordClassName()	Returns the class name for the current record.
getRowCount()	Returns the number of rows in the query result.
getTableName()	Returns the name of the table associated with the GlideRecord.
getUniqueValue()	Returns the primary key of the record, which is usually the sys_id.
getValue(String fieldName)	Returns the value for fieldName.
Record Operations
get(String value)	Fetch a record by primary key value, typically sys_id.
get(Object fieldName, Object value)	Fetch a record where fieldName equals value.
hasNext()	Returns true if there are any more records in the GlideRecord object.
initialize()	Creates a GlideRecord without any default values set.
isNewRecord()	Returns true if the current record has not yet been inserted into the database.
insert()	Inserts a new record.
newRecord()	Creates a new record and sets the default values for the fields.
next()	Moves to the next record in the GlideRecord object.
query()	Perform the query.
setLimit(int max)	Set the maximum number of records to fetch for the query.
setValue(String fieldName, Object value)	Sets the value of fieldName.
setWorkflow(Boolean b)	Enables or disables the running of business rules, script engines, and audit.
update(String reason)	Save the GlideRecord changes to the database. Reason is saved to the audit record.
updateMultiple()	Saves each GlideRecord in the list with any changes that have been made.
Is valid?
isActionAborted()	Checks to see if the current database action is to be aborted.
isValid()	Returns true if current table is valid.
isValidField(String fieldName)	Returns true if fieldName is valid.
isValidRecord()	Returns true if current record is valid.
Order by
orderBy(String fieldName)	Order by fieldName ascending.
orderByDesc(String fieldName)	Order by fieldName descending.

addQuery operators, must be upper case

Operator	Type	Desc
=	Number	Equals num_val
!=	Number	Not Equals num_val
>	Number	Greater than num_val
>=	Number	Greater than or equal to num_val
<	Number	Less than num_val
<=	Number	Less than or equal to num_val
=	String	Equals val
!=	String	Not Equals val
IN	String	In Set of val (e.g. 1234,2345,3456,4567)
NOT IN	String	Not in Set of val
STARTSWITH	String	Starts with val
ENDSWITH	String	Ends with val
CONTAINS	String	Contains val
DOES NOT CONTAIN	String	Does not contain val
INSTANCEOF	String	Record class is val or a subclass of val

Examples

addActiveQuery

var gr = new GlideRecord('incident');
gr.addActiveQuery();
gr.query();

addEncodedQuery

var queryString = "priority=1^ORpriority=2";
var gr = new GlideRecord('incident');
gr.addEncodedQuery(queryString);
gr.query();
while (gr.next()) {
  gs.addInfoMessage(gr.number);
}

addQuery

var rec = new GlideRecord('incident');
rec.addQuery('active',true);
rec.addQuery('sys_created_on', ">", "2010-01-19 04:05:00");
rec.query();
while (rec.next()) { 
  rec.active = false;
  gs.info('Active incident ' + rec.number + ' closed');
  rec.update();
}

Using the IN operator

var gr = new GlideRecord('incident');
gr.addQuery('number','IN','INC00001,INC00002');
gr.query();
while(gr.next()) {
  //do something....
}

deleteMultiple

var gr = new GlideRecord('incident')
gr.addQuery('active','false'); // delete all inactive incidents
gr.deleteMultiple();

deleteRecord

var gr = new GlideRecord('incident')
if (gr.get('99ebb4156fa831005be8883e6b3ee4b9'))
    gr.deleteRecord();
}

canCreate, canDelete, canRead

var gr = new GlideRecord('incident');
gs.info(gr.canCreate());
gs.info(gr.canDelete());
gs.info(gr.canRead());

getDisplayValue

var gr = new GlideRecord('incident');
gr.get('sys_id','ef43c6d40a0a0b5700c77f9bf387afe3');
gs.info(gr.getDisplayValue()); // INC0000050

For field

var gr = new GlideRecord('incident');
gr.get('sys_id','ef43c6d40a0a0b5700c77f9bf387afe3');
gs.info(gr.getDisplayValue("caller_id")); // Jerrod Bennett

getEncodedQuery

var gr = new GlideRecord('incident'); 
gr.addQuery('active', true);
gr.addQuery('priority', 1); 
gr.query(); 
var encodedQuery = gr.getEncodedQuery(); 
gs.info(encodedQuery); // active=true^priority=1

getRecordClassName

var gr = new GlideRecord("task"); 
gr.get("ef43c6d40a0a0b5700c77f9bf387afe3");
gs.info(gr.getRecordClassName()); //incident

getRowCount

var gr = new GlideRecord('incident')
gr.query();
gs.info("Records in incident table: " + gr.getRowCount());

insert

var gr = new GlideRecord('incident');
gr.newRecord(); 
gr.name = 'New Incident'; 
gr.description = 'Incident description'; 
gr.insert(); // Returns new record sys_id

var gr = new GlideRecord('incident');
gr.query();
while (gr.next()) { 
  gs.info([gr.number, gr.short_description, gr.caller_id.getDisplayValue()]);
}

setWorkflow

var gr = new GlideRecord('incident');
gr.initialize();
gr.setWorkflow(false); // when false, runs almost immediately. When true, takes about 3 seconds.
for (var i=1;i<100;i++){
    gr.short_description = 'Sample incident ' + i; 
    gr.description = 'Auto generated';
    gr.insert();
}

update

var gr = new GlideRecord('incident')
gr.get('99ebb4156fa831005be8883e6b3ee4b9');
gr.short_description='Update the short description';
gr.update();

updateMultiple

var gr = new GlideRecord('incident')
gr.addQuery('active', true);
gr.query();
gr.setValue('state',  4);
gr.updateMultiple(); // update the state of all active incidents to 4 - "Awaiting User Info"

isValid

var gr = new GlideRecord('incident');
gs.info(gr.isValid()); // true
 
var anotherGr = new GlideRecord('wrong_table_name');
gs.info(anotherGr.isValid()); // false

setLimit

var gr = new GlideRecord('incident');
gr.orderByDesc('sys_created_on');
gr.setLimit(10);
gr.query(); // this retrieves latest 10 incident records created

From:

https://developer.servicenow.com/app.do#!/api_doc?v=madrid&id=c_GlideRecordScopedAPI

sn-donbenjamin/gliderecord_cheatsheet.md