\$sp aka GlideSPScriptable documentation lacking

[Jace Benson]

So I'm trying to figure out specicially some things about;

$sp.getKBCount()
$sp.getKBCategoryArticles();

The only methods documented today on https://developer.servicenow.com/app.do#!/api_doc?v=jakarta&id=c_GlideSPScriptableScopedAPI are;

$sp.canReadRecord

$sp.getCatalogItem

$sp.getDisplayValue

$sp.getField

$sp.getFields

$sp.getFieldsObject

$sp.getForm

$sp.getListColumns

$sp.getMenuHREF

$sp.getMenuItems

$sp.getParameter

$sp.getPortalRecord

$sp.getRecord

$sp.getRecordDisplayValues

$sp.getRecordElements

$sp.getRecordValues

$sp.getStream

$sp.getValue

$sp.getValues

$sp.getWidget

Missing so far;

$sp.getKBRecord

$sp.getKBCount

$sp.getKBCategoryArticles

$sp.getKBTopicArticles

$sp.getKBTopCategoryID

$sp.getKBSiblingCategories

$sp.showCatalogPrices

$sp.saveVariables

$sp.buildThemeVariableModel

$sp.getVariablesArray

$sp.getWidgetFromInstance

$sp.getRecordVariablesArray

$sp.getFilterBreadcrumbs

$sp.logStat

$sp.getInstanceRecord

$sp.log

$sp.saveRecord

$sp.logSearch

ctomasi bianca.vaccarini any update on when these will be documented would be appreciated.

[ChrisBurks · Accepted solution]

I don't use the widget editor as it's not my preference. But many times when I come across a method for portal that I need more info on how to use it, I go to the widget editor. There is some built-in documentation on many of the methods that show you what it will return and in what cases. It also shows you what parameters it accepts if you type all the way out to the parenthesis.

[Jace Benson]

That's great, its not official, but better then nothing.

HI has kinda been a stinker saying they aren't supported but they are using them;

"I have since heard back from our Service Portal team that these functions have since been deemed legacy and are no longer supported. Our Service Portal product team would like to know a little more information regarding where you were able to locate these functions for use?"

[ChrisBurks]

Hmmmm....

Their statement is funny. I see new/updated OOB widgets with those legacy methods. Also the official documentation states that users can use the existing widgets as examples of how to construct a widget.

So, to me that would mean that if OOB widgets are using those methods, then those aren't deemed good to use and more information should be provided about them if the existing widgets aren't fully explaining how to use them.

Also I would hold ServiceNow to those descriptions that exist within their production instances as official. Otherwise if they are unofficial, why do they exist within the production environment?

That's just my opinion, though.

[Jace Benson]

I totally agree on all points.   I just hate that this stuff isn't documented and then when SN pulls documentation efforts the community does to fill the gaps its just salt in the wound.  

I just updated service-portal-docs/widget_server_script_apis.md at master · newrocketinc/service-portal-docs · Gi...   with these but, yea, there's more.