spUtil
What is spUtil
spUtil is a really useful utility class, the problem is I can never seem to find it when I need to look it up as it's not on developer.servicenow.com, but is instead on docs.servicenow.com.
So I'm making a list of their functions for my reference as it's coded here or more readable here.
First I'll go over the documented methods, then the undocumented methods, as there always seems to be some.
Method | Documented |
---|---|
addErrorMessage | Yes |
addInfoMessage | Yes |
addTrivialMessage | Yes |
createUid | No |
format | Yes |
getAccelerator | No |
getHeaders | No |
getHost | No |
getPageUri | No |
getPreference | No |
getURL | No |
getWidgetURL | No |
get | Yes |
parseAttributes | No |
recordWatch | Yes |
refresh | Yes |
scrollTo | No |
setBreadCrumb | No |
setPreference | No |
setSearchPage | No |
update | Yes |
Documented
addErrorMessage
[addErrorMessage(string)]
[record]
.service-now.com/sp_widget_list.do?sysparm_query=id=widget-sc-cat-item
addInfoMessage
addInfoMessage(string)
[record]
service-now.com/sp_widget_list.do?sysparm_query=id=widget-sc-cat-item
addTrivialMessage
addTrivialMessage(string)
[record]
service-now.com/sp_widget_list.do?sysparm_query=id=widget-form
format
[format(string template, object
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L5)
data)]([record]
service-now.com/sp_widget_list.do?sysparm_query=id=widget-sc-cat-item
get
[get(string
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L30)
widgetid)]([record]
service-now.com/sp_widget_list.do?sysparm_query=id=sqanda-create-question
refresh
[refresh(object
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L22)
\$scope)](update
[update(object
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L13)
\$scope)]([record]
service-now.com/sp_widget_list.do?sysparm_query=sys_id=f37aa302cb70020000f8d856634c9cfc
recordWatch
[recordWatch(object \$scope, string table, string filter, function
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L129)
callback)]([record]
service-now.com/sp_widget_list.do?sysparm_query=sys_id=f37aa302cb70020000f8d856634c9cfc
Also, there's a number of tables that are blocked from being watched, you can see this list in your instance by running;
clone_preserved_data
clone_token
digest_properties
instance
license_details
pa_job_logs
role_has_license
saml2_update1_properties
sp_log
sso_federation
sso_properties
sys_audit_delete
sys_audit_relation
sys_broadcast_message
sys_broadcast_message_m2m
sys_cache_flush
sys_cluster_message
sys_cluster_state
sys_db_cache
sys_dictionary_override
sys_email
sys_email_account
sys_email_log
sys_event_processor
sys_glide_object
sys_import_set
sys_import_set_row
sys_import_set_row_error
sys_import_set_run
sys_progress_worker
sys_progress_worker_domain
sys_report_summary
sys_report_summary_line
sys_rw_action
sys_rw_amb_action
sys_status
sys_trigger
sys_ui_navigator_history
sys_update_set
sys_update_set_log
sys_update_version
sys_update_xml
sys_upgrade_history
sys_upgrade_history_log
sys_user_preference
sys_user_session
sys_user_token
ua_app_metadata
ua_app_usage
usageanalytics_count
usageanalytics_count_cfg
wf_command
wf_context
wf_executing
wf_history
wf_transition_history
wf_workflow_execution
Undocumented
getHeaders
getHeaders()
directive.spReferenceField.js#40
getWidgetURL
[getWidgetURL(string widgetid or string
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L60)
object)](directive.spReferenceField.js#36
setBreadCrumb
[setBreadCrumb(object \$scope,
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L68)
list)]([record] service-now.com/sp_widget_list.do?sysparm_query=id=tagged-question-list
setSearchPage
setSearchPage(searchPage)
[record] service-now.com/sp_widget_list.do?sysparm_query=sys_id=b8c57073cb10020000f8d856634c9cfc
getURL
getURL(type)
[record]service-now.com/sp_widget_list.do?sysparm_query=id=widget-login
scrollTo
[scrollTo(id,
https://github.com/jacebenson/sndocs/blob/master/sources/jakarta/4/scripts/app.$sp/service.spUtil.js#L112)
time)]([record] service-now.com/sp_widget_list.do?sysparm_query=id=widget-sc-order-guide
getAccelerator
getAccelerator(char)
[record] service-now.com/sp_widget_list.do?sysparm_query=id=widget-form
createUid
createUid(str)
parseAttributes
parseAttributes(strAttributes)
getHost
setPreference
getPreference
getPageUri
getPageUri()