@servicenow/sdk - v4.13.3
Preparing search index...
@servicenow/sdk/core
sp_portal
Variable sp_portal
Const
sp_portal
:
{
extends
:
"sys_metadata"
;
name
:
"sp_portal"
;
schema
:
{
alternate_portal
:
Typed
<
|
string
|
Record
<
"sp_portal"
>
|
ExplicitKey
<
"sp_portal"
>
|
TableBrand
<
"sp_portal"
>
,
{
active
:
true
;
label
:
"Alternate portal"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_portal"
;
}
,
>
;
communication_channels
:
Typed
<
string
|
string
[]
|
Record
<
keyof
Tables
>
[]
,
{
attributes
:
{
no_sort
:
true
;
slushbucket_ref_no_expand
:
true
}
;
label
:
[
{
hint
:
"Select the communication channels for this portal. Selected channels will be available for users to select from their user preferences"
;
label
:
"Communication Channels"
;
plural
:
"Communication Channels"
;
}
,
]
;
maxLength
:
1024
;
}
,
>
;
css_variables
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"properties"
;
label
:
"CSS variables"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
dark_theme
:
Typed
<
|
string
|
Record
<
"sp_theme"
>
|
ExplicitKey
<
"sp_theme"
>
|
TableBrand
<
"sp_theme"
>
,
{
active
:
true
;
label
:
"Dark theme"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_theme"
;
}
,
>
;
default
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Default"
;
mandatory
:
false
;
read_only
:
false
}
,
>
;
embeddable_macroponents
:
Typed
<
string
|
string
[]
|
Record
<
"sys_ux_embeddable_macroponent"
>
[]
,
{
attributes
:
{
no_sort
:
true
;
slushbucket_ref_no_expand
:
true
}
;
label
:
[
{
hint
:
"The configured components will be preloaded to improve the performance of pages using web embeddables"
;
label
:
"Select components being embedded"
;
plural
:
"Select components being embedded"
;
}
,
]
;
maxLength
:
1024
;
referenceQual
:
"active=true^EQ"
;
referenceTable
:
"sys_ux_embeddable_macroponent"
;
useReferenceQualifier
:
"simple"
;
}
,
>
;
enable_ais
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Enable AI Search"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
enable_certificate_based_authentication
:
Typed
<
boolean
,
{
active
:
true
;
default
:
false
;
label
:
"Enable certificate based authentication"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
enable_embeddables
:
Typed
<
boolean
,
{
label
:
[
{
hint
:
"Enabling this will allow you to embed web embeddables on the portal"
;
label
:
"Enable Web Embeddables"
;
plural
:
"Enable Web Embeddables"
;
}
,
]
;
}
,
>
;
enable_favorites
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Enable favorites"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
hide_portal_name
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Hide portal name"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
homepage
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Homepage"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
icon
:
Typed
<
string
|
Image
,
{
active
:
true
;
label
:
"Icon"
;
mandatory
:
false
;
read_only
:
false
}
,
>
;
inactive
:
Typed
<
boolean
,
{
active
:
true
;
default
:
false
;
label
:
"Inactive"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
kb_knowledge_base
:
Typed
<
|
string
|
Record
<
"kb_knowledge_base"
>
|
ExplicitKey
<
"kb_knowledge_base"
>
|
TableBrand
<
"kb_knowledge_base"
>
,
{
active
:
true
;
label
:
"Knowledge base"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"kb_knowledge_base"
;
}
,
>
;
kb_knowledge_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"KB home page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
login_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Login page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
logo
:
Typed
<
string
|
Image
,
{
active
:
true
;
label
:
"Logo"
;
mandatory
:
false
;
read_only
:
false
}
,
>
;
logo_alt_text
:
Typed
<
string
,
{
attributes
:
{
serializer
:
"com.glide.script.TranslatedTextXMLSerializer"
;
}
;
label
:
[
{
hint
:
"Configure alternative text for logo"
;
label
:
"Logo Alt Text"
;
plural
:
"Logo Alt Texts"
;
}
,
]
;
maxLength
:
100
;
}
,
>
;
notfound_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"404 page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
quick_start_config
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"json"
;
label
:
"Quick start config"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
rtl_enabled
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Support right-to-left languages"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
sc_catalog
:
Typed
<
|
string
|
Record
<
"sc_catalog"
>
|
ExplicitKey
<
"sc_catalog"
>
|
TableBrand
<
"sc_catalog"
>
,
{
active
:
true
;
label
:
"Catalog"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sc_catalog"
;
}
,
>
;
sc_catalog_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Catalog home page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
sc_category_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Catalog category home page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
search_application
:
Typed
<
|
string
|
Record
<
"sys_search_context_config"
>
|
ExplicitKey
<
"sys_search_context_config"
>
|
TableBrand
<
"sys_search_context_config"
>
,
{
active
:
true
;
label
:
"Search Application"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sys_search_context_config"
;
}
,
>
;
search_results_configuration
:
Typed
<
|
string
|
Record
<
"sys_ux_composite_data"
>
|
ExplicitKey
<
"sys_ux_composite_data"
>
|
TableBrand
<
"sys_ux_composite_data"
>
,
{
active
:
true
;
label
:
"Search Results Configuration"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sys_ux_composite_data"
;
}
,
>
;
sp_chat_queue
:
Typed
<
|
string
|
Record
<
"chat_queue"
>
|
ExplicitKey
<
"chat_queue"
>
|
TableBrand
<
"chat_queue"
>
,
{
active
:
true
;
label
:
"Chat Queue"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"chat_queue"
;
}
,
>
;
sp_rectangle_menu
:
Typed
<
|
string
|
Record
<
"sp_instance_menu"
>
|
ExplicitKey
<
"sp_instance_menu"
>
|
TableBrand
<
"sp_instance_menu"
>
,
{
active
:
true
;
label
:
"Main menu"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_instance_menu"
;
}
,
>
;
sys_id
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"GUID"
;
label
:
"Sys ID"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
theme
:
Typed
<
|
string
|
Record
<
"sp_theme"
>
|
ExplicitKey
<
"sp_theme"
>
|
TableBrand
<
"sp_theme"
>
,
{
active
:
true
;
label
:
"Theme"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_theme"
;
}
,
>
;
title
:
Typed
<
string
,
{
active
:
true
;
label
:
"Title"
;
mandatory
:
true
;
read_only
:
false
}
,
>
;
ts_index_group
:
Typed
<
|
string
|
Record
<
"ts_index_group"
>
|
ExplicitKey
<
"ts_index_group"
>
|
TableBrand
<
"ts_index_group"
>
,
{
active
:
true
;
label
:
"Text Index Group"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"ts_index_group"
;
}
,
>
;
url_suffix
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"URL suffix"
;
mandatory
:
true
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
}
;
}
= ...
Type Declaration
Readonly
extends
:
"sys_metadata"
Readonly
name
:
"sp_portal"
Readonly
schema
:
{
alternate_portal
:
Typed
<
|
string
|
Record
<
"sp_portal"
>
|
ExplicitKey
<
"sp_portal"
>
|
TableBrand
<
"sp_portal"
>
,
{
active
:
true
;
label
:
"Alternate portal"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_portal"
;
}
,
>
;
communication_channels
:
Typed
<
string
|
string
[]
|
Record
<
keyof
Tables
>
[]
,
{
attributes
:
{
no_sort
:
true
;
slushbucket_ref_no_expand
:
true
}
;
label
:
[
{
hint
:
"Select the communication channels for this portal. Selected channels will be available for users to select from their user preferences"
;
label
:
"Communication Channels"
;
plural
:
"Communication Channels"
;
}
,
]
;
maxLength
:
1024
;
}
,
>
;
css_variables
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"properties"
;
label
:
"CSS variables"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
dark_theme
:
Typed
<
|
string
|
Record
<
"sp_theme"
>
|
ExplicitKey
<
"sp_theme"
>
|
TableBrand
<
"sp_theme"
>
,
{
active
:
true
;
label
:
"Dark theme"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_theme"
;
}
,
>
;
default
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Default"
;
mandatory
:
false
;
read_only
:
false
}
,
>
;
embeddable_macroponents
:
Typed
<
string
|
string
[]
|
Record
<
"sys_ux_embeddable_macroponent"
>
[]
,
{
attributes
:
{
no_sort
:
true
;
slushbucket_ref_no_expand
:
true
}
;
label
:
[
{
hint
:
"The configured components will be preloaded to improve the performance of pages using web embeddables"
;
label
:
"Select components being embedded"
;
plural
:
"Select components being embedded"
;
}
,
]
;
maxLength
:
1024
;
referenceQual
:
"active=true^EQ"
;
referenceTable
:
"sys_ux_embeddable_macroponent"
;
useReferenceQualifier
:
"simple"
;
}
,
>
;
enable_ais
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Enable AI Search"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
enable_certificate_based_authentication
:
Typed
<
boolean
,
{
active
:
true
;
default
:
false
;
label
:
"Enable certificate based authentication"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
enable_embeddables
:
Typed
<
boolean
,
{
label
:
[
{
hint
:
"Enabling this will allow you to embed web embeddables on the portal"
;
label
:
"Enable Web Embeddables"
;
plural
:
"Enable Web Embeddables"
;
}
,
]
;
}
,
>
;
enable_favorites
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Enable favorites"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
hide_portal_name
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Hide portal name"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
homepage
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Homepage"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
icon
:
Typed
<
string
|
Image
,
{
active
:
true
;
label
:
"Icon"
;
mandatory
:
false
;
read_only
:
false
}
,
>
;
inactive
:
Typed
<
boolean
,
{
active
:
true
;
default
:
false
;
label
:
"Inactive"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
kb_knowledge_base
:
Typed
<
|
string
|
Record
<
"kb_knowledge_base"
>
|
ExplicitKey
<
"kb_knowledge_base"
>
|
TableBrand
<
"kb_knowledge_base"
>
,
{
active
:
true
;
label
:
"Knowledge base"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"kb_knowledge_base"
;
}
,
>
;
kb_knowledge_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"KB home page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
login_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Login page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
logo
:
Typed
<
string
|
Image
,
{
active
:
true
;
label
:
"Logo"
;
mandatory
:
false
;
read_only
:
false
}
,
>
;
logo_alt_text
:
Typed
<
string
,
{
attributes
:
{
serializer
:
"com.glide.script.TranslatedTextXMLSerializer"
;
}
;
label
:
[
{
hint
:
"Configure alternative text for logo"
;
label
:
"Logo Alt Text"
;
plural
:
"Logo Alt Texts"
;
}
,
]
;
maxLength
:
100
;
}
,
>
;
notfound_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"404 page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
quick_start_config
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"json"
;
label
:
"Quick start config"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
rtl_enabled
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Support right-to-left languages"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
sc_catalog
:
Typed
<
|
string
|
Record
<
"sc_catalog"
>
|
ExplicitKey
<
"sc_catalog"
>
|
TableBrand
<
"sc_catalog"
>
,
{
active
:
true
;
label
:
"Catalog"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sc_catalog"
;
}
,
>
;
sc_catalog_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Catalog home page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
sc_category_page
:
Typed
<
|
string
|
Record
<
"sp_page"
>
|
ExplicitKey
<
"sp_page"
>
|
TableBrand
<
"sp_page"
>
,
{
active
:
true
;
label
:
"Catalog category home page"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_page"
;
}
,
>
;
search_application
:
Typed
<
|
string
|
Record
<
"sys_search_context_config"
>
|
ExplicitKey
<
"sys_search_context_config"
>
|
TableBrand
<
"sys_search_context_config"
>
,
{
active
:
true
;
label
:
"Search Application"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sys_search_context_config"
;
}
,
>
;
search_results_configuration
:
Typed
<
|
string
|
Record
<
"sys_ux_composite_data"
>
|
ExplicitKey
<
"sys_ux_composite_data"
>
|
TableBrand
<
"sys_ux_composite_data"
>
,
{
active
:
true
;
label
:
"Search Results Configuration"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sys_ux_composite_data"
;
}
,
>
;
sp_chat_queue
:
Typed
<
|
string
|
Record
<
"chat_queue"
>
|
ExplicitKey
<
"chat_queue"
>
|
TableBrand
<
"chat_queue"
>
,
{
active
:
true
;
label
:
"Chat Queue"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"chat_queue"
;
}
,
>
;
sp_rectangle_menu
:
Typed
<
|
string
|
Record
<
"sp_instance_menu"
>
|
ExplicitKey
<
"sp_instance_menu"
>
|
TableBrand
<
"sp_instance_menu"
>
,
{
active
:
true
;
label
:
"Main menu"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_instance_menu"
;
}
,
>
;
sys_id
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"GUID"
;
label
:
"Sys ID"
;
mandatory
:
false
;
read_only
:
false
;
}
,
>
;
theme
:
Typed
<
|
string
|
Record
<
"sp_theme"
>
|
ExplicitKey
<
"sp_theme"
>
|
TableBrand
<
"sp_theme"
>
,
{
active
:
true
;
label
:
"Theme"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"sp_theme"
;
}
,
>
;
title
:
Typed
<
string
,
{
active
:
true
;
label
:
"Title"
;
mandatory
:
true
;
read_only
:
false
}
,
>
;
ts_index_group
:
Typed
<
|
string
|
Record
<
"ts_index_group"
>
|
ExplicitKey
<
"ts_index_group"
>
|
TableBrand
<
"ts_index_group"
>
,
{
active
:
true
;
label
:
"Text Index Group"
;
mandatory
:
false
;
read_only
:
false
;
referenceTable
:
"ts_index_group"
;
}
,
>
;
url_suffix
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"URL suffix"
;
mandatory
:
true
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@servicenow/sdk - v4.13.3
Loading...