📁 Client Side APIS and Methods

Question 1

What API is used to show qualified embedded help in the right sidebar?

& Is it ServerSide or ClientSide

Answer 1

The CustomEvent API
It is client side.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 2

What does the CustomEvent API do?

Answer 2

Shows qualified embedded help in the right sidebar.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 3

What API is the fireAll() method associated with?

Answer 3

The CustomEvent API

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 4

What needs to be done before using the fireAll() method?

Answer 4

Embedded Help qualifiers need to have been created before using the fireAll() method.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 5

What API is used to provide methods that translate text, in real time, into multiple languages using translation service providers?

& Is it Server Side or Client Side?

Answer 5

The DynamicTranslation API.
Client Side.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 6

What does the DynamicTranslation API do?

Answer 6

Provides methods that translate text, in real time, into multiple languages using translation service providers.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 7

What are the translation service providers supported by the DynamicTranslation API as of the Vancouver release?

Answer 7

• Microsoft Azure Translator Service
• IBM Watson Translator Service
• Google Cloud Translator Service

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 8

Who / what environment(s) is the DynamicTranslation API available for?

Answer 8

• Standard Clients
• Angular-based Service Portal clients

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 9

While interacting with the DynamicTranslation API, when should you use the dynamicTranslation class and when should you use the DynamicTranslation class?

Answer 9

dynamicTranslation - Used for Service Portal clients

DynamicTranslation - Used for standard clients

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 10

How can you use the DynamicTranslation API in a Service Portal widget?

Answer 10

You must inject the dynamicTranslation service into the widget client script function.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 11

What class is the getDetectedLanguage() method associated with

Answer 11

DynamicTranslation

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 12

What are the parameters passed for the getDetectedLanguage() method?

Answer 12

getDetectedLanguage(text, parms)
where text = string passed and evaluated to detect language
& parms = optional JSON object that contains additional translation parameters.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 13

What API is used to access data in a multi-row variable set (MRVS) when a model is open?
& is it Server side or Client side?

Answer 13

g_service_catalog
Client side.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 14

What environments is the g_service_catalog API available in?

Answer 14

All environments
Such as Service Portal, Now Platform, Workspace, and Now Mobile.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 15

What does the g_service_catalog API do?

Answer 15

Enables you to access data in a multi-row variable set (MRVS) when a model is open.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 16

What class is the getValue method associated with?

Answer 16

g_service_catalog

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 17

What does MRVS stand for and what does it mean?

Answer 17

Multi-Row Variable Set
a handy way to enter multiple rows as part of a Service Catalog request.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 18

What does the getValue() method do?

Answer 18

Returns the value of the specified field on the catalog item form when used in a client script on multi-row variable sets (MRVS).

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 19

What API is used to enable a UI Action or client script to open a specified record in an Agent Workspace tab?

Answer 19

The GlideAgentWorkspace (g_aw) API.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 20

What does the GlideAgentWorkspace (g_aw) API do?

Answer 20

Enables a UI Action or client script to open a specified record in an Agent Workspace tab.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 21

What class is the closeRecord() method associate with?

Answer 21

the g_aw (GlideAgentWorkspace) class

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 22

What does the closeRecord() method do?

Answer 22

Closes the currently open record, such as a form, in a subtab within Agent Workspace.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 23

What class is the openRecord() method associated with?

Answer 23

the g_aw (GlideAgentWorkspace) class

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 24

What does the openRecord() method do?

Answer 24

Opens a specific record, such as a form, in a subtub within Agent Workspace.

———————————————————————
📁 Client Side APIs and Methods Developer Documentation

Question 25

In what context is the openRecord() method able to be used?

Answer 25

This method is only available in the Agent Workspace client scripting environment or in a UI action on the workspace client script field ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 26

What API is used to enable a client script to call server-side code in a script include?

Answer 26

The GlideAjax API. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 27

What does the GlideAjax API do?

Answer 27

The GlideAjax class enables a client script to call server-side code in a script include. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 28

What are the general steps to use GlideAjax?

Answer 28

- 1: Create a GlideAjax instance by calling the GlideAjax constructor. As the argument to the constructor, specify the name of the script include class the contains the method you want to call. - 2: Call the addParam method with the sysparm_name parameter and the name of the script-include method you want to call. - 3: (Optional) Call the addParam method one or more times to provide the script-include code with other parameters it needs. - 4: Execute the server-side code by calling getXML() ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 29

What class is the addParam() method associated with?

Answer 29

GlideAjax ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 30

What does the addParam() method do?

Answer 30

Specifies a parameter name and value to be passed to the server-side function associated with this GlideAjax object. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 31

What does the getAnswer() method do?

Answer 31

Retrieves the results from a server-side method called from the client via the getXMLWait() method. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 32

What does the getXMLAnswer method do?

Answer 32

Calls the processor asynchronously and gets the answer element of the response in XML format. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 33

What class is the getXMLAnswer() method associated with?

Answer 33

GlideAjax ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 34

What class is the getAnswer() method associated with?

Answer 34

GlideAjax ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 35

What class is the method getXML() associated with?

Answer 35

GlideAjax ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 36

What does the method getXML() do?

Answer 36

Sends the server a request to execute the method and parameters associated with this GlideAjax object. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 37

What class is the method getXMLWait() associated with?

Answer 37

GlideAjax ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 38

What does the method getXMLWait() do?

Answer 38

Sends the server a request to execute the method and parameters associated with this GlideAjax object. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 39

What API is used to search DOM elements, search documents, or search JQuery elements?

Answer 39

The GlideDocument API. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 40

What does the GlideDocument (g_document) API do?

Answer 40

Provides the ability to search a DOM element, a document, or a JQuery element. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 41

What class is the getElement() method associated with?

Answer 41

GlideDocument (g_document) ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 42

What does the getElement() method do?

Answer 42

Returns a node found in the specified DOM based context or created from the HTML context. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 43

What class is the getElements() method associated with?

Answer 43

GlideDocument(g_document) ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 44

What does the getElements() method do?

Answer 44

Returns a node list found in the specified DOM based context or created if an HTML context is specified. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 45

What API is used for client-side interactions with actions, flows, and subflows?

Answer 45

GlideFlow ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 46

What is the GlideFlow API used for and what are some of the things that can be done with it?

Answer 46

Use the GlideForm JavaScript API for client-side interactions with actions, flows, and subflows. Using this API you can: - Start actions, flows, or subflows via a script - Get an existing execution - Get the status and any available outputs - Wait for the completion of an action, flow, or subflow ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 47

What is a *promise* in the context of an API returning *promise* objects?

Answer 47

A promise represents the eventual result of an asynchronous operation. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 48

What API provides methods to customize forms?

Answer 48

The GlideForm API ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 49

What does the GlideForm API do?

Answer 49

Provides method to customize forms ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 50

What does the addDecoration() method do within the context of the GlideForm API?

Answer 50

Adds an icon on a field’s label ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 51

What does the addErrorMessage() method do within the context of the GlideForm API?

Answer 51

Displays the specified error message at the top of the form This messages appears for approximately four seconds and then disappears. This timeout is not configurable at this time. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 52

What does the addFormMessage() method do within the context of the GlideForm API?

Answer 52

Displays a floating form message at the top of the form detail section. This message does not cover UI actions. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 53

What does the addInfoMessage() method do within the context of the GlideForm API?

Answer 53

Adds the specified informational message to the top of the form. This message appears for approximately four seconds. This timeout is not configurable at this time. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 54

What does the addOption() method do within the context of the GlideForm API?

Answer 54

Adds a choice to the end of a choice list field by default. If adding the parameter choice index, then it adds a choice to the list field at the position specified. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 55

What does the clearMessages() method do within the context of the GlideForm API?

Answer 55

Removes only informational and error messages from the top of the form. Removes informational and error messages added with addInfoMessage() and addErrorMessage() ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 56

What’s the difference between the clearMessages() method and the clearAllFormMessages() method within the context of the GlideForm API?

Answer 56

clearMessages() affects informational and error messages (populated using the addInfoMessage() and addErrorMessage() methods), while clearAllFormMessages() removes form messages of any type. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 57

What does the clearAllFormMessages() method do within the context of the GlideForm API?

Answer 57

Removes all form messages of any type. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 58

What does the clearOptions() method do within the context of the GlideForm API?

Answer 58

Removes all options from the choice list. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 59

What does the clearValue() method do within the context of the GlideForm API?

Answer 59

Removes any value(s) from the field. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 60

What does the disableAttachments() method do within the context of the GlideForm API?

Answer 60

Prevents file attachments from being added. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 61

What does the enableAttachments() method do within the context of the GlideForm API?

Answer 61

Allows file attachments to be added. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 62

What does the flash() method do within the context of the GlideForm API?

Answer 62

Used to draw attention to a particular field. Flashes the specified color for a specified duration of time in the specified field. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 63

What does the getActionName() method do within the context of the GlideForm API?

Answer 63

Returns the most recent action name, or, for a client script, the sys_id or the UI action clicked. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 64

What does the getBooleanValue() method do within the context of the GlideForm API?

Answer 64

Returns a boolean value for the specified field. Returns false if the field value is false or undefined, otherwise returns true. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 65

What does the getControl() method do within the context of the GlideForm API?

Answer 65

Returns the HTML element for the specified field. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 66

What does the getDecimalValue() method do within the context of the GlideForm API?

Answer 66

Returns the decimal value of the specified field. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 67

What does the getDisplayBox() method do within the context of the GlideForm API?

Answer 67

Gets the display value from a form in the core UI. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 68

What does the getDisplayValue() method do within the context of the GlideForm API?

Answer 68

Gets the display value from a form in Service Portal. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 69

What does the getElement() method do within the context of the GlideForm API?

Answer 69

Returns the HTML element specified by parameter. Compound fields may contain several HTML elements. This method is generally not necessary as there are built-in methods that use the fields on a form. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 70

What does the getFormElement() method do within the context of the GlideForm API?

Answer 70

Returns the HTML element for the form ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 71

What does the getHelpTextControl() method do within the context of the GlideForm API?

Answer 71

Returns the HTML element of the help text for the specified field. This method is applicable to service catalog variables only. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 72

What does the getIntValue() method do within the context of the GlideForm API?

Answer 72

Returns the integer value of the field specified ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 73

What does the getLabelOf() method do within the context of the GlideForm API?

Answer 73

Returns the plain text value of the field label. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 74

What does the getOption() method do within the context of the GlideForm API?

Answer 74

Returns the option element for a selected box named *fieldName* where *choiceValue* matches the option value. getOption(fieldName, choiceValue) NOTE: This method does not work on read-only fields. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 75

What does the getReference() method do within the context of the GlideForm API?

Answer 75

Returns the GlideRecord for a specified field. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 76

Why is using a callback function with the getReference() method so important within the context of the GlideForm API?

Answer 76

If a callback function is not present, the routine runs synchronously and processing halts (causing the browser to appear to hang) while waiting on a server response. If a callback function is present, the routine runs asynchronously. The browser (and script) processing continues normally until the server returns the reference value, at which time, the callback function is invoked. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 77

What does the getRelatedListNames() method do within the context of the GlideForm API?

Answer 77

Returns an array of related list names from the current form ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 78

What does the getSections() method do within the context of the GlideForm API?

Answer 78

Returns an array of the form’s sections. This method is not available in the mobile platform. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 79

What does the getTableName() method do within the context of the GlideForm API?

Answer 79

Returns the name of the table to which record belongs. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 80

What does the getUniqueValue() method do within the context of the GlideForm API?

Answer 80

Returns the sys_id of the record displayed in the form. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 81

What does the getValue() method do within the context of the GlideForm API?

Answer 81

Returns the value of the specified form field. This method also supports values from a multi-row variable set (MRVS). ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 82

How do you obtain data from fields within an MRVS (multi row variable set)?

Answer 82

First use - JSON.parse(getValue(‘’’) || ‘[]’) to obtain the MRVS array. and then use indexing to access the fields within the row objects. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 83

What does the hideAllFieldMsgs() method do when passed no parameters within the context of the GlideForm API?

Answer 83

Hides all field messages. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 84

What does the hideAllFieldMsgs() method do when passed a String type parameter within the context of the GlideForm API?

Answer 84

Hides all field messages of the specified type (the string parameter) ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 85

What does the hideErrorBox() method do within the context of the GlideForm API?

Answer 85

Hides the error message placed by showErrorBox() Whenever possible, use hideFieldMsg() rather than this method. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 86

What does the hideFieldMsg() method do when its second parameter is passed as true within the context of the GlideForm API? What if it is passed as false or not included?

Answer 86

hideFieldMsg(String fieldName, Boolean clearAll) When the clearAll parameter is true, all messages for the field are cleared. When false, only the last message is removed. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 87

What does the hideRelatedList() method do within the context of the GlideForm API?

Answer 87

Hides the specified related list on the form. This method is not available on the mobile platform. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 88

What does the hideRelatedLists() method do within the context of the GlideForm API?

Answer 88

Hides all related lists on the form. This method is not available on the mobile platform. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 89

What does the isLiveUpdating() method do within the context of the GlideForm API? What is an example of how this could be used?

Answer 89

Returns true while a live update is being done on the record the form is showing. This can be used in an onChange() client script to determine if a change to the record is because of a live update from another session. The client script can then device what action to take, or not to take. This applies to systems using Core UI with live forms enabled. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 90

What does the isMandatory() method do within the context of the GlideForm API?

Answer 90

Returns true if the field is mandatory ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 91

What does the isNewRecord() method do within the context of the GlideForm API?

Answer 91

Returns true if the record has never been saved? ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 92

What does the isSectionVisible() method do within the context of the GlideForm API?

Answer 92

Returns true if the section is visible The isSectionVisible() method is not supported in Workspace ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 93

What does the onUserChangeValue() method do within the context of the GlideForm API?

Answer 93

Registers a custom event listener that detects when any field in the current form is modified by a user. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 94

What does the refreshSlushbucket() method do within the context of the GlideForm API?

Answer 94

You can update a list collector variable. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 95

What does the removeOption() method do within the context of the GlideForm API?

Answer 95

Removes the specified option from the choice list. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 96

What does the removeDecoration() method do within the context of the GlideForm API?

Answer 96

Removes the icon from the specified field that matches the icon and title. This method is not supported by Service Catalog. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 97

What does the save() method do within the context of the GlideForm API?

Answer 97

Saves the record without navigating away (update and stay). ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 98

What does the setMandatory() method do within the context of the GlideForm API?

Answer 98

Makes the specified field mandatory. Whenever possible, use a UI policy rather than this method. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 99

What does the setDisplaySection() method do within the context of the GlideForm API?

Answer 99

Shows or hides a section. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 100

What does the setValue() method do within the context of the GlideForm API?

Answer 100

Sets the value of a specified form field to the value of a specified display value in a reference record ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 101

What is important to remember about performance and the parameters in regards to the setValue() method within the context of the GlideForm API?

Answer 101

setValue(String fieldName, String value, String displayValue) Neglecting to pass information to the displayValue parameter could result in a round trip and thus decrease performance. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 102

What is something important to remember when using the setValue() method to set multiple reference values for a list collector field within the context of the GlideForm API?

Answer 102

Pass arrays into the parameters. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 103

What is something important to remember about using the setValue() method in OnChange client scripts within the context of the GlideForm API?

Answer 103

The setValue() method can cause a stack overflow when used in an OnChange client script. This is because every time the value is set, it will register as a change, which may re-trigger the OnChange client script. To prevent this, perform a check that will validate that the new value will be different from the old value.d ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 104

What does the showErrorBox() method do within the context of the GlideForm API?

Answer 104

Displays an error message under the specified form field (either a control object or the name of the field). If the control or field is currently off the screen and the scroll form parameter is true, the form scrolls to the control or field. A global property (glide.ui.scroll_to_message_field) is available that controls automatic message scrolling when the form field is off screen (scrolls the form to the control or field). The showFieldMsg() method is a similar method that requires a type parameter. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 105

What does the showFieldMsg() method do within the context of the GlideForm API?

Answer 105

Displays either an informational or error message under the specified form field (either a control object or the name or the field.) If the control or field is off the screen, the form is scrolled to the field. A global property (glide.ui.scroll_to_message_field) is available that controls automatic message scrolling when the form field is off screen (scrolls the form to the control or field) The showErrorBox() method is a shorthand method that does not require the type parameter. This method does not work with the journal_field type field in Core UI. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 106

What does the setDisabled() method do within the context of the GlideForm API?

Answer 106

Makes the specified field available or unavailable ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 107

What does the setDisplay() method do within the context of the GlideForm API?

Answer 107

Displays or hides a field. This method cannot hide a mandatory field with no value. If the field is hidden, the space is used to display other items. Whenever possible, use a UI policy instead of this method. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 108

What does the setLabelOf() method do within the context of the GlideForm API?

Answer 108

Sets the plain text value of the field label. This method is not supported by Service Catalog ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 109

What does the setReadOnly() method do within the context of the GlideForm API?

Answer 109

Makes the specified field read-only or editable. Whenever possible, use a UI policy instead of this method. To make a mandatory field read-only, you cannot use the setValue() method to update the value of that field. If you need to set the value in this way, you must set the readOnly value to false. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 110

What does the setValue() method do within the context of the GlideForm API?

Answer 110

Sets the value of a specified form field to the passed in value. This method also supports setting values in multi-row variable sets (MRVS). You must first use JSON.parse(getValue(‘’)) to obtain the MRVS array and then use indexing to update the fields within the row objects. Once all values are updates in the MRVS, use the setValue() method to save the update MRVS array. Note: The method setValue() can cause a stack overflow when used in an OnChange client script. This is because every time the value is set, it will register as a change, which may re-trigger the OnChange client script. To prevent this, perform a check that will validate that the new value will be different from the old value. For example, before performing setValue(shortDesc, newValue.toUpperCase());, validate that the short description is not already uppercase. This will prevent the client script from applying the toUpperCase() more than once. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 111

What does the setVisible() method do within the context of the GlideForm API?

Answer 111

Displays or hides the field. This method cannot hide mandatory fields with no value. Use UI Policy rather than this method whenever possible. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 112

What does the showErrorBox() method do within the context of the GlideForm API?

Answer 112

Displays an error message under the specified form field (either a control object or the name of the field) If the control or field is currently off the screen, the form scrolls to the control or field. A global property (glide.ui.scroll_to_message_field) is available that controls automatic message scrolling when the form field is off the screen (scrolls the form to the control or field) the showFieldMsg() method is a similar method that requires a type parameter. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 113

What does the showRelatedList() method do within the context of the GlideForm API?

Answer 113

Displays the specified related list on the form. This method is not available on the mobile platform. If this method is run on a mobile platform, no action occurs. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 114

What does the showRelatedLists() method do within the context of the GlideForm API?

Answer 114

Displays all the form’s related lists.This method is not available on the Mobile platform. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 115

What does the submit() method do when there is no parameter passed within the context of the GlideForm API?

Answer 115

Saves the record. The user is taken away from the form, returning them to where they were. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 116

What does the submit(String verb) method do when it is passed a parameter within the context of the GlideForm API?

Answer 116

Performs the UI action specified by the parameter. Where *String* above is an “action_name from a sys_ui_action record The action name must be for a visible form button.” ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 117

What API is used to Create a globally unique identifier?

Answer 117

The GlideGuid API ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 118

What does the GlideGuid API do?

Answer 118

It create a globally unique identified 32 characters long, or as specified with the optional length argument ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 119

What API is used to manipulate lists?

Answer 119

GlideList2 GlideListV3 Depreciated GlideList (Now Experience) Not applicable to core UI ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 120

What does the GlideList2 API do?

Answer 120

GlideList2 is a JavaScript class used to customize (v2) lists. The variable g_list is used to access a specified list object. The g_list variable is not available to the related lists form link UI action. It is available to the lists form link UI action. These methods are used in UI Context Menus and UI Actions ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 121

What does the addFilter() method do?

Answer 121

Adds a single term to the list query filter. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 122

Which API should you use 98% of the time? - GlideList (Now Experience) - GlideList2 - GlideListV3

Answer 122

- GlideList2 - GlideListV3 is depreciated - GlideList (Now Experience) is only applicable to working within the Now Experience ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 123

What does the get() method do when passed an object DOMelement?

Answer 123

Returns the GlideList2 object for the list that contains the specified item. The DOMelement parameter, of the object type, is the DOM element ID for the list for which you want the GlideList2 object. It either returns an object or returns null ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 124

What does the get() method do when pass a String ListID?

Answer 124

Returns the GlideList2 object for the list specified. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 125

What does the getChecked() method do?

Answer 125

Returns a comma-separated list of the sys_ids for the items that are checked in the associated list. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 126

What does the getFixedQuery() method do?

Answer 126

Returns the fixed query. A fixed query is the part of the query that cannot be removed from the breadcrumb (ie, it is fixed for the user). It is specified by including a sysparm_fixed_query parameter for the application module. ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 127

What does the getGroupBy() method do?

Answer 127

Returns the field or comma-separated list of fields that are used to group the list ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 128

What does the getListName() method do?

Answer 128

Returns the name of the list, which is usually the table name ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 129

What does the getOrderBy() method do?

Answer 129

Returns the first field used to order the list ——————————————————————— 📁 Client Side APIs and Methods Developer Documentation

Question 130

What does the getParentTable() method do?

Answer 130

Returns the name of the parent table for a related list (the table associated with the form)

Question 131

What does the getQuery() method do?

Answer 131

Returns the encoded query string for the list.

Question 132

What does the getRelated() method do?

Answer 132

Returns the related list field that associated the related list to the parent form.

Question 133

What does the getTableName() method do?

Answer 133

Returns the table name for the list.

Question 134

What does the getView() method do?

Answer 134

Returns the view used to display the list.

Question 135

What does the getTitle() method do?

Answer 135

Returns the list title.

Question 136

What does the isUserList() method do?

Answer 136

Returns *true* if the list has been personalized by the user by choosing the list mechanic and changing the list layout.

Question 137

What does the refresh() method do?

Answer 137

Refreshes the list. The orderBy part of the list filter is ignored so that the list uses its natural ordering when it is refreshed.

Question 138

What does the refreshedWithOrderBy() method do?

Answer 138

Refreshes the list. The orderBy part of the list filter is included if it is specified for the list.

Question 139

What does the setFilter() method do?

Answer 139

Sets the encoded query string for the list, ignoring the orderBy and groupBy parts of the query string.

Question 140

What does the setFilterAndRefresh() method do?

Answer 140

Sets the encoded query string for the list, including the orderBy and groupBy if specified, and then refreshes the list using the new filter.

Question 141

What does the setFirstRow() method do?

Answer 141

Sets the first row that appears in the list when the list is refreshed.

Question 142

What does the setGroupBy() method do?

Answer 142

Sets the list groupBy criteria for a single field.

Question 143

What does the setOrderBy() method do?

Answer 143

Sets the orderBy criteria for the list.

Question 144

What does the setRowsPerPage() method do?

Answer 144

Sets the number of rows per page to display on a list.

Question 145

What does the showHideGroups() method do?

Answer 145

Shows or hides all the groups within the list and saves the current collapsed/expanded state of the groups as a user preference.

Question 146

What does the showHideList() method do?

Answer 146

Displays or hides the list and saves the current collapsed/expanded state of the list as a user preference.

Question 147

What does the sort() method do?

Answer 147

Sorts the list in ascending order and sets the fields as an orderBy column.

Question 148

What does the sortDescending() method do?

Answer 148

Sorts a single field in the list in descending order and sets the field as an orderByDescField column.

Question 149

What does the toggleList() method do?

Answer 149

Toggles the display of the list and saves the current collapsed/expanded state of the list as a user preference.

Question 150

What does the toggleListNoPref() method do?

Answer 150

Toggles the display of the list but does not save the current collapsed/expanded state of the list as a user preference.

Question 151

What API is used to customize UI Context Menu items? & Server-Side or Client-Side?

Answer 151

GlideMenu Client side

Question 152

What does the GlideMenu API do?

Answer 152

Used to customize UI Context Menu items.

Question 153

What does the clearImage() method do?

Answer 153

Clears the image for an item.

Question 154

What does the clearSelected() method do?

Answer 154

Clears any selection images from items in the menu.

Question 155

What does the getItem() method do?

Answer 155

Returns a menu item by item ID. It can be necessary to find an item in a menu so that it can be changed before being displayed. Each menu item may be assigned a unique ID when the menu item is created.

Question 156

What does the setDisable() method do?

Answer 156

Disables a menu item so that it cannot be selected. The disabled menu items is displayed in a lighter color (grayed out) to indicate it was disabled.

Question 157

What does the setEnabled() method do?

Answer 157

Enables the specified menu item.

Question 158

What does the setHidden() method do?

Answer 158

Hides the specified menu item. When hiding menu items, the separator bars are not adjusted, so it is possible to end up with the menu showing two separators in a row.

Question 159

What does the setImage() method do?

Answer 159

Sets an image for an item. (GlideMenu API)

Question 160

What does the setLabel() method do?

Answer 160

Sets the display label for a menu item. The label may contain HTML.

Question 161

What does the setvisible() method do?

Answer 161

Displays the specified item.

Question 162

What API is used to display a form in a GlideModal?

Answer 162

GlideModalForm

Question 163

What does the GlideModalForm API do?

Answer 163

Displays a form in a GlideModal General usage of the GlideModalForm class involves creating the object, setting any preferences, and then rendering the GlideModalForm.

Question 164

What does the GlideModalForm() method do?

Answer 164

Creates an instance of the GlideModalForm class

Question 165

What does the addParm() method do in the context of the GlideModalForm class.

Answer 165

Sets the specified form field to the specified value.

Question 166

What does the setSysID() method do in the context of the GlideModalForm class?

Answer 166

Sets the object’s sys_id preference.

Question 167

What does the setCompletionCallback() method do in the context of the GlideModalForm class?

Answer 167

Sets the function to be called when the form has been successfully submitted and processed by the server.

Question 168

What does the setOnloadCallback() method do in the context of the GlideModalForm class?

Answer 168

Sets the function to be called after the form has been loaded.

Question 169

What does the render() method do in the context of the GlideModalForm class?

Answer 169

Shows the modal form.

Question 170

Which of the following API should you use? - GlideWindow - GlideModal - GlideDialogWindow

Answer 170

GlideModal - This is a fully-featured replacement for GlideWindow and GlideDialogWindow

Question 171

What does the GlideModal API do?

Answer 171

Provides methods for displaying a content overlay.

Question 172

What does the GlideModal() method do within the context of the GlideModal class?

Answer 172

Creates an instance of the GlideModalV3 class

Question 173

What does the get() method do within the context of the GlideModal class?

Answer 173

Get a GlideModal object by ID

Question 174

What does the getPreference() method do within the context of the GlideModal class?

Answer 174

Returns the value of the specified preference (property)

Question 175

What does the render() method do within the context of the GlideModal class?

Answer 175

Renders the UI page in the modal.

Question 176

What does the renderWithContent() method do within the context of the GlideModal class?

Answer 176

Display a modal with the specified HTML content. The renderWithContent() method replaces the render() method, and does not request a UI page to render.

Question 177

What does the setPreference() method do within the context of the GlideModal class?

Answer 177

Sets the specified field on the current form to the specified value.

Question 178

What does the setPreferenceAndReload() method do within the context of the GlideModal class?

Answer 178

Set the properties and reload the modal.

Question 179

What does the setTitle() method do within the context of the GlideModal class?

Answer 179

Sets the title of the modal.

Question 180

What does the setWidth() method do within the context of the GlideModal class?

Answer 180

Sets the width in pixels The modal is boxed into predefined system sizes

Question 181

What does the switchView() method do within the context of the GlideModal class?

Answer 181

Change the view and reload the modal.

Question 182

What does the GlideNavigation API do?

Answer 182

Provides methods to control and refresh the navigator and main frame.

Question 183

What API provides methods to control and refresh the navigator and main frame?

Answer 183

The GlideNavigation API

Question 184

What does the open() method do within the context of the GlideNavigation API?

Answer 184

Redirects to a new URL

Question 185

What does the openPopup () method do within the context of the GlideNavigation API?

Answer 185

Opens the specified URL in a popup window.

Question 186

What does the openRecord() method do within the context of the GlideNavigation API?

Answer 186

Redirects to a record. The record displays in the navigator frame.

Question 187

What does the refreshNavigator() method do within the context of the GlideNavigation API?

Answer 187

Refreshes the content in the navigator frame

Question 188

What does the reloadWindow() method do within the context of the GlideNavigation API?

Answer 188

Reloads the current frame.

Question 189

What does the GlideNotification API do?

Answer 189

Provides the ability to show messages over the page content.

Question 190

What does the show() method do within the context of the GlideNotification API?

Answer 190

Displays the specified string over the page content as the specified type of message. When the duration timer expires, the message is removed.

Question 191

What does the Client-Side GlideRecord API do?

Answer 191

GlideRecord is used for database operations and interactions. Client-side GlideRecord is not supported in scoped applications. Instead, use GlideAjax, or use REST APIs.

Question 192

What does the GlideRecord() method do within the context of the client-side GlideRecord API?

Answer 192

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

Question 193

What does the addOrderBy() method do within the context of the client-side GlideRecord API?

Answer 193

Adds a column to order by in the query.

Question 194

What does the addQuery() method do within the context of the client-side GlideRecord API?

Answer 194

Adds a query to return records where the specified field name is equal to a specified value (or is in a list of values)

Question 195

What does the addQuery() method do within the context of the client-side GlideRecord API when it is passed an operator parameter?

Answer 195

Adds a filter to return records where the field meets the specified condition (field, operator, value)

Question 196

What does the deleteRecord() method do within the context of the client-side GlideRecord API?

Answer 196

Deletes the current record and calls the specified response function when complete.

Question 197

What does the get() method do within the context of the client-side GlideRecord API?

Answer 197

Executes a GlideRecord query for a record with the specified sys_id. This method is expected to be used to query for single records, so a next operation is performed before returning.

Question 198

What does the getEncodedQuery() method do within the context of the client-side GlideRecord API?

Answer 198

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

Question 199

What does the getLimit() method do within the context of the client-side GlideRecord API?

Answer 199

Returns the limit for records to be returned by the GlideRecord query

Question 200

What does the getTableName() method do within the context of the client-side GlideRecord API?

Answer 200

Retrieves the name of the table associated with this GlideRecord

Question 201

What does the hasNext() method do within the context of the client-side GlideRecord API?

Answer 201

Determines if there are any more records in the GlideRecord, returns true if there is.

Question 202

What does the insert() method do within the context of the client-side GlideRecord API?

Answer 202

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

Question 203

What does the next() method do within the context of the client-side GlideRecord API?

Answer 203

Moves to the next record in the GlideRecord

Question 204

What does the orderBy() method do within the context of the client-side GlideRecord API?

Answer 204

Specifies an orderBy column. May be called more than once to order by multiple columns.

Question 205

What does the query() method do within the context of the client-side GlideRecord API?

Answer 205

Runs the query to the server against the table based on the addQuery() filter. This method queries the GlideRecord table as well as any references of the table. Do not make synchronous query calls. Performing a query without a response function makes the call synchronous, which means that the display will wait for the query response before continuing.

Question 206

What does the setEncodedQuery() method do within the context of the client-side GlideRecord API?

Answer 206

Adds a specified encoded query string to the current query clause. This method enables you to specify complex filters (encoded query strings) in a single query call, unlike other client-side addQuery() methods. Once you define all the desired queries, call the query() method to execute the specified query clause (filter). If you call this method multiple times before calling the query() method, the queries are AND’ed together.

Question 207

What does the setLimit() method do within the context of the client-side GlideRecord API?

Answer 207

Sets the limit for how many records are in the GlideRecord.

Question 208

Which API provides methods for manipulating a URI?

Answer 208

GlideURLV3

Question 209

What does the GlideURLV3 API do?

Answer 209

Provides methods for manipulating a URI. Can be used in client-side scripts using ListV2 and ListV3 APIs This API is not supported by Service Portal, Now Mobile, or Agent Workspace.

Question 210

What does the GlideURL() method do within the context of the client-side GlideURLV3 API?

Answer 210

Creates an instance of the GlideURL class.

Question 211

What does the addParam() method do within the context of the client-side GlideURLV3 API?

Answer 211

Adds a query string name-value pair to the URL.

Question 212

What does the getURL() method do within the context of the client-side GlideURLV3 API?

Answer 212

Gets the entire context path and query string parameters as a single URI

Question 213

Which API provides access to to information about the current used ad current user roles?

Answer 213

The GlideUser API

Question 214

What does the firstName property provide within the context of the GlideUser API?

Answer 214

Returns the current user’s first name.

Question 215

What does the getClientData() method do within the context of the GlideUser API?

Answer 215

Returns a client value set.

Question 216

What does the getFullName() method do within the context of the GlideUser API?

Answer 216

Returns the first and last name of the current user.

Question 217

What does the hasRole() method do within the context of the GlideUser API?

Answer 217

Returns true if the current user has the specified role or the admin role.

Question 218

What does the hasRoleExactly() method do within the context of the GlideUser API?

Answer 218

Determines whether the current user has the specified role.

Question 219

What does the hasRoleFromList() method do within the context of the GlideUser API?

Answer 219

Returns true if the current user has at least one of the specified roles or has the admin role.

Question 220

What does the hasRoles() method do within the context of the GlideUser API?

Answer 220

Returns true if the current user has any role.

Question 221

What does the lastName property contain within the context of the GlideUser API?

Answer 221

The current user’s last name

Question 222

What does the setClientData() method do within the context of the GlideUser API?

Answer 222

Sets a client value that you can retrieve ushering getClientData()

Question 223

What does the userName property contain within the context of the GlideUser API?

Answer 223

This property is the current user’s username, not the user’s name.

Question 224

What does the userID property contain within the context of the GlideUser API?

Answer 224

Returns the sys_id of the current user.

Question 225

What API provides methods to get and format translated messages?

Answer 225

i18N API - Client Side

Question 226

What does the i18N API do?

Answer 226

Provides methods to get and format translated messages.

Question 227

What does the format() method do within the context of the i18N API?

Answer 227

Formats a string containing named tokens with values from a map.

Question 228

What does the getMessage() method do within the context of the i18N API?

Answer 228

Retrieves a translated message. If the specified string exists in the database for the current language, then the translated message is returned. If the specified string does not exist for the current language, then the English version of the string is returned. If the string does not exist at all in the database, then the ID itself is returned.

Question 229

What does the getMessages() method do within the context of the i18N API?

Answer 229

Retrieves a set of messages. If the specified string exists in the database for the current language, then the translated message is returned. If the specified string does not exist for the current language, then the English version of the string is returned. If the string does not exist at all in the database, then the ID itself is returned.

Question 230

What API is an omni-present frame the communication partners can use to integrate their systems into the ServiceNow platform?

Answer 230

The openFrameAPI - client side

Question 231

What does the openFrameAPI do?

Answer 231

Openframeapi is an omni-present frame the communication partners can use to integrate their systems into the ServiceNow platform.

Question 232

What does the hide() method do within the context of the openFrameAPI API?

Answer 232

Hides the OpenFrame in the TopFrame

Question 233

What does the init () method do within the context of the openFrameAPI API?

Answer 233

Initialize OpenFrame, must be the first method called. This method initialized communication to TopFrame and initializes and visual elements passed in the config parameter.

Question 234

What does the isVisible () method do within the context of the openFrameAPI API?

Answer 234

Checks to see if the OpenFrame is visible in the TopFrame.

Question 235

What does the openCustomURL() method do within the context of the openFrameAPI API?

Answer 235

Opens a custom URL in TopFrame

Question 236

What does the openServiceNowForm() method do within the context of the openFrameAPI API?

Answer 236

Opens a form URL. When an agent receives an incoming call, the OpenFrame window displays information such as the account, contact, or consumer. Clicking a link in the OpenFrame window displays the corresponding record. In the platform interface, this API opens a form URL in TopFrame. For Agent Workspace, this API supports interaction tab management. In Agent Workspace, an interaction record opens in a parent tab and the specified entity record opens in a child tab under the interaction tab.

Question 237

What does the openServiceNowFormwithChildTabIf() do within the context of the openFrameAPI API?

Answer 237

Opens a ServiceNow form with a child tab if invoked in a workspace or opens an entity if invoked in the UI16 interface.

Question 238

What does the openServiceNowList() do within the context of the openFrameAPI API?

Answer 238

Opens a list URL in TopFrame This API is not supported on Agent Workspace

Question 239

What does the setFrameMode() method do within the context of the openFrameAPI API?

Answer 239

Sets the OpenFrame mode. The mode passed in this API: - sets the appropriate icon in the header: collapse or expand - raises the relevant event for CTI: - —openFrameAPI.EVENTS.COLLAPSE - —openFrameAPI.EVENTS.EXPAND

Question 240

What does the setHeight() method do within the context of the openFrameAPI API?

Answer 240

Sets the OpenFrame height.

Question 241

What does the setIcons() method do within the context of the openFrameAPI API?

Answer 241

The OpenFrame header can include icons that are placed next to the close icon.

Question 242

What does the setPresenceIndicator() method do within the context of the openFrameAPI API?

Answer 242

Sets the presence indicator to display agent availability in the workspace.

Question 243

What does the setSize() method do within the context of the openFrameAPI API?

Answer 243

Sets the OpenFrame size.

Question 244

What does the setSubtitle() method do within the context of the openFrameAPI API?

Answer 244

Sets the OpenFrame subtitle.

Question 245

What does the setTitle() method do within the context of the openFrameAPI API?

Answer 245

Sets the OpenFrame title.

Question 246

What does the setTitleIcon() method do within the context of the openFrameAPI API?

Answer 246

Sets the OpenFrame’s title icon/

Question 247

What does the setWidth() method do?

Answer 247

Sets the OpenFrame widht.

Question 248

What does the show() method do within the context of the openFrameAPI API?

Answer 248

Makes the OpenFrame visible in the TopFrame

Question 249

What does the subscribe() method do within the context of the openFrameAPI API?

Answer 249

Subscribes to the event

Question 250

What does the version() method do within the context of the openFrameAPI API?

Answer 250

Returns the OpenFrame API version.