GlideRecord - setLimit(Number limit)

The GlideRecord API is used for database operations.

The GlideRecord API is the primary means of interfacing with the database on the server-side code. A GlideRecord is an object that contains records from a single table. Use the API to instantiate a GlideRecord object and add query parameters, filters, limits, and ordering.

See the GlideRecord article for details on building and running queries.

For information about GlideRecordSecure , which is a class inherited from GlideRecord that performs the same functions as GlideRecord , and also enforces ACLs, see the GlideServer APIs .

Always test queries on a sub-production instance prior to deploying them on a production instance. An incorrectly constructed encoded query, such as including an invalid field name, produces an invalid query. When the invalid query is run, the invalid part of the query condition is dropped, and the results are based on the valid part of the query, which may return all records from the table. Using an insert() , update() , deleteRecord() , or deleteMultiple() method on bad query results can result in data loss.

You can set the glide.invalid_query.returns_no_rows system property to true to have queries with invalid encoded queries return no records. In some cases, the query may still return records in API results even when glide.invalid_query.returns_no_rows is set to true. This happens in queries where an invalid query term is used with a WHERE operator. In such queries, the WHERE operator ignores the invalid term(s) but still interprets and returns the rest of the query statement. For more information about this system property and its functionality, see Available system properties .

Retrieve values from records In most cases, don’t use dot-walking to get values from a record. Dot-walking retrieves the entire object instead of the field value. Retrieving the object uses more storage and might cause undesirable results when used in arrays or in Service Portal .

Instead of retrieving the entire object, you can use one of the following methods to copy the field values:

getValue() getDisplayValue()

If dot-walking through a GlideElement object is necessary, use the toString() method to retrieve values. For example, you might need the current caller's manager sys_id to set another reference field. The following example shows how to get the string value instead of the entire object: var mgr = current.caller_id.manager.toString();

See also: GlideAggregate GlideElement GlideQuery

Parent Topic: Server API reference GlideRecord - addActiveQuery()

Adds a filter to return active records.

Table 1. Parameters Name Type Description None

Table 2. Returns Type Description GlideQueryCondition Filter to return active records.

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

Scoped equivalent To use the addActiveQuery() method in a scoped application, use the corresponding scoped method: addActiveQuery() .

GlideRecord - addDomainQuery(Object glideRecord)

Changes the domain used for the query from the user's domain to the domain of the provided GlideRecord.

Always test queries on a sub-production instance prior to deploying them on a production instance. An incorrectly constructed encoded query, such as including an invalid field name, produces an invalid query. When the invalid query is run, the invalid part of the query condition is dropped, and the results are based on the valid part of the query, which may return all records from the table. Using an insert() , update() , deleteRecord() , or deleteMultiple() method on bad query results can result in data loss.

You can set the glide.invalid_query.returns_no_rows system property to true to have queries with invalid encoded queries return no records. In some cases, the query may still return records in API results even when glide.invalid_query.returns_no_rows is set to true. This happens in queries where an invalid query term is used with a WHERE operator. In such queries, the WHERE operator ignores the invalid term(s) but still interprets and returns the rest of the query statement. For more information about this system property and its functionality, see Available system properties .

This function requires the Domain Support - Domain Extensions Installer (com.glide.domain.msp_extensions.installer) plugin.

Table 3. Parameters Name Type Description glideRecord Object GlideRecord from which to obtain the domain.

Table 4. Returns Type Description void

//This example requires the Domain plugin be active, the Group table is the specified //Domain table, and the ITIL user is in the Database Atlanta domain //From any domain (using queryNoDomain()) look up the incidents that an ITIL user can only see //who is in the Database Atlanta domain, should expect all incidents with the global or the //Database Atlanta domain specified. var domain = new GlideRecord('sys_user'); domain.addQuery('user_name', 'itil'); domain.queryNoDomain(); if (domain.next()) { var domainQuery = new GlideRecord('incident'); domainQuery.addQuery('active', true); domainQuery.addDomainQuery(domain); domainQuery.query(); gs.print('Number of Incidents for ITIL user: ' + domainQuery.getRowCount()); while (domainQuery.next()) gs.print(domainQuery.number); }

Scoped equivalent This method is not available in scoped applications.

GlideRecord - addEncodedQuery(String query)

Adds an encoded query to other queries that may have been set.

Always test queries on a sub-production instance prior to deploying them on a production instance. An incorrectly constructed encoded query, such as including an invalid field name, produces an invalid query. When the invalid query is run, the invalid part of the query condition is dropped, and the results are based on the valid part of the query, which may return all records from the table. Using an insert() , update() , deleteRecord() , or deleteMultiple() method on bad query results can result in data loss.

You can set the glide.invalid_query.returns_no_rows system property to true to have queries with invalid encoded queries return no records. In some cases, the query may still return records in API results even when glide.invalid_query.returns_no_rows is set to true. This happens in queries where an invalid query term is used with a WHERE operator. In such queries, the WHERE operator ignores the invalid term(s) but still interprets and returns the rest of the query statement. For more information about this system property and its functionality, see Available system properties .

Table 5. Parameters Name Type Description query String An encoded query string .

Table 6. Returns Type Description void

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

Scoped equivalent To use the addEncodedQuery() method in a scoped application, use the corresponding scoped method: addEncodedQuery() .

GlideRecord - addExtraField(String dotWalkedField)

Queries one or more dot-walked fields from a form or script in a single request.

The addExtraField() method allows you to query dot-walked fields in a single database request, rather than perform multiple queries per dot-walked element in a form or script (which requires multiple round trips to the database).

Table 7. Parameters Name Type Description dotWalkedField String The dot-walked field name. Levels of field names are separated by dots (periods). For example, enter the value Caller.Company if you want to query the Company > Caller condition in the Incident [incident] table. The format of dotWalkedField follows the left-to-right order of fields in a dotwalked form or script.

Table 8. Returns Type Description None Note: The addExtraField() method does not impact output results; the output is always the same regardless if you use this method in your script.

The following example shows how to query the contact name field of cmn_location (referenced from the “location” reference field in a cmdb_ci field). Note: The dotWalkedField value in this example, cmdb_ci.location.contact.name , looks like “cmdb_ci fields” => “cmn_location fields” => “sys_user fields” in the ServiceNow® UI when selecting fields in a list.

var gliderecord = new GlideRecord("incident"); gliderecord.addQuery("number", "INC0041457"); gliderecord.addExtraField("cmdb_ci.location.contact.name"); gliderecord.query(); gliderecord.next(); gs.print(gliderecord.cmdb_ci.location.contact.name); The output is the same as gs.print(gr.cmdb_ci.location.contact.name) without using addExtraField() . The addExtraField() method optimizes the querying of the dot-walked fields. Example output:

Abel Tuter

GlideRecord - addFunction(Object function)

Applies a pre-defined GlideDBFunctionBuilder object to a record.

Use the GlideDBFunctionBuilder scoped class to define a function. After the function is defined, use the addFunction(Object function) method to apply the function to a record.

Table 9. Parameters Name Type Description function Object A GlideDBFunctionBuilder or GlideDBCaseStatementBuilder object that defines a SQL operation.

Table 10. Returns Type Description void

var functionBuilder = new GlideDBFunctionBuilder(); var myAddingFunction = functionBuilder.add(); myAddingFunction = functionBuilder.field('order'); myAddingFunction = functionBuilder.field('priority'); myAddingFunction = functionBuilder.build();

var now_GR = new GlideRecord('incident'); now_GR.addFunction(myAddingFunction); now_GR.addQuery(myAddingFunction, ' Output:

*** Script: 1 *** Script: 4 *** Script: 3 *** Script: 1 *** Script: 1 *** Script: 2 *** Script: 1 *** Script: 1

GlideRecord - addInactiveQuery()

Adds a filter to return inactive records. Inactive records have the active flag set to false.

Table 11. Parameters Name Type Description None

Table 12. Returns Type Description GlideQueryCondition Records where the active flag is false.

var inc = new GlideRecord('incident'); inc.addInactiveQuery(); inc.query();

Scoped equivalent In scoped applications use the scoped method addQuery("active","false") .

GlideRecord - addJoinQuery(String table)

Adds a filter to return records based on a relationship in a related table.

For example, find all the users that are in the database group (users via sys_user_grmember table). Another example would be find all problems that have an assigned incident (problems via the incident.problem_id relationship).

This is not a true database join; rather, addJoinQuery() adds a subquery. So, while the result set is limited based on the join, the only fields that you have access to are those on the base table (those which are in the table with which the GlideRecord was initialized).

Always test queries on a sub-production instance prior to deploying them on a production instance. An incorrectly constructed encoded query, such as including an invalid field name, produces an invalid query. When the invalid query is run, the invalid part of the query condition is dropped, and the results are based on the valid part of the query, which may return all records from the table. Using an insert() , update() , deleteRecord() , or deleteMultiple() method on bad query results can result in data loss.

You can set the glide.invalid_query.returns_no_rows system property to true to have queries with invalid encoded queries return no records. In some cases, the query may still return records in API results even when glide.invalid_query.returns_no_rows is set to true. This happens in queries where an invalid query term is used with a WHERE operator. In such queries, the WHERE operator ignores the invalid term(s) but still interprets and returns the rest of the query statement. For more information about this system property and its functionality, see Available system properties .

Table 13. Parameters Name Type Description table String Table name

Table 14. Returns Type Description GlideQueryCondition Records where the relationships match.

Find problems that have an incident attached. This example returns problems that have associated incidents. However, it won't pull values from the incidents that are returned as a part of the query.

var prob = new GlideRecord('problem'); prob.addJoinQuery('incident'); prob.query();

Find active=false problems with associated incidents.

// Look for Problem records var now_GR = new GlideRecord('problem'); // That have associated Incident records var grSQ = now_GR.addJoinQuery('incident'); // Where the Problem records are "active=false" now_GR.addQuery('active', 'false'); // And the Incident records are "active=true" grSQ.addCondition('active', 'true'); // Query now_GR.query(); // Iterate and print results while (now_GR.next()) { gs.print(now_GR.getValue('number')); }

Scoped equivalent To use the addJoinQuery() method in a scoped application, use the corresponding scoped method: addJoinQuery() .

GlideRecord - addJoinQuery(String table, String primaryField)

Adds a filter to return records based on a relationship in a related table.

For example, find all the users that are in the database group (users via sys_user_grmember table). Another example would be find all problems that have an assigned incident (problems via the incident.problem_id relationship).

This is not a true database join; rather, addJoinQuery() adds a subquery. So, while the result set is limited based on the join, the only fields that you have access to are those on the base table (those which are in the table with which the GlideRecord was initialized).

Always test queries on a sub-production instance prior to deploying them on a production instance. An incorrectly constructed encoded query, such as including an invalid field name, produces an invalid query. When the invalid query is run, the invalid part of the query condition is dropped, and the results are based on the valid part of the query, which may return all records from the table. Using an insert() , update() , deleteRecord() , or deleteMultiple() method on bad query results can result in data loss.

You can set the glide.invalid_query.returns_no_rows system property to true to have queries with invalid encoded queries return no records. In some cases, the query may still return records in API results even when glide.invalid_query.returns_no_rows is set to true. This happens in queries where an invalid query term is used with a WHERE operator. In such queries, the WHERE operator ignores the invalid term(s) but still interprets and returns the rest of the query statement. For more information about this system property and its functionality, see Available system properties .

Table 15. Parameters Name Type Description table String Table name primaryField String If other than sys_id, the primary field.

Table 16. Returns Type Description GlideQueryCondition Records where the relationships match.

Find problems that have incidents using the open_by field at the join key instead of the sys_id.

var now_GR = new GlideRecord('problem'); now_GR.addJoinQuery('incident', 'opened_by'); now_GR.query();

Scoped equivalent To use the addJoinQuery() method in a scoped application, use the corresponding scoped method: addJoinQuery() .

GlideRecord - addJoinQuery(String table, String primaryField, String joinTableField)

Adds a filter to return records based on a relationship in a related table.

For example, find all the users that are in the database group (users via sys_user_grmember table). Another example would be find all problems that have an assigned incident (problems via the incident.problem_id relationship).

This is not a true database join; rather, addJoinQuery() adds a subquery. So, while the result set is limited based on the join, the only fields that you have access to are those on the base table (those which are in the table with which the GlideRecord was initialized).

Always test queries on a sub-production instance prior to deploying them on a production instance. An incorrectly constructed encoded query, such as including an invalid field name, produces an invalid query. When the invalid query is run, the invalid part of the query condition is dropped, and the results are based on the valid part of the query, which may return all records from the table. Using an insert() , update() , deleteRecord() , or deleteMultiple() method on bad query results can result in data loss.

You can set the glide.invalid_query.returns_no_rows system property to true to have queries with invalid encoded queries return no records. In some cases, the query may still return records in API results even when glide.invalid_query.returns_no_rows is set to true. This happens in queries where an invalid query term is used with a WHERE operator. In such queries, the WHERE operator ignores the invalid term(s) but still interprets and returns the rest of the query statement. For more information about this system property and its functionality, see Available system properties .

Table 17. Parameters Name Type Description table String Table name primaryField String If other than sys_id, the primary field. joinTableField String If other than sys_id, the field that joins the tables

Table 18. Returns Type Description GlideQueryCondition Records where the relationships match.

Find problems that have incidents associated where the incident caller_id field value matches that of the problem opened_by field.

var now_GR = new GlideRecord('problem'); now_GR.addJoinQuery('incident', 'opened_by', 'caller_id'); now_GR.query();

Scoped equivalent To use the addJoinQuery() method in a scoped application, use the corresponding scoped method: addJoinQuery() .

GlideRecord - addNotNullQuery(String fieldName)

Adds a filter to return records where the specified field is not null.

Table 19. Parameters Name Type Description fieldName String The field name.

Table 20. Returns Type Description GlideQueryCondition GlideQueryCondition of records where the parameter field is not null.

var target = new GlideRecord('incident'); target.addNotNullQuery('short_description'); target.query(); // Issue the query to the database to get all records while (target.next()) { // add code here to process the incident record }

Scoped equivalent To use the addNotNullQuery() method in a scoped application, use the corresponding scoped method: addNotNullQuery() .

GlideRecord - addNullQuery(String fieldName)

Adds a filter to return records where the specified field is null.

Table 21. Parameters Name Type Description fieldName String The field name.

Table 22. Returns Type Description GlideQueryCondition GlideQueryCondition of records where the specified field is null.

var target = new GlideRecord('incident'); target.addNullQuery('short_description'); target.query(); // Issue the query to the database to get all records while (target.next()) { // add code here to process the incident record }

Scoped equivalent To use the addNullQuery() method in a scoped application, use the corresponding scoped method: addNullQuery() .

GlideRecord - addQuery(String name, Object operator, Object value)

Provides the ability to build a request, which when executed, returns the rows from the specified table that match the request.

If you are familiar with SQL, this method is similar to the "where" clause. One or more addQuery() calls can be made in a single query; for this method the queries are AND'ed. If any of the query statements need to be OR'ed, use the class GlideQueryCondition .

addQuery() is typically called with three parameters; table field, operator, and comparison value. It can be called with only two parameters, table field and comparison value, such as myObj.addQuery('category','Hardware'); . The operator in this case is assumed to be "equal to".

For additional information on using queries, see Querying tables in script .

Always test queries on a sub-production instance prior to deploying them on a production instance. An incorrectly constructed encoded query, such as including an invalid field name, produces an invalid query. When the invalid query is run, the invalid part of the query condition is dropped, and the results are based on the valid part of the query, which may return all records from the table. Using an insert() , update() , deleteRecord() , or deleteMultiple() method on bad query results can result in data loss.

You can set the glide.invalid_query.returns_no_rows system property to true to have queries with invalid encoded queries return no records. In some cases, the query may still return records in API results even when glide.invalid_query.returns_no_rows is set to true. This happens in queries where an invalid query term is used with a WHERE operator. In such queries, the WHERE operator ignores the invalid term(s) but still interprets and returns the rest of the query statement. For more information about this system property and its functionality, see Available system properties .

Table 23. Parameters Name Type Description name String Table field name operator Object Query operator. The available values are dependent on the data type of the value parameter. Numbers: = != > >=

Strings (must be in upper case): = != IN NOT IN STARTSWITH ENDSWITH CONTAINS DOES NOT CONTAIN INSTANCEOF

Note: Use CONTAINS instead of the LIKE operator. value Object Value on which to query (not case-sensitive).

Table 24. Returns Type Description GlideQueryCondition A reference to the GlideQueryCondition that was added to the GlideRecord.

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.print('Active incident ' + rec.number + ' closed'); rec.update(); }

Using the IN operator.

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

Scoped equivalent To use the addQuery() method in a scoped application, use the corresponding scoped method: addQuery() .

GlideRecord - addValue(String field, Number value)

Provides atomic add and subtract operations on a specified number field at the database level for the current GlideRecord object.

Typically, a GlideRecord object is written as one record in a database. Individual field values are stored as defined. For code that adds a value to a GlideRecord field, it simply saves the field to the database with the new value, rather than atomically incrementing it.

For example, when the following code is executed, the value of the u_count field in the database is 2. gs.print(now_now_GR.u_count); // "1" now_GR.u_count += 1; now_GR.update(); now_GR.get(now_now_GR.sys_id); gs.print(now_now_GR.u_count); // "2" If another user concurrently runs identical code, instead of the two operations each adding 1 to u_count, the net effect is that u_count only contains 2, with one operation's update actually being lost.

Conversely, the addValue() method performs the addition/subtraction in the database when the record is updated as an atomic operation. Two operations running concurrently each properly update the field. gs.print(now_now_GR.u_count); // "1" now_GR.addValue("u_count", 1); now_GR.update(); now_GR.get(now_GR); // The record must be reloaded from the database to observe the result gs.print(now_now_GR.u_count); // "3", if executed concurrently with another user

Note: The new value is not read back from the database unless explicitly done so.

Like setValue() , addValue() changes only take effect in the database after a subsequent call to update() or insert() . If insert() is called, the specified field is initialized with the value parameter passed into addValue() .

Note: If setValue() is called for the specified field prior to calling addValue() , the addValue() method is not processed and an error message is logged.

Table 25. Parameters Name Type Description field String The name of the field in this GlideRecord to modify. If the associated field is not a numeric type, the operation is ignored.

value Number The amount to add to the value when the record is saved. To perform a subtraction operation, simply pass a negative value.

Table 26. Returns Type Description void

Shows a value being added.

gs.print(now_GR.u_count); // "1" now_GR.addValue("u_count", 1); now_GR.update(); now_GR.get(now_GR.sys_id); // The record must be reloaded from the database to observe the result gs.print(now_GR.u_count); Output: 2

Shows a value being subtracted.

gs.print(now_GR.u_count); // "4" now_GR.addValue("u_count", -1); now_GR.update(); now_GR.get(now_GR.sys_id); // The record must be reloaded from the database to observe the result gs.print(now_GR.u_count); Output: 3

GlideRecord - applyEncodedQuery(String queryString)

Sets the values of the specified encoded query terms and applies them to the current GlideRecord.

Table 27. Parameters Name Type Description queryString String Encoded query to apply to the current GlideRecord.

Table 28. Returns Type Description None

GlideRecord - applyTemplate(String template)

Apply a template record from the Template table [sys_template] to the current record. If the specified template is not found, no action is taken.

Note: This method automatically instantiates a now_GR.insert() method if a template has the Next Related Child Template field filled. For information, see Create templates for related task records .

Table 29. Parameters Name Type Description template String Name of a template from the Templates [sys_template] table.

Table 30. Returns Type Description void

var rec1 = new GlideRecord("incident"); rec1.initialize(); rec1.applyTemplate("my_incident_template"); rec1.insert();

GlideRecord - autoSysFields(Boolean e)

Enables or disables the update to the fields sys_updated_by, sys_updated_on, sys_mod_count, sys_created_by, and sys_created_on. This is often used for manually updating field values on a record while leaving historical information unchanged.

Warning: Use caution if you use this method. When you use this method the sys_mod_count field will not be incremented, and other sys_ fields will not be updated. This can break functionality including, but not limited to, the Activity Formatter, History Sets, Notifications, and Metrics.

Table 31. Parameters Name Type Description e Boolean If false disables updates to sys_updated_by, sys_updated_on, sys_mod_count, sys_created_by, and sys_created_on.

Table 32. Returns Type Description void

var inc = new GlideRecord('incident'); // Change all Open(1) incidents to Active(2) inc.addQuery('state', 1); inc.query(); while (inc.next()) { inc.autoSysFields(false); // Do not update sys_updated_by, sys_updated_on, sys_mod_count, sys_created_by, and sys_created_on inc.setWorkflow(false); // Do not run any other business rules inc.setValue('state', 2); inc.update(); }

GlideRecord - canCreate()

Determines if the access control rules (which includes the user's role) permit inserting new records in this table.

Table 33. Parameters Name Type Description None

Table 34. Returns Type Description Boolean Flag that indicates whether the user's roles permit creating of records in this table. Possible values: true: Creating permitted false: Creating is not permitted

This example shows whether records can be created on the benefit_plan table.

canCreateBenefitPlan : function() { var now_GR = new GlideRecord('benefit_plan'); return now_GR.canCreate(); }

Scoped equivalent To use the canCreate() method in a scoped application, use the corresponding scoped method: canCreate() .

GlideRecord - canDelete()

Determines if the access control rules (which includes the user's role) permit deletion of records in this table.

Table 35. Parameters Name Type Description None

Table 36. Returns Type Description Boolean Flag that indicates whether the user's roles permit deleting of records in this table. Valid values: true: Deleting permitted false: Deleting is not permitted

var att = new GlideRecord('sys_attachment'); att.get('$[sys_attachment.sys_id]'); var sm = GlideSecurityManager.get(); var checkMe = 'record/sys_attachment/delete'; var canDelete = sm.hasRightsTo(checkMe, att); gs.log('canDelete: ' + canDelete);

Scoped equivalent To use the canDelete() method in a scoped application, use the corresponding scoped method: canDelete() .

GlideRecord - canRead()

Indicates whether the Access Control Rules (ACLs) permit the current user to read the current record within the associated GlideRecord table. This method evaluates all available ACLs for the specific resource.

Note: You shouldn’t use this method to check for table-level access. A single call to this method might not be sufficient to get a conclusive table-level access rights check result. To perform a table-level access check, use the GlideSecurityManager.hasRightsTo() method.

For additional information on ACLs, see Access Controls Evaluation Order .

Table 37. Parameters Name Type Description None

Table 38. Returns Type Description Boolean Flag that indicates whether the user's roles permit reading of the current record. Valid values: true: Reading permitted false: Reading isn't permitted

This example shows how to iterate through the Incident [incident] table and check if the user has read rights to each record.

var grTable = new GlideRecord('incident'); grTable.query(); while (grTable.next()) { if (grTable.canRead()) … }

Scoped equivalent To use the canRead() method in a scoped application, use the corresponding scoped method: canRead() .

GlideRecord - canWrite()

Determines if the access control rules (which includes the user's role) permit updates to records in this table.

Table 39. Parameters Name Type Description None

Table 40. Returns Type Description Boolean Flag that indicates whether the user's roles permit writing of records in this table. Valid values: true: Writing permitted false: Writing is not permitted

This example shows whether records can be written to the benefit_plan table.

canWriteBenefitPlan : function() { var now_GR = new GlideRecord('benefit_plan'); return now_GR.canWrite(); }

Scoped equivalent To use the canWrite() method in a scoped application, use the corresponding scoped method: canWrite() .

GlideRecord - changes()

Determines whether any of the fields in the record have changed.

Table 41. Parameters Name Type Description None

Table 42. Returns Type Description Boolean Flag that indicates whether there are changes in the specified record. Possible values: true: Fields in the specified record have changed. false: No fields have changed.

This example shows how to check if there are changes in an incident record.

var now_GR = new GlideRecord("incident"); now_GR.query(); now_GR.next(); if (now_GR.changes()) { gs.print("The incident record reported changes right after being read"); } else { gs.print("The incident record has not changed"); }

Scoped equivalent To implement this functionality in a scoped application, add code similar to the following:

var now_GR = new GlideRecord("incident"); now_GR.get("965c9e5347c12200e0ef563dbb9a7156"); now_GR.short_description = "test"; var elements = now_GR.getElements(); var hasChanged = false; for(var i=0; i

GlideRecord - deleteMultiple()

Deletes all records that satisfy the query.

This method does not delete attachments.

Dot-walking is not supported for this method. When using the deleteMultiple() function on referenced tables, all the records in the table are deleted. Also, when using deleteRecord() to cascade delete, prior calls to setWorkflow() on the same GlideRecord object are ignored.

Do not use deleteMultiple() on tables with currency fields. Always delete each record individually. Also, do not use this method with the chooseWindow() or setLimit() methods when working with large tables. The setLimit() method does not limit the number of records that are deleted with deleteMultiple() . All records returned by the query are deleted regardless of setLimit() .

The glide.db.forced.chunk.threshold system property sets the threshold above which forces chunk record deletions and updates. Chunking helps to prevent non-primary key deletions on huge tables from causing replication problems. For more information, see Available system properties .

Note: When using deleteMultiple() to cascade delete, prior calls to setWorkflow() on the same GlideRecord object are ignored.

Table 43. Parameters Name Type Description None

Table 44. Returns Type Description None

This example shows how to delete all inactive records from the Incident table.

var now_GR = new GlideRecord('incident'); now_GR.addQuery('active','false'); now_GR.query(); now_GR.deleteMultiple();

Scoped equivalent To use the deleteMultiple() method in a scoped application, use the corresponding scoped method: deleteMultiple() .

GlideRecord - deleteRecord()

Deletes a single record.

Table 45. Parameters Name Type Description None

Table 46. Returns Type Description Boolean Flag that indicates whether the record was successfully deleted. Possible values: true: Record was deleted. false: No record was found to delete.

This example shows how to delete all inactive records from the Incident table.

var rec = new GlideRecord('incident'); rec.addQuery('active',false); rec.query(); while (rec.next()) { gs.info('Inactive incident ' + rec.number + ' deleted'); rec.deleteRecord(); } Output:

Inactive incident INC0010010 deleted Inactive incident INC0010011 deleted

This example shows how to delete a record from the Incident table immediately after it is inserted. The incident GlideRecord must be reloaded after the insert before it can be deleted.

var grTicket = new GlideRecord('incident'); grTicket.initialize(); grTicket.short_description = 'Example ticket'; grTicket.work_notes = 'An update about the ticket'; var ins_sys_id = grTicket.insert(); // Insert the record grTicket.get(ins_sys_id); // Reload the inserted record gs.info(grTicket.deleteRecord()); // Delete the record Output:

true

Scoped equivalent To use the deleteRecord() method in a scoped application, use the corresponding scoped method: deleteRecord() .

GlideRecord - disableSysIdInOptimization()

Disables the default optimization that prevents an extra database query from running when a user passes in a large number of sys_ids, such as grIncident.addQuery('sys_id', 'IN', listOf200SysIds) .

This method only effects the GlideRecord on which it’s called. To modify the sys_id limit optimization for all GlideRecords, adjust the value in the glide.db.first_pass_sys_id_list_size.max system property (default 100).

If you don't either call this method or adjust the glide.db.first_pass_sys_id_list_size.max system property and pass a list that contains more sys_id entries than defined in glide.db.first_pass_sys_id_list_size.max , the returned value from GlideRecord.getRowCount() may be incorrect.

Table 47. Parameters Name Type Description None

Table 48. Returns Type Description None

The following code example shows how to use the disableSysIdInOptimiation() method to disable the sys_id limit optimization when passing an Incident sys_id list that contains 200 entries.

var listOf200SysIds = [ ... ]; // 200 comma separated sys_ids var grIncident = new GlideRecord('incident'); grIncident.addQuery('sys_id', 'IN', listOf200SysIds); grIncident.disableSysIdInOptimization(); // Rowcount could be incorrect without this method call grIncident.query(); if (grIncident.next()) gs.info("Rowcount: " + grIncident.getRowCount()); Output:

Rowcount: 200

GlideRecord - find(String columnName, String value)

Returns true if any record has a matching value in the specified column. If found, it also moves to the first record that matches, essentially executing next() until the record is returned.

Table 49. Parameters Name Type Description columnName String Field name to search. value String Value to check for in the specified field.

Table 50. Returns Type Description Boolean Flag that indicates whether any record within the current table has a matching value in the specified field. Possible values: true: Matching field. false: No matching field.

This example shows how to find a record in the Incident table with "Critical" in the short description field.

var now_GR = new GlideRecord("incident"); now_GR.query(); var shortDescription = "Critical"; if (now_GR.find("short_description", shortDescription)) { gs.print("An incident with the specified field value was found"); var recordID = now_GR.getValue("sys_id"); gs.print("Found in the following record: " + recordID); } else { gs.print("An incident with the specified field value was not found"); } Output

An incident with the specified field value was found Found in the following record: 552c48888c033300964f4932b03eb092

GlideRecord - get(Object name, Object value)

Returns the specified record in the current GlideRecord object.

This method accepts either one or two parameters. If only a single parameter is passed in, the method assumes that it is the sys_id of the desired record. If not found, it then tries to match the value against the display value. If two parameters are passed in, the first is the name of the column within the GlideRecord to search. The second is the value to search for. If multiple records are found, use next() to access the additional records.

Table 51. Parameters Name Type Description name Object Optional. Name of the instantiated GlideRecord column to search for the specified value parameter. If only a single parameter is passed in, the method assumes that this parameter is sys_id. value Object Value to match. For calculated fields, the value is matched as is rather than running a calculation on a scripted default value for a field in the record.

Table 52. Returns Type Description Boolean Indicates whether the requested record was located. Possible values: true: Record was found false: Record was not found

This example gets an incident record by passing in the sys_id.

var grIncident = new GlideRecord('incident'); var returnValue = grIncident.get('99ebb4156fa831005be8883e6b3ee4b9'); gs.info(returnValue); // logs true or false gs.info(grIncident.number); // logs Incident Number

This example gets an incident record by passing in the column in the record to search and the value to search for.

var grIncident = new GlideRecord('incident'); var returnValue = grIncident.get('caller_id.name','Sylivia Wayland'); gs.info(returnValue); // logs true or false gs.info(grIncident.number); // logs Incident Number

Scoped equivalent To use the get() method in a scoped application, use the corresponding scoped method: get() .

GlideRecord - getAttribute(String fieldName)

Returns the dictionary attributes on the specified field.

Table 53. Parameters Name Type Description fieldName String Field name for which to return the dictionary attributes

Table 54. Returns Type Description String Dictionary attributes

This example shows how to return the dictionary attributes for "tree_picker".

function doit() { var now_GR = new GlideRecord('sys_user'); now_GR.query("user_name","admin"); if (now_GR.next()) { gs.print("we got one"); gs.print(now_GR.location.getAttribute("tree_picker")); } }

Scoped equivalent To use the getAttribute() method in a scoped application, use the corresponding scoped method: getAttribute() .

GlideRecord - getClassDisplayValue()

Returns the table's label.

Table 55. Parameters Name Type Description None

Table 56. Returns Type Description String Label that identifies the table.

This example prints the label of the passed in table.

// Display the incident table label var now_GR = new GlideRecord("incident"); var value = now_GR.getClassDisplayValue(); gs.info("The table label is " + value + "."); Output:

The table label is Incident.

Scoped equivalent To use the getClassDisplayValue() method in a scoped application, use the corresponding scoped method: getClassDisplayValue() .

GlideRecord - getDisplayValue()

Retrieves the display value for the current record.

Display values are manipulated based on the actual value in the database and user or system settings and preferences.

The display value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user's time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.

Table 57. Parameters Name Type Description None

Table 58. Returns Type Description String Display value for the current record.

This example writes the display value of a specified incident record into the log.

var now_GR = new GlideRecord('incident'); now_GR.get('sys_id',' '); gs.info(now_GR.getDisplayValue()); Output:

INC0000050

Scoped equivalent To use the getDisplayValue() method in a scoped application, use the corresponding scoped method: getDisplayValue() .

GlideRecord - getED()

Returns the element's descriptor.

Table 59. Parameters Name Type Description None

Table 60. Returns Type Description GlideElementDescriptor The element's descriptor.

This example shows how to retrieve the name field for an incident GlideRecord.

grInc = new GlideRecord('incident'); grInc.getActiveQuery(); grInc.query(); if (grInc.next()) gs.info("Table Descriptor is - " + grInc.getED().getName()); Output:

Table Descriptor is - incident

Scoped equivalent To use the getED() method in a scoped application, use the corresponding scoped method: getED() .

GlideRecord - getElement(String fieldName)

Retrieves the GlideElement for a specified field.

The value returned by this method is a complete GlideElement object. The results are the equivalent of dot-walking a field value. For example, now_GR.getElement('short_description') provides the same result as nowGR.short_description .

In most cases, don’t use dot-walking to get values from a record. Dot-walking retrieves the entire object instead of the field value. Retrieving the object uses more storage and might cause undesirable results when used in arrays or in Service Portal .

Instead of retrieving the entire object, you can use one of the following methods to copy the field values:

getValue() getDisplayValue()

If dot-walking through a GlideElement object is necessary, use the toString() method to retrieve values. For example, you might need the current caller's manager sys_id to set another reference field. The following example shows how to get the string value instead of the entire object: var mgr = current.caller_id.manager.toString();

See also: GlideElement - toString() .

Table 61. Parameters Name Type Description fieldName String Column name for which to return the GlideElement object.

Table 62. Returns Type Description GlideElement The GlideElement for the specified column of the current record. Each object describes a field in the current GlideRecord.

This example shows how to obtain the GlideElement object for a passed in table and compare them with the expected system metadata values.

Scoped equivalent To use the getElement() method in a scoped application, use the corresponding scoped method: getElement() .

GlideRecord - getEncodedQuery()

Retrieves the query condition of the current result set as an encoded query string.

For details, see Encoded query strings .

Table 63. Parameters Name Type Description None

Table 64. Returns Type Description String

This example shows how to obtain the current encoded query to use later to create a read ACL role.

Scoped equivalent To use the getEncodedQuery() method in a scoped application, use the corresponding scoped method: getEncodedQuery() .

GlideRecord - getEscapedDisplayValue()

Retrieves the field value for the display field of the current record and adds escape characters for use in Jelly scripts.

Note: For this method to work, a display value must have been set on the associated table. For information on how to do this, see Select a field as the table display value .

Table 65. Parameters Name Type Description None

Table 66. Returns Type Description String Escaped value of the current table's display field.

This example shows how to obtain the user_name escaped display value from the User [sys_user] table.

var userName = "Michael J'ones"; var now_GR = new GlideRecord("sys_user"); if (now_GR.get("user_name", userName)) { gs.print("Deleting existing user=" + userName); now_GR.deleteRecord(); } now_GR.initialize();

var name = userName.split(" ", 2); var firstName = name[0]; var lastName = name[1]; now_GR.setValue("user_name", userName); gs.print("Name: " + now_GR.getValue("user_name")); now_GR.setValue("first_name", firstName); now_GR.setValue("last_name", lastName); var escapeValue = now_GR.getEscapedDisplayValue(); gs.print("Escaped name: " + escapeValue); Output:

Name: Michael J'ones Escaped name: Michael J\'ones

GlideRecord - getFields()

Retrieves a Java ArrayList of fields in the current record.

Table 67. Parameters Name Type Description None

Table 68. Returns Type Description Java ArrayList Fields in the current record

// This can be run in "Scripts - Background" for demonstration purposes // Get a single incident record var grINC = new GlideRecord('incident'); grINC.query(); grINC.next(); gs.print('Using ' + grINC.getValue('number')); gs.print(''); // getFields() returns a Java ArrayList var fields = grINC.getFields(); // Enumerate GlideElements in the GlideRecord object that have values gs.print('Enumerating over all fields with values:'); for (var i = 0; i < fields.size(); i++) { var glideElement = fields.get(i); if (glideElement.hasValue()) { gs.print(' ' + glideElement.getName() + '\t' + glideElement); } } gs.print(''); // Get a specific GlideElement: number gs.print('Getting the number field:'); for (var i = 0; i

GlideRecord - getLabel()

Retrieves the field's label.

Table 69. Parameters Name Type Description None

Table 70. Returns Type Description String The field's label

This example shows how to retrieve a label of a question field in the Requested Item table and print the label and its display name.

template.print("Summary of Requested items:\n"); var now_GR = new GlideRecord("sc_req_item"); now_GR.addQuery("request", current.sysapproval); now_GR.query(); while(now_GR.next()) { var nicePrice = now_GR.price.toString(); if (nicePrice != '') { nicePrice = parseFloat(nicePrice); nicePrice = nicePrice.toFixed(2); } template.print(now_GR.number + ": " + now_GR.quantity + " X " + now_GR.cat_item.getDisplayValue() + " at $" + nicePrice + " each \n"); template.print(" Options:\n"); for (key in now_GR.variables) { var now_V = now_GR.variables[key]; if(now_V.getGlideObject().getQuestion().getLabel() != '') { template.space(4); template.print(' ' + now_V.getGlideObject().getQuestion().getLabel() + " = " + vnow_V.getDisplayValue() + "\n"); } } }

Scoped equivalent To use the getLabel() method in a scoped application, use the corresponding scoped method: getLabel() .

GlideRecord - getLink(Boolean noStack)

Retrieves the link for the current record.

Table 71. Parameters Name Type Description noStack Boolean Flag that indicates whether to append the generated link to the end of the URL. For example: &sysparm_stack=[tablename]_list.do? sysparm_query=active=true . Valid values: true: Append link. false: Do not append link.

Default: false

Table 72. Returns Type Description String URL of the current record.

This example checks for attachments and adds the link if any are found.

var attachment_link = ''; var rec = new GlideRecord('sc_req_item'); rec.addQuery('sys_id', current.request_item); rec.query(); if(rec.next()){ if(rec.hasAttachments()){ attachment_link = gs.getProperty('glide.servlet.uri') + rec.getLink(); } }

Scoped equivalent To use the getLink() method in a scoped application, use the corresponding scoped method: getLink() .

GlideRecord - getLocation()

Retrieves the row number of the current record within the table.

Table 73. Parameters Name Type Description None

Table 74. Returns Type Description Number Zero-based row number of the current record within the table.

This example shows how to check if a record within the Incident table is not retrieved properly by comparing the record count to the record location number.

var now_GR = new GlideRecord("incident"); now_GR.addQuery("priority", "4"); now_GR.query(); for (x=0; x Output:

Location value: 0 Location value: 1 Location value: 2 Location value: 3

GlideRecord - getPlural()

Retrieves the plural label of the GlideRecord table.

For example, if the table name is "Change Request," this method returns "Change Requests."

Table 75. Parameters Name Type Description None

Table 76. Returns Type Description String The plural label of the GlideRecord's table.

This example shows checks the return values for getLabel() and getPlural() for the Incident table.

var now_GR = new GlideRecord('incident'); gs.print(now_GR.getLabel()); if (now_GR.getLabel() != 'Incident') throw "GlideRecord.getLabel() returned unexpected value for table 'incident': " + now_GR.getLabel();

gs.print(now_GR.getPlural()); if (now_GR.getPlural() != 'Incidents') throw "GlideRecord.getPlural() returned unexpected value for table 'incident': " + now_GR.getPlural(); "success";

Scoped equivalent To use the getPlural() method in a scoped application, use the scoped GlideRecord.getED() method to obtain the field's descriptor, and then use the scoped GlideElementDescriptor.getPlural() method.

GlideRecord - getRecordClassName()

Retrieves the class (table) name for the current record.

Table 77. Parameters Name Type Description None

Table 78. Returns Type Description String Class or table name

Scoped equivalent To use the getRecordClassName() method in a scoped application, use the corresponding scoped method: getRecordClassName() .

GlideRecord - getRelatedLists()

Retrieves a list of names and display values of related lists associated with the current GlideRecord.

Table 79. Parameters Name Type Description None

Table 80. Returns Type Description HashMap Hash map with names and display values of related lists.

This example shows how to obtain the list of names and display values of related lists associated with the current GlideRecord, store them in an array, and then print their values.

var now_GR = new GlideRecord('incident'); var c = now_GR.getRelatedLists().values().toArray(); var numElements = c.length; for( var i = 0; i

GlideRecord - getRelatedTables()

Retrieves a list of names and display values of tables that are referred to by the current record.

Table 81. Parameters Name Type Description None

Table 82. Returns Type Description HashMap Hash map with names and display values of related tables.

This example shows how to obtain the list of names and display values of tables related to the current GlideRecord, store them in an array, and then print their values.

var now_GR = new GlideRecord('incident'); var c = now_GR.getRelatedTables().values().toArray(); var numElements = c.length; for( var i = 0; i

GlideRecord - getRowCount()

Retrieves the number of rows (records) in the current GlideRecord object.

Note: GlideRecord returns matching records, so it might not be as efficient as GlideAggregate when you only need the number of records. If you only need a record count and aren’t iterating over the matching records, use GlideAggregate .

Retrieving the number records in GlideRecord or GlideAggregate

The GlideRecord getRowCount() and GlideAggregate getAggregate() APIs offer similar information. Use the following criteria to determine which option is best for you. The GlideRecord getRowCount() method tells you how many records have been returned from a query along with the records themselves. If you need the number of records in the result set before or after you iterate over the set to perform actions on the records, use this method. The GlideAggregate getAggregate() method retrieves only a count of records matching the query, excluding the actual records. The aggregate must be set on the GlideAggregate object prior to issuing the query.

Retrieving the records and count with GlideRecord getRowCount() The following example shows how to get the total number of active incidents with GlideRecord getRowCount() : var incident = new GlideRecord("incident"); incident.addQuery("active", true); incident.query(); gs.info("*** Total number of active incidents: {0}", incident.getRowCount());

Retrieving only the number of records with GlideAggregate getAggregate() The following example shows how to return only the number of records. Because this method doesn’t use the matching records, it’s much more efficient to use an aggregate query and return just the count. var incident = new GlideAggregate("incident"); incident.addQuery("active", true); incident.addAggregate("COUNT"); incident.query(); if (incident.next()) gs.info("*** Total number of active incidents: {0}", incident.getAggregate("COUNT"));

Deciding which option is best for your solution If you only want to retrieve the number of records, the GlideAggregate getAggregate() method is the best option. To use the individual records and retrieve the number of results, use GlideRecord getRowCount() , because a single query provides this functionality.

Note: If you want to use the getRowCount() method when using sys_id IN with more than 100 sys_id values, such as grIncident.addQuery('sys_id', 'IN', listOf200SysIds) , you must either: Call the disableSysIdInOptimization() method on the GlideRecord. Or, adjust the glide.db.first_pass_sys_id_list_size.max system property to a value higher than the number of sys_ids in the list. In addition, ensure that you call the .next() method before calling the getRowCount() method.

Table 83. Parameters Name Type Description None

Table 84. Returns Type Description Number Number of rows in the current GlideRecord.

The following example shows how to get the number of incidents from the Incident [incident] table.

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

Records in incident table: 6920

The following code example shows how to use the disableSysIdInOptimiation() method to disable the sys_id limit optimization when passing an Incident sys_id list that contains 200 entries.

var listOf200SysIds = [ ... ]; // 200 comma separated sys_ids var grIncident = new GlideRecord('incident'); grIncident.addQuery('sys_id', 'IN', listOf200SysIds); grIncident.disableSysIdInOptimization(); // Rowcount could be incorrect without this method call grIncident.query(); if (grIncident.next()) gs.info("Rowcount: " + grIncident.getRowCount()); Output:

Rowcount: 200

Scoped equivalent To use the getRowCount() method in a scoped application, use the corresponding scoped method: getRowCount() .

GlideRecord - getRowNumber()

Retrieves the row number set by saveLocation() or setLocation() .

To get the current row number, use getLocation() .

Table 85. Parameters Name Type Description None

Table 86. Returns Type Description Number Saved row number.

This example shows how to save a row location in the Users table and then obtain that row number.

var now_GR = new GlideRecord('sys_user'); now_GR.addQuery(); now_GR.query(); now_GR.saveLocation(5); var savedRow = now_GR.getRowNumber(); gs.print("Saved row: " + savedRow); Output:

Saved row: 5

GlideRecord - getTableName()

Retrieves the table name associated with this GlideRecord.

Table 87. Parameters Name Type Description None

Table 88. Returns Type Description String A table name

This example shows how to write the current table name in the system log.

gs.log('Table: ' + current.getTableName()); gs.log('Parent: ' + current.parent.sys_id); var item = new GlideRecord('sc_req_item'); item.addQuery('sys_id', current.parent.sys_id); item.query(); if(item.next()){ for(var variable in item.variable_pool) { gs.log(variable); var answer = eval ("item.variable_pool." + variable + ".getDisplayValue()"); gs.log(answer); } }

Scoped equivalent To use the getTableName() method in a scoped application, use the corresponding scoped method: getTableName() .

GlideRecord - getUniqueValue()

Gets the primary key of the record, which is usually the sys_id unless otherwise specified.

Table 89. Parameters Name Type Description None

Table 90. Returns Type Description String The unique primary key as a String, or null if the key is null.

var now_GR = new GlideRecord('kb_knowledge'); now_GR.query(); now_GR.next(); var uniqueid = now_GR.getUniqueValue(); gs.info(uniqueid);

GlideRecord - getValue(String fieldName)

Retrieves the string value of a specified field.

Note: If the Column Level Encryption Enterprise plugin is enabled and the instance has access to the key, this method returns clear text values from encrypted fields. If the instance does not have access to the key, this method returns the encrypted value. For more information, see Platform Encryption .

Table 91. Parameters Name Type Description fieldName String Name of a field for which to retrieve its value.

Table 92. Returns Type Description String Value of the specified element. Returns null if the field is empty or the field does not exist. Note: Boolean values return as "0" and "1" string values instead of false and true.

This example uses the getValue() method to obtain field values in two GlideRecords that are being compared.

function() { var jobExists = true; var jobGr; while(jobExists){ jobGr = new GlideRecord("sys_trigger"); jobExists = jobGr.get("name", "BaselineAPI: Create Baseline Job"); } var baselineGr = new GlideRecord('pm_project_baseline'); baselineGr.get('baseline_name','Test Project Baseline'); baselineGr.query(); Assert.assertEquals(true, baselineGr.next()); var projectGr = new GlideRecord('pm_project'); projectGr.get(this._project); Assert.assertEquals(projectGr.getValue('cost'), baselineGr.getValue('cost')); Assert.assertEquals((projectGr.getValue('capex_cost')), baselineGr.getValue('capex_cost')); Assert.assertEquals((projectGr.getValue('opex_cost')), baselineGr.getValue('opex_cost')); Assert.assertEquals((projectGr.getValue('budget_cost')), baselineGr.getValue('budget_cost')); Assert.assertEquals((projectGr.getValue('value')), baselineGr.getValue('value')); Assert.assertEquals((projectGr.getValue('npv_value')), baselineGr.getValue('npv_value')); Assert.assertEquals((projectGr.getValue('score')), baselineGr.getValue('score')); }

Scoped equivalent To use the getValue() method in a scoped application, use the corresponding scoped method: getValue() .

GlideRecord - GlideRecord(String tableName)

Creates an instance of the GlideRecord class for the specified table.

Table 93. Parameters Name Type Description tableName String Table to use.

var now_GR = new GlideRecord('incident');

GlideRecord - hasAttachments()

Determines if the current GlideRecord has any attachments.

Table 94. Parameters Name Type Description None

Table 95. Returns Type Description Boolean True if the current record has attachments, false otherwise.

This example checks for attachments and creates a link if there are any.

var attachment_link = ''; var rec = new GlideRecord('sc_req_item'); rec.addQuery('sys_id', current.request_item); rec.query(); if(rec.next()){ if(rec.hasAttachments()){ attachment_link = gs.getProperty('glide.servlet.uri') + rec.getLink(); } }

GlideRecord - hasNext()

Determines if there are any more records in the GlideRecord.

Table 96. Parameters Name Type Description None

Table 97. Returns Type Description Boolean True if there are more records in the query set, otherwise false.

This example shows how to call different functions based on whether there are additional records in the current GlideRecord.

if (now_GR.hasNext()) { dothis(); // found it, do it } else { dothat(); // didn't find it };

Scoped equivalent To use the hasNext() method in a scoped application, use the corresponding scoped method: hasNext() .

GlideRecord - initialize()

Creates an empty record within the current GlideRecord that is suitable for population before an insert.

Table 98. Parameters Name Type Description None

Table 99. Returns Type Description void

This example initializes a new record in the to_do table, creates a record, and then inserts it into the table.

var now_GR = new GlideRecord('to_do'); now_GR.initialize(); now_GR.name = 'first to do item'; now_GR.description = 'learn about GlideRecord'; now_GR.insert();

Scoped equivalent To use the initialize() method in a scoped application, use the corresponding scoped method: initialize() .

GlideRecord - insert()

Inserts a new record with the field values that have been set for the current record.

Table 100. Parameters Name Type Description None

Table 101. Returns Type Description String The sys_id of the inserted record, or null if the record is not inserted.

This example creates a new record in the to_do table, sets values for some record fields, and then inserts the record into the table.

var now_GR = new GlideRecord('to_do'); now_GR.initialize(); now_GR.name = 'first to do item'; now_GR.description = 'learn about GlideRecord'; now_GR.insert();

Scoped equivalent To use the insert() method in a scoped application, use the corresponding scoped method: insert() .

GlideRecord - insertWithReferences()

Inserts a new record and also inserts or updates any related records with the provided information.

Table 102. Parameters Name Type Description None

Table 103. Returns Type Description String sys_id of the inserted record or null if the record was not inserted.

If a reference value is not specified (as below), then a new user record is created with the provided first_name and last_name, and the caller_id value is set to this newly created sys_user record. The result is a new sys_user record with the provided first_name and last_name and a new incident record with the provided short_description and caller_id.

var inc = new GlideRecord('incident'); inc.initialize(); inc.short_description = 'New incident 1'; inc.caller_id.first_name = 'John'; inc.caller_id.last_name = 'Doe'; inc.insertWithReferences();

If a caller_id value is specified, then that caller_id is updated with the provided first_name and last_name. The result is a newly created incident record with values set for short_description and caller_id.

var inc = new GlideRecord('incident'); inc.initialize(); inc.short_description = 'New incident 1'; inc.caller_id.setDisplayValue('David Loo'); inc.caller_id.first_name = 'John'; inc.caller_id.last_name = 'Doe'; inc.insertWithReferences();

GlideRecord - instanceOf(String className)

Checks a table for the type\class of table.

Table 104. Parameters Name Type Description className String Name of a type or class of record.

Table 105. Returns Type Description Boolean True if table is an instance of the specified class.

This example checks if the passed in group/user is of the sys_user table/class type.

function(groupOrUser, label, grantedBy) { var labelCheck; var labelRecord; if (typeof label === "string") { labelRecord = new GlideRecord('label'); labelRecord.addQuery('name', label); labelRecord.query(); labelRecord.next(); } else { labelRecord = label; } if (groupOrUser.instanceOf('sys_user')) { labelCheck = new GlideRecord('label_user_m2m'); labelCheck.addQuery('user', groupOrUser.sys_id); } else { labelCheck = new GlideRecord('label_group_m2m'); labelCheck.addQuery('group', groupOrUser.sys_id); } labelCheck.addQuery('label', labelRecord.sys_id); if (grantedBy !== "undefined") { labelCheck.addQuery('granted_by', grantedBy.sys_id); } labelCheck.query(); return labelCheck.hasNext(); }

GlideRecord - isNewRecord()

Determines whether the current record has been inserted into the database.

This method returns true only if the newRecord() method has been called. This method is useful for scripted ACL, and in the condition of UI actions, but should not be used in background scripts.

Note: This method returns true for any new record during a business rule, or if the newRecord() method is used to initialize a record with default values and a unique ID (sys_id). In all other cases, it returns false.

Table 106. Parameters Name Type Description None

Table 107. Returns Type Description Boolean Flag that indicates whether the current record is new (has not been inserted into the database.) Possible values: true: Record is new. false: Record is not new.

This example checks if the new record has been inserted into the sys_user table.

var now_GR = new GlideRecord("sys_user"); now_GR.newRecord(); now_GR.setValue("user_name", "John Smith"); gs.print("Is this a new record: " + now_GR.isNewRecord());

var now_GR2 = new GlideRecord("sys_user"); now_GR2.addQuery("user_name", "Abel Tutor"); now_GR2.query(); now_GR2.next(); gs.print("Is this a new record: " + now_GR2.isNewRecord());

GlideRecord - isValid()

Determines if the current GlideRecord table exists.

Table 108. Parameters Name Type Description None

Table 109. Returns Type Description Boolean True if the table is exists (valid), otherwise false.

This example checks if the Incident table exists.

var testTable = new GlideRecord('incident'); gs.print(testTable.isValid());

Scoped equivalent To use the isValid() method in a scoped application, use the corresponding scoped method: isValid() .

GlideRecord - isValidField(String fieldName)

Determines if the specified field is defined in the current GlideRecord table.

Table 110. Parameters Name Type Description fieldName String Name of a field to check.

Table 111. Returns Type Description Boolean True if the field is defined in the table, otherwise false.

This example checks if the sys_class_name field exists in the cmds_software_instance table.

Scoped equivalent To use the isValidField() method in a scoped application, use the corresponding scoped method: isValidField() .

GlideRecord - isValidRecord()

Determines if the current record is valid.

Table 112. Parameters Name Type Description None

Table 113. Returns Type Description Boolean Flag indicating whether the current record is valid. Valid values: true: Record is valid. false: Past the end of the record set.

This example checks if the record identifier by the passed in sys_id is a valid record in the idea table.

function(sysId) { this.log('Inside acceptIdea sysId = ' + sysId); var now_GR = new GlideRecord('idea'); now_GR.get(sysId); this.log('now_GR.isValidRecord() = ' + now_GR.isValidRecord()); if(now_GR.isValidRecord()) { now_GR.setValue('state', 2); this.log('Updating gliderecord'); this.log('gliderecord table name' + now_GR.getTableName()); now_GR.update(); } }

Scoped equivalent To use the isValidRecord() method in a scoped application, use the corresponding scoped method: isValidRecord() .

GlideRecord - newRecord()

Creates a GlideRecord, sets the default values for the fields, and assigns a unique ID to the record.

Table 114. Parameters Name Type Description None

Table 115. Returns Type Description void

This example checks if the new record has been inserted into the sys_user table.

var now_GR = new GlideRecord("sys_user"); now_GR.newRecord(); now_GR.setValue("user_name", "John Smith"); gs.print("Is this a new record: " + now_GR.isNewRecord());

var now_GR2 = new GlideRecord("sys_user"); now_GR2.addQuery("user_name", "Abel Tutor"); now_GR2.query(); now_GR2.next(); gs.print("Is this a new record: " + now_GR2.isNewRecord());

Scoped equivalent To use the newRecord() method in a scoped application, use the corresponding scoped method: newRecord() .

GlideRecord - next()

Moves to the next record in the GlideRecord.

Use this method to iterate through the records returned by a GlideRecord query.

Note: This method fails if there is a field in the table called "next". If that is the case, use the method _next() .

Note: The if(myObj.next()) construct only processes the first record returned.

Table 116. Parameters Name Type Description None

Table 117. Returns Type Description Boolean Flag that indicates if there is a "next" record in the GlideRecord. Valid values: true: Move to the next record was successful. false: No more records in the result set.

This example shows how to iterate through the Incident table using the next() method.

var rec = new GlideRecord('incident'); rec.query(); while (rec.next()) { gs.print(rec.number + ' exists'); }

Scoped equivalent To use the next() method in a scoped application, use the corresponding scoped method: next() .

GlideRecord - _next()

Moves to the next record in the GlideRecord. Provides the same functionality as next() , intended to be used in cases where the GlideRecord has a column named next.

Table 118. Parameters Name Type Description None

Table 119. Returns Type Description Boolean True if there are more records in the query set.

var rec = new GlideRecord('sys_template'); rec.query(); while (rec._next()) { gs.print(rec.number + ' exists'); }

Scoped equivalent To use the _next() method in a scoped application, use the corresponding scoped method: _next() .

GlideRecord - operation()

Determines if an operation is insert, update, or delete.

Knowing the operation enables using current.operation() to make a generic business rule which can handle each operation uniquely.

For information on using the global variable current , refer to Global variables in business rules .

Table 120. Parameters Name Type Description None

Table 121. Returns Type Description String The current operation. Possible values: delete insert update

The following example shows how to use this method in a business rule. The operation() method detects which operation triggered an event and performs a different action depending for update and insert operations.

if(current.operation() == "update") { current.updates ++; } if(current.operation() == "insert") { current.updates = 0; }

This example shows how to use the operation() method to pass the operation value into the startFlow() method.

function createNewTransferOrder() { var toGr = new GlideRecord("alm_transfer_order"); toGr.initialize(); // From Stockroom - Southern California Warehouse toGr.setValue('from_stockroom', fromStockroomSysId); // To Stockroom - San Diego North - Pickup/Dropoff toGr.setValue('to_stockroom', toStockroomSysId); var transferOrder = toGr.insert();

if(toGr.get(transferOrder)){ // Start Transfer Order Workflow var wf = new Workflow(); var context = wf.startFlow(toWorkflowSysId, toGr, toGr.operation(),{}); createNewTransferOrderLine(transferOrder); } }

Scoped equivalent To use the operation() method in a scoped application, use the corresponding scoped method: operation() .

GlideRecord - orderBy(String fieldName)

Specifies a field name to use to order the query set. To order by multiple fields, call this method multiple times with different field values.

Table 122. Parameters Name Type Description fieldName String Field on which to order the query set.

Table 123. Returns Type Description void

This example shows how to order the query set by "order" and then by "number".

function UpdateProjectWBS(project) { var count = 0; var child = new GlideRecord('pm_project_task'); child.addQuery('parent', project.sys_id); child.orderBy('order'); child.orderBy('number'); child.query(); var len = child.getRowCount().toString().length; var seq = 0; while (child.next()) { count += UpdateProjectTaskWBS(child, 1, ++seq, len, ''); } gs.addInfoMessage(count + ' Project Tasks updated'); }

Scoped equivalent To use the orderBy() method in a scoped application, use the corresponding scoped method: orderBy() .

GlideRecord - orderByDesc(String, fieldName)

Specifies the field to use to order the query set in descending order.

Table 124. Parameters Name Type Description fieldName String Name of field to use to order the query results in descending order.

Table 125. Returns Type Description void

This example shows how to order the query set in ascending or descending order.

function(fiscalType, orderByDesc) { var now_GR = new GlideRecord('fiscal_period'); now_GR.addQuery('fiscal_type', fiscalType); if (orderByDesc) { now_GR.orderByDesc('fiscal_start_date_time'); } else { now_GR.orderBy('fiscal_start_date_time'); } now_GR.setLimit(1); now_GR.query(); now_GR.next(); return now_GR.sys_id; }

Scoped equivalent To use the orderByDesc() method in a scoped application, use the corresponding scoped method: orderByDesc() .

GlideRecord - query(String field, String value)

Runs a query against the table based on the filters specified in the query methods such as addQuery() and addEncodedQuery() .

This method queries the GlideRecord table as well as any references of the table. For more information, see Querying tables in script .

Note: This method fails if there is a field in the table called "query". If that is the case, use the method _query() . To run queries in a domain-separated instance, use the method queryNoDomain() .

See the GlideRecord article for details on building and running queries.

See also: GlideAggregate GlideQuery() GlideQueryCondition

Table 126. Parameters Name Type Description name String Optional - must also specify a value parameter. Name of the field to search for the value specified in the value parameter. Note: This method is typically run without arguments, but you can specify a name-value pair to filter records containing the specified values. If the parameters are specified, the "name=value" condition is added to the query.

value String Optional - must also specify a field parameter. Value to search for in the specified field parameter.

Table 127. Returns Type Description void

The following example shows how to scan the System Dictionary [sys_dictionary] for tables with a query field.

var tableArr = [];

var now_GR = new GlideRecord('sys_dictionary'); now_GR.addQuery('element', 'query'); now_GR.setLimit(6);

now_GR.query();

while(now_GR.next()){ tableArr.push(now_GR.name.getValue()); };

gs.info('The following tables have a field column called "query":');

for (i = 0; i Output:

The following tables have a field column called "query": cmdb_convert_bulk_services cmdb_multisource_query_status cmdb_qb_result_base cmdb_qb_table_mapping discovery_probes_cim_query kb_feedback

Scoped equivalent To use the query() method in a scoped application, use the corresponding scoped method: query() .

GlideRecord - _query(String field, String value)

Runs a query against the table based on the filters specified in the query methods such as addQuery() and addEncodedQuery() . This method is intended to be used on tables in which there's a column named "query", which might cause errors running the query() method.

This method queries the GlideRecord table as well as any references of the table. For more information, see Querying tables in script .

See the GlideRecord article for details on building and running queries.

See also: GlideAggregate GlideQuery() GlideQueryCondition

Table 128. Parameters Name Type Description name String Optional - must also specify a value parameter. Name of the field to search for the value specified in the value parameter. Note: This method is typically run without arguments, but you can specify a name-value pair to filter records containing the specified values. If the parameters are specified, the "name=value" condition is added to the query.

value String Optional - must also specify a field parameter. Value to search for in the specified field parameter.

Table 129. Returns Type Description void

The following example shows how query the Knowledge Feedback [kb_feedback] table and list KB articles with comments that include Excel.

var rec = new GlideRecord('kb_feedback'); rec.addQuery('comments', 'CONTAINS', 'Excel'); rec._query(); while (rec.next()) { gs.info(rec.getDisplayValue('article') + " comment: " + rec.getValue('comments')); } Output:

KB0000005 comment: Can you please add the version of Excel this applies to? All? KB0000005 comment: Does this work for all Excel versions? OSX and Windows alike?

Scoped equivalent To use the _query() method in a scoped application, use the corresponding scoped method: _query() .

GlideRecord - queryNoDomain(String field, String value)

Used in domain-separated instances. Similar to query() , runs the query against the table based on the filters specified by addQuery() and addEncodedQuery() , but ignores domains.

This method queries the GlideRecord table as well as any references of the table. For more information, see Querying tables in script .

Table 130. Parameters Name Type Description name String Optional - must also specify a value parameter. Name of the field to search for the value specified in the value parameter. Note: This method is typically run without arguments, but you can specify a name-value pair to filter records containing the specified values. If the parameters are specified, the "name=value" condition is added to the query.

value String Optional - must also specify a field parameter. Value to search for in the specified field parameter.

Table 131. Returns Type Description void

This example shows how to query the incident table for all domains.

var rec = new GlideRecord('incident'); rec.queryNoDomain(); while (rec.next()) { gs.print(rec.number + ' exists'); }

GlideRecord - restoreLocation()

Sets the current record to be the record that was saved with saveLocation() . If saveLocation() has not been called, the current record is set to the first record of the GlideRecord.

Table 132. Parameters Name Type Description None

Table 133. Returns Type Description void

This example shows how save the current record location, move to the next record, and then return back to the saved location.

function() { var now_GR = new GlideRecord("incident"); now_GR.query(); now_GR.next(); var firstID = now_GR.getValue("sys_id"); now_GR.next(); var restoreID = now_GR.getValue("sys_id"); now_GR.saveLocation(); now_GR.next(); var lastID = now_GR.getValue("sys_id"); now_GR.restoreLocation(); now_GR.next(); var thisID = now_GR.getValue("sys_id"); var progress = "first id=" + firstID + "\n\t last id=" + lastID + "\n\t saved id=" + restoreID + "\n\t restored id=" + thisID; gs.print("Progress:\n\t" + progress); }

GlideRecord - saveLocation()

Saves the current row number so you can return to this location using the restoreLocation() method.

Table 134. Parameters Name Type Description None

Table 135. Returns Type Description void

This example shows how save the current record location, move to the next record, and then return back to the saved location.

function() { var now_GR = new GlideRecord("incident"); now_GR.query(); now_GR.next(); var firstID = now_GR.getValue("sys_id"); now_GR.next(); var restoreID = now_GR.getValue("sys_id"); now_GR.saveLocation(); now_GR.next(); var lastID = now_GR.getValue("sys_id"); now_GR.restoreLocation(); now_GR.next(); var thisID = now_GR.getValue("sys_id"); var progress = "first id=" + firstID + "\n\t last id=" + lastID + "\n\t saved id=" + restoreID + "\n\t restored id=" + thisID; gs.print("Progress:\n\t" + progress); }

GlideRecord - setAbortAction(Boolean b)

Sets a flag to indicate if the next database action (insert, update, delete) is to be aborted.

Use in an onBefore business rule to prevent the database action from being done. The business rule continues to run after setAbortAction() is called. Calling setAbortAction() does not stop subsequent business rules from executing. Calling this method only prevents the database action from occurring.

Table 136. Parameters Name Type Description b Boolean True to abort next action, or false to allow the next action.

Table 137. Returns Type Description void

if ((!current.u_date1.nil()) && (!current.u_date2.nil())) { var start = current.u_date1.getGlideObject().getNumericValue(); var end = current.u_date2.getGlideObject().getNumericValue(); if (start > end) { gs.addInfoMessage('start must be before end'); current.u_date1.setError('start must be before end'); current.setAbortAction(true); } }

Scoped equivalent To use the setAbortAction() method in a scoped application, use the corresponding scoped method: setAbortAction() .

GlideRecord - setDisplayValue(String name, Object value)

Sets the specified field to the specified display value.

For a reference field this is the display value for the table. For a date/time this is the time in the caller's current timezone.

Table 138. Parameters Name Type Description name String Name of the field for which to set the display value. value Object Display value for the specified field.

Table 139. Returns Type Description void

var now_GR = new GlideRecord('incident'); now_GR.get('46f09e75a9fe198100f4ffd8d366d17b'); now_GR.setDisplayValue('opened_at','2011-02-13 4:30:00'); now_GR.update();

GlideRecord - setForceUpdate(Boolean force)

Updates the record even if fields have not changed.

Table 140. Parameters Name Type Description force Boolean True to update even if fields have not changed, otherwise false.

Table 141. Returns Type Description void

This example shows how to force a record in the itfm_cost_model table to update even without changes.

function() { gs.log("Update Script: Upgrade_cost_model_data.js started"); var now_GR = new GlideRecord("itfm_cost_model"); now_GR.initialize(); now_GR.addNullQuery("source_table"); now_GR.query(); while (now_GR.next()) { now_GR.setForceUpdate(true); var sourceTable = getSourceTable(now_GR.getValue('clone_from')); if(sourceTable){ now_GR.setValue("source_table", sourceTable); now_GR.setWorkflow(false); now_GR.update(); } } }

GlideRecord - setLimit(Number limit)

Sets the maximum number of records to return in the GlideRecord from a query.

Table 142. Parameters Name Type Description limit Number Limit for records to fetch.

Table 143. Returns Type Description void

This example sets the number of records returned in the query to a maximum of ten.

var now_GR = new GlideRecord('incident'); now_GR.orderByDesc('sys_created_on'); now_GR.setLimit(10); now_GR.query();

Scoped equivalent To use the setLimit() method in a scoped application, use the corresponding scoped method: setLimit() .

GlideRecord - setLocation(Number rowNumber)

Sets the current row location to the specified value.

Table 144. Parameters Name Type Description rowNumber Number Row number to set as the current row.

Table 145. Returns Type Description void

This example shows how to set the record position in the Incident table

verifySetLocation : function() { var now_GR = new GlideRecord("incident"); now_GR.query(); var recordIDs = new Array(); while(now_GR.next()) { recordIDs.push(now_GR.getValue("sys_id")); } for (var ix = recordIDs.length - 1; ix >= 0; ix--) { now_GR.setLocation(ix); Assert.assertEquals(recordIDs[ix], now_GR.getValue("sys_id"), "The entry retrieved for the index " + ix + " is not valid"); } }

GlideRecord - setNewGuid()

Generates a new GUID and sets it as the unique ID (sys_id) for the current record.

This function applies only to new records. You cannot change the GUID for an existing record.

Table 146. Parameters Name Type Description None

Table 147. Returns Type Description String Sys_id of the current record.

This example creates a new task record and stores the ID in the task_rel_task table.

var task = new GlideRecord ('task'); var tsk_id = task.setNewGuid(); task.description = "Request: " + current.request.number; task.description = task.description + "\n" + "Requested by: " + current.request.u_requested_by.name; task.description = task.description + "\n" + "Requested for: " + current.request.u_requested_for.name; task.description = task.description + "\n" + "Item: " + current.cat_item.name; var now_GR = new GlideRecord ('task_rel_task'); //link the incident to the request now_GR.parent = current.request; now_GR.child = tsk_id; now_GR.insert();

GlideRecord - setNewGuidValue (String guid)

Generates a new GUID and sets it as the unique ID for the current record, when inserting a new record.

Table 148. Parameters Name Type Description guid String Value for the new GUID.

Table 149. Returns Type Description void

This example generates a new GUID and sets it as the unique ID for the newly created cmdb_software_instance record.

var gobj = new GlideRecord('sys_db_object'); gobj.addQuery('name','cmdb_software_instance'); gobj.query(); if (!gobj.next()) { var si = new GlideRecord('cmdb_software_instance'); si.query(); var count = 0; while (si.next()) { if (!si.isValidField('sys_class_name')) { var ci = new GlideRecord('cmdb_ci'); ci.name = si.name; ci.setNewGuidValue(si.sys_id); ci.sys_class_name = 'cmdb_software_instance'; ci.insert(); count++; } }

Scoped equivalent To use the setNewGuidValue() method in a scoped application, use the corresponding scoped method: setNewGuidValue() .

GlideRecord - setQueryReferences(Boolean queryReferences)

Enables or disables using the reference field's display name when querying a reference field.

Table 150. Parameters Name Type Description queryReferences Boolean Flag indicating what time of data to generate. Valid values: true: Generate a string of display names. false: Generate a string of sys_ids.

Table 151. Returns Type Description void

GlideRecord - setUseEngines(Boolean e)

Disables or enables the running of any engines (approval rules / assignment rules).

Warning: Disabling the running of engines can have a significant impact on your ServiceNow® instance and how it operates. Ensure that you thoroughly test this change before deploying it to production.

Table 152. Parameters Name Type Description e Boolean Flag that indicates whether to enable or disable the running of any engines. Valid values: true: Enable engines false: Disable engines

Table 153. Returns Type Description void

This example shows how to disable engines and business rules before executing a query.

function auditOAuthInboundRequestsUsage(){ var now_GR = new GlideRecord("oauth_credential"); var oauthClient = now_GR.addJoinQuery("oauth_entity", "peer", "sys_id"); now_GR.addQuery("type", "access_token"); now_GR.addQuery("expires", ">", nowDateTime()); now_GR.addNullQuery("oauth_requestor_profile"); oauthClient.addCondition("active", "true"); oauthClient.addCondition("type", "client"); now_GR.setUseEngines(false); now_GR.setWorkflow(false); now_GR.query(); return now_GR.hasNext(); }

GlideRecord - setValue(String name, Object value)

Sets the specified field to the specified value.

Normally a script would do a direct assignment, for example, now_GR.category = value . However, if in a script the element name is a variable, then you can use now_GR.setValue(elementName, value) . When setting a value, ensure the data type of the field matches the data type of the value you enter.

If the value parameter is null, the record is not updated, and an error is not thrown. Note: This method cannot be used on journal fields, use GlideElement.setJournalEntry() instead.

Note: If the Column Level Encryption Enterprise plugin is enabled and the instance has access to the key, this method can insert encrypted data into encrypted fields. If the instance does not have access to the key, this method returns an error. For more information, see Platform Encryption .

Not for authentication with password2 fields

The setValue() method passes password2 data as clear text, which results in an error about expecting encrypted data. Additionally, using the setValue() method for password2 fields exposes data that should be encrypted. For password2 authentication, use the setDisplayValue() method instead.

See also: Deprecate GlideEncrypter usage of 3DES for password2 fields Alternatives to GlideEncrypter usage in knowledge base article KB1320986 Password2 encryption with the Key Management Framework (KMF)

Table 154. Parameters Name Type Description name String Name of the field whose value you want to set. value Object Value to set in the specified field.

Table 155. Returns Type Description None

This example shows how to set the value of the state field in the planned_task table.

function() { var topTask = new GlideRecord('planned_task'); topTask.setValue('state', -5); var childTask = new GlideRecord('planned_task'); childTask.setValue('state', -5); var s = new PlannedTaskStateManagement(childTask, topTask); var state = s.manageStateChange(false); Assert.assertEquals("-5", state); }

Scoped equivalent To use the setValue() method in a scoped application, use the corresponding scoped method: setValue() .

GlideRecord - setWorkflow(Boolean e)

Enables or disables the running of business rules that might normally be triggered by subsequent actions. If the e parameter is set to false, an insert/update will not be audited. Auditing only happens when the parameter is set to true for a GlideRecord operation.

Note: The setWorkflow() method is ignored when subsequently using either the deleteProblem() or deleteMultiple() methods to cascade delete.

Warning: Disabling the running of business rules can have a significant impact on your ServiceNow® instance and how it operates. Ensure that you thoroughly test this change before deploying it to production.

Table 156. Parameters Name Type Description e Boolean Flag that indicates whether to enable or disable the running of business rules. Valid values: true: Enable business rules false: Disable business rules

Table 157. Returns Type Description void

doit('name1','name2'); function doit(username1,username2) { var usr1 = new GlideRecord('sys_user'); var usr2 = new GlideRecord('sys_user'); var num = 0; if (usr1.get('user_name',username1) && usr2.get('user_name',username2)) { var ref; var dict = new GlideRecord('sys_dictionary'); dict.addQuery('reference','sys_user'); dict.addQuery('internal_type','reference'); dict.query(); while (dict.next()) { num = 0; ref = new GlideRecord(dict.name.toString()); ref.addQuery(dict.element,usr1.sys_id); ref.query(); while (ref.next()) { ref.setValue(dict.element.toString(),usr2.sys_id); ref.setWorkflow(false); ref.update(); num++; } if (num > 0) { gs.print(dict.element + ' changed from ' + usr1.user_name + ' to ' + usr2.user_name + ' in ' + num + ' ' + dict.name + ' records'); } } } }

Scoped equivalent To use the setWorkflow() method in a scoped application, use the corresponding scoped method: setWorkflow() .

GlideRecord - update(Object reason)

Updates the GlideRecord with any changes that have been made. If the record does not exist, it is inserted.

Table 158. Parameters Name Type Description reason Object Optional. Reason for the update. The reason appears in the audit record.

Table 159. Returns Type Description String The sys_id of the new or update record. Returns null if the update fails.

This example updates a record in the task_ci table.

var now_GR = new GlideRecord('task_ci'); now_GR.addQuery(); now_GR.query(); var count = now_GR.getRowCount(); if (count > 0) { var allocation = parseInt(10000 / count) / 100; while (now_GR.next()) { now_GR.u_allocation = allocation; now_GR.update(); } }

Scoped equivalent To use the update() method in a scoped application, use the corresponding scoped method: update() .

GlideRecord - updateMultiple()

Updates each GlideRecord in a stated query with a specified set of changes.

For information on adding journal entries, refer to the setJournalEntry() method.

The glide.db.forced.chunk.threshold system property sets the threshold above which forces chunk record deletions and updates. Chunking helps to prevent non-primary key deletions on huge tables from causing replication problems. For more information, see Available system properties .

Note: To ensure expected results, use the setValue() method instead of direct assignments. That is, use gr.setValue(' ', '4')); instead of gr. = 4 .

Note: Do not use this method with the chooseWindow() or setLimit() methods when working with large tables.

This method sets new values and does not clear existing values. To clear an existing value, use the setValue() method and set the field to null .

Table 160. Parameters Name Type Description None

Table 161. Returns Type Description None

This example shows how to update the state of all active incidents to 4 - "Awaiting User Info".

var now_GR = new GlideRecord('incident'); now_GR.addQuery('active', true); now_GR.setValue('state', 4); now_GR.updateMultiple();

Scoped equivalent To use the updateMultiple() method in a scoped application, use the corresponding scoped method: updateMultiple() .

GlideRecord - updateWithReferences(Object reason)

Updates a record and also inserts or updates any related records with the information provided.

Table 162. Parameters Name Type Description reason Object Reason for the updates. The reason is displayed in the audit record.

Table 163. Returns Type Description String The sys_id for the record being updated.

If processing an incident where the Caller ID is set to reference sys_user record 'John Doe,' then the following code would update John Doe's user record. If processing an incident where there's no caller ID specified, then the following code creates a new sys_user record with the provided information (first_name, last_name) and sets the caller ID value to the newly created sys_user record.

var inc = new GlideRecord('incident'); inc.get(inc_sys_id); // Looking up an existing incident record where 'inc_sys_id' represents the sys_id of a incident record inc.caller_id.first_name = 'John'; inc.caller_id.last_name = 'Doe'; inc.updateWithReferences(); }