item_option_new Table

Table Reference/item_option_new

The `item_option_new` table stores variable definitions for Service Catalog items — their types, labels, default values, and display rules. Part of the Service Catalog module, it defines the custom fields that appear on catalog item request forms. Each record represents one variable that can collect user input during the ordering process.

What This Table Is

The item_option_new table defines variables for Service Catalog items. Each record represents one input field that appears on a catalog item's request form — text boxes, dropdowns, checkboxes, reference fields, and more complex variable types. When users order catalog items, they're filling out forms built from these variable definitions.

This table lives in the Service Catalog module and supports the end-to-end catalog ordering process. Variables collect user input during ordering, validate that input, and store the responses in sc_item_option_mtom records. The variable definitions here control form layout, validation rules, and how responses get processed by catalog workflows.

The table extends sys_metadata, making variables part of the application structure. Variables belong to specific catalog items through the cat_item reference field. Variable sets (item_option_new_set) can contain multiple variables for reuse across catalog items.

Large enterprises typically have hundreds to thousands of variable records. Most queries filter by cat_item or variable_set, which are indexed for performance. The order field controls display sequence on forms, and most queries include an ORDER BY clause on this field.

When You'll Script Against This Table

You'll script against item_option_new in Catalog Client Scripts (to show/hide variables dynamically), Business Rules on catalog items (to create or modify variables programmatically), and Script Includes that generate catalog forms. Catalog UI Policies also reference this table to control variable visibility and mandatory status based on other field values.

Access requires the catalog_admin role for write operations. Read access is typically available to catalog_manager and itil roles. Client scripts run in a limited scope and can only read variable definitions, not modify them.

Common scripting patterns:

Query variables for a catalog item to build custom request forms or validation logic
Copy variables from one catalog item to another during bulk catalog administration
Dynamically modify reference qualifiers or choice lists based on user selections
Generate variable documentation or audit reports for catalog governance
Validate variable configurations during catalog item deployments or updates
Create variable sets programmatically for consistent catalog item templates
Update default values or attributes across multiple variables during catalog maintenance

Table Gotchas

⚠️

The type field uses internal values like 'glide_list' and 'reference' that don't match the UI labels. Always check sys_choice records for the item_option_new.type field to get the mapping.

⚠️

Variables can belong to either a catalog item (cat_item field) OR a variable set (variable_set field), but not both. Always check which field is populated when writing queries.

The attributes field stores XML configuration that controls advanced variable behavior. Modifying this requires understanding the ServiceNow variable attribute schema.
Reference qualifiers in the reference_qual field can reference other variables using the syntax javascript:'variable_name=' + current.variables.variable_name for dynamic filtering.
The order field accepts decimal values (100, 200, 150) to allow insertion between existing variables without reordering everything.

⚠️

Variables attached to inactive catalog items still appear in queries. Always join to sc_cat_item and check the active field if you need currently available variables only.

Choice list variables store their options in the question_choice table, not as encoded values in the variable record itself.

Free Newsletter

Enjoying this? Get one deep-dive per week.

Join 1,000+ ServiceNow pros — scripts, GlideRecord patterns, Flow Designer techniques, and career moves. Free.

The sc_cat_item table defines the catalog items that variables belong to. Most variable queries join these tables to filter by catalog category, item status, or availability. The item_option_new_set table creates reusable variable collections — variables can belong to sets instead of directly to catalog items, allowing standardization across multiple catalog offerings.

The sc_item_option_mtom table stores user responses to variables during catalog ordering. Each record links a requested item (sc_req_item) to a variable definition and the user's input value. When building approval workflows or fulfillment automations, you'll often query both tables to get variable definitions and their corresponding user responses.

Choice-type variables connect to the question_choice table for their option lists, while reference variables point to standard ServiceNow tables through their reference field. Variable visibility and behavior rules are controlled by records in catalog_ui_policy that reference specific variable sys_ids.

Chrome Extension

Sourdough: ServiceNow Monitoring and Analytics

A Chrome extension for ServiceNow Admins and Developers with essential tools, analytics, graphs and monitoring features.

Instance HealthGraphs & ChartsAPI HealthDeveloper ToolsQuick SearchInstance Switcher

Add to Chrome

Free to install. Pro $5/month after a 14-day no-card trial.
Pro requires the ServiceNow admin role. Upgrade inside the extension.

Overview

Tasks

CMDB

API

Metrics

Monitor

Internals

Instance:sourdoughdev·Version:Yokohama

Instance StateONLINE

System StatusFully Operational

Session Timeout90 minutes

Logged-In Sessions2 (20 active)

Build Nameyokohama-12-18-2024_p1

IP Address10.159.128.43

Instance HealthHealth Score: 90%

🔥 5dSourdough (Chrome Plugin)Dark Mode

Key Fields

Column	Type	Label	Notes
name	string	Name	Internal variable name used in scripts and API calls. Must be unique within the catalog item or variable set scope.
question_text	string	Question	Display label shown to users on the catalog form. Supports HTML markup for formatting.
type	choice	Type	Variable type like 'string', 'boolean', 'reference', 'glide_list'. Controls the input widget and validation behavior.
cat_item	reference	Item	Reference to sc_cat_item table. Empty if variable belongs to a variable set instead of directly to a catalog item.
variable_set	reference	Variable Set	Reference to item_option_new_set table. Empty if variable belongs directly to a catalog item.
order	integer	Order	Display sequence on catalog forms. Accepts decimal values to enable insertion between existing variables.
active	boolean	Active	Controls if variable appears on catalog forms. Inactive variables remain in database but are hidden from users.
mandatory	boolean	Mandatory	Requires user input before form submission. Can be overridden by catalog UI policies.
read_only	boolean	Read only	Displays variable value but prevents user modification. Often used with calculated default values.
default_value	string	Default value	Initial field value on form load. Can contain JavaScript expressions for dynamic defaults.
reference	string	Reference	Target table name for reference-type variables. Works with reference_qual field for filtered lookups.
reference_qual	string	Reference qualifier	Filter expression for reference variables. Can reference other variable values using current.variables syntax.
tooltip	string	Help text	Explanatory text shown to users on hover or click. Supports basic HTML formatting.
attributes	string	Attributes	XML configuration for advanced variable behaviors like multi-row layouts or custom validation rules.
display_title	boolean	Display title	Shows variable as section header instead of input field. Used for form organization and grouping.
scale_min	integer	Min	Minimum value for numeric variables or minimum length for string variables. Used in client-side validation.
scale_max	integer	Max	Maximum value for numeric variables or maximum length for string variables. Enforced during form submission.

Common Queries

Get all active variables for a catalog item

// Most basic query - variables for a specific catalog item
var gr = new GlideRecord('item_option_new');
gr.addQuery('cat_item', 'catalog_item_sys_id_here');
gr.addQuery('active', true);
gr.orderBy('order');
gr.query();
while (gr.next()) {
    gs.info('Variable: ' + gr.name + ' - ' + gr.question_text);
}
// Always order by 'order' field for proper form sequence

Find mandatory reference variables for active catalog items

// Business scenario - audit mandatory reference fields
var gr = new GlideRecord('item_option_new');
gr.addQuery('type', 'reference');
gr.addQuery('mandatory', true);
gr.addQuery('active', true);
// Join to ensure catalog item is also active
gr.addJoinQuery('sc_cat_item', 'cat_item', 'sys_id').addCondition('active', true);
gr.query();
while (gr.next()) {
    gs.info('Mandatory ref var: ' + gr.name + ' -> ' + gr.reference);
}

Copy variables from one catalog item to another with new ordering

// Real-world task - clone variables between catalog items
var sourceItem = 'source_catalog_item_sys_id';
var targetItem = 'target_catalog_item_sys_id';
var orderStart = 100;

var gr = new GlideRecord('item_option_new');
gr.addQuery('cat_item', sourceItem);
gr.addQuery('active', true);
gr.orderBy('order');
gr.query();
while (gr.next()) {
    var newVar = new GlideRecord('item_option_new');
    newVar.initialize();
    newVar.cat_item = targetItem;
    newVar.name = gr.name;
    newVar.question_text = gr.question_text;
    newVar.type = gr.type;
    newVar.order = orderStart;
    newVar.insert();
    orderStart += 100;
}

Count variables by type across all active catalog items

// Aggregate reporting - variable type distribution
var ga = new GlideAggregate('item_option_new');
// Only count variables for active catalog items
ga.addJoinQuery('sc_cat_item', 'cat_item', 'sys_id').addCondition('active', true);
ga.addQuery('active', true);
ga.addAggregate('COUNT');
ga.groupBy('type');
ga.query();
while (ga.next()) {
    var type = ga.getValue('type');
    var count = ga.getAggregate('COUNT');
    gs.info('Variable type ' + type + ': ' + count + ' instances');
}

Wrong way vs right way to get variable responses

// WRONG: Querying variables to get user responses
// var gr = new GlideRecord('item_option_new');
// Variables only define fields, not user input

// RIGHT: Get variable definitions AND user responses
var reqItem = 'sc_req_item_sys_id_here';
var gr = new GlideRecord('sc_item_option_mtom');
gr.addQuery('request_item', reqItem);
gr.query();
while (gr.next()) {
    // gr.item_option_new gets the variable definition
    // gr.value gets the user's actual response
    gs.info('Variable: ' + gr.item_option_new.name + ' = ' + gr.value);
}
// Use sc_item_option_mtom for responses, not item_option_new

Test Your Knowledge

Quick 3-question quiz — see how your ServiceNow skills stack up.

Question 1 of 3Performance

A list view on a table with millions of records is slow. Best fix?

Select an answer to continue

item_option_new