@servicenow/sdk
Version:
ServiceNow SDK
133 lines (81 loc) • 3.01 kB
Markdown
---
tags: [UIPageVariable, variable, service catalog, ui page, macro]
---
# UIPageVariable
A CatalogItem variable for a UI page field.
## Signature
```typescript fluent
UIPageVariable(config)
```
## Parameters
### config
`UIPageVariableType<'sys_ui_page', string | ExplicitKey<string> | Record<'sys_ui_page'>, string | ExplicitKey<string> | Record<'sys_ui_page'>>`
Configuration for the UI page variable including:
**Properties:**
- **question** (required): `string`
- **active** (optional): `boolean`
- **alwaysExpand** (optional): `boolean`
Always expand
- **attributes** (optional): `string`
Attributes of the variable
- **category** (optional): `string`
Category
- **conversationalLabel** (optional): `string`
- **createRoles** (optional): `(string | Role)[]`
- **defaultValue** (optional): `string | Default`
- **deliveryPlan** (optional): `string`
Delivery plan
- **dependentQuestion** (optional): `string`
Dependent question for dynamic default value
- **description** (optional): `string`
Description
- **disableInitialSlotFill** (optional): `boolean`
- **dotWalkPath** (optional): `string`
Dot walk path for dynamic default value
- **exampleText** (optional): `string`
- **field** (optional): `string`
Field to map (required when mapToField is true)
- **global** (optional): `boolean`
Global
- **helpTag** (optional): `string`
- **helpText** (optional): `string`
- **instructions** (optional): `string`
- **layout** (optional): `'normal' | '2across' | '2down'`
Layout style for the container
- **mapToField** (optional): `boolean`
Map to field
- **order** (optional): `number`
Order in which the variable appears
- **postInsertScript** (optional): `string`
Post insert script
- **pricingDetails** (optional): `PricingDetail[]`
Pricing details
- **pricingImplications** (optional): `boolean`
Pricing implications
- **readRoles** (optional): `(string | Role)[]`
- **readScript** (optional): `string`
Read script
- **removeFromConversationalInterfaces** (optional): `boolean`
Remove from Conversational Interfaces
- **showHelp** (optional): `boolean`
- **tooltip** (optional): `string`
- **uiPage** (optional): `string | Record<RefTable>`
Reference to a sys_ui_page record
- **unique** (optional): `boolean`
Unique value
- **useDynamicDefault** (optional): `boolean`
Use dynamic default
- **visibility** (optional): `'Always' | 'Bundle' | 'Standalone'`
Visibility
- **visibleBundle** (optional): `boolean`
- **visibleGuide** (optional): `boolean`
Indicates whether the variable is visible in guides
- **visibleStandalone** (optional): `boolean`
Indicates whether the variable is visible when standalone
- **visibleSummary** (optional): `boolean`
Indicates whether the variable is visible in summaries
- **width** (optional): `100 | 25 | 50 | 75`
Width of the variable
- **writeRoles** (optional): `(string | Role)[]`
## See
- https://docs.servicenow.com/csh?topicname=variable-types.html&version=latest