Skip to content

CPQ DevKit™ for ServiceNow

Edit ServiceNow CPQ scripts and rules in VS Code

Pull blueprints with their enrichment scripts and rules, compare them with your tenant, push with a backup first, and deploy, with keys kept in VS Code secret storage.

ChangelogmacOS • Windows • Linux

CPQ DevKit™ for ServiceNow
On this page

CPQ DevKit™ for ServiceNow brings your ServiceNow CPQ (Logik.io) tenant into VS Code. Pull a blueprint with its fields, rules and enrichment scripts, edit the JavaScript and the rules in the editor, compare them with the tenant, push your changes back, and deploy the blueprint. Load managed tables from CSV and test configurations without leaving the editor, with a named environment for each tenant.

This extension is in preview.

Quick Start

  1. Install the extension from the Visual Studio Marketplace
  2. Open a folder and run CPQ DevKit™ for ServiceNow: Add Environment
  3. Enter your tenant address (https://<tenant>.<sector>.logik.io) and an Admin API key. Create the key in the ServiceNow CPQ admin under Utilities → Admin API Keys
  4. Run Test Connection
  5. Run Pull Blueprints (with Rules and Scripts) and pick a blueprint
  6. Edit an enrichment script, then right-click it and choose Push Enrichment Script

The Get started with CPQ DevKit™ for ServiceNow walkthrough (Help → Welcome) shows the same steps.

Environments

Add one environment per tenant (for example DEV, TEST and PROD). The active environment shows in the status bar; click it to switch.

  • The tenant list is saved in .cpqdevkit/servicenow/servicenow-config.json, without secrets, so you can share it with your team
  • The Admin API key and the runtime token are kept in VS Code secret storage, per environment
  • Edit Environment renames an environment or changes its address, key, token or origin
  • Clear Stored Credentials removes the stored key and token of the active environment or of all environments

Blueprints, scripts and rules

Pull Blueprints (with Rules and Scripts) downloads, for each blueprint you pick:

servicenow-cpq/<environment>/
  blueprints/<blueprint>/
    blueprint.json, fields.json, rules.json, sets.json,
    product-pickers.json, layouts.json, configurable-products.json,
    deployments.json
    scripts/init.js, product.js, pricing.js, validation.js
  rules/<rule>.json
  • Push Enrichment Script saves the open script to its blueprint. Compile warnings from ServiceNow CPQ appear in the Problems panel
  • Push Rule saves the open rule file
  • Compare … with Tenant opens a diff between the tenant's copy and yours
  • Before a push, the extension checks whether someone changed the tenant copy since you pulled it. If so, you can compare first or overwrite
  • Before every push, the tenant's current copy is saved to servicenow-cpq/<environment>/backups/<date>/
  • Deploy Blueprint deploys a blueprint and waits for the deployment to finish, so configurations use your changes
  • Every write asks for confirmation and names the environment; environments named like PROD get an extra warning

Managed tables

  • Export Managed Table to CSV saves a table to servicenow-cpq/<environment>/tables/<table>.csv
  • Replace Managed Table from CSV loads the open CSV file into a table, replacing all its rows. The current rows are exported to the backups folder first

Test configurations

With a runtime token, you can try a blueprint the way your quoting system does:

  • Start Test Configuration starts a configuration for a product id and shows its fields, messages and products
  • Change Test Configuration Field sets a field and shows the result
  • Show Test Configuration BOM shows the bill of materials
  • Open Configuration by UUID (Read-Only) shows an existing configuration, for example one saved on a quote line, without changing it
  • Export Configuration Values saves the current configuration as plain values (fields, sets, and the rows selected in product pickers) to servicenow-cpq/<environment>/configurations/. Select two exports in the Explorer and choose Compare Selected to see what differs

Blueprints with product picker fields are supported. Test configurations are never saved to a quote. Configuration requests send the origin you set on the environment; it must be one of the origins the runtime token allows.

Run any API operation

Run API Operation lists every operation of the ServiceNow CPQ Admin and Runtime APIs, as documented at api-docs.logik.io. Pick one, fill in its parameters, and see the response. Anything other than a read asks for confirmation first. Show API Operation Details describes an operation's parameters and body.

Chat and MCP

  • @cpq-servicenow /env and #servicenowEnv show the active environment and which credentials are stored, without secrets
  • A local MCP server for the active environment lets AI agents in VS Code read blueprints, enrichment scripts, rules and managed tables, search the API reference, and run read-only Admin API operations. It cannot change anything in your tenant
  • Install Chat Skills adds ServiceNow CPQ scripting guidance to .github/skills for Copilot and other agents

Commands

CommandWhat it does
Add / Edit / Switch / Delete EnvironmentManage tenants
Test ConnectionCheck the address and Admin API key
Pull Blueprints (with Rules and Scripts)Download blueprints, their rules and enrichment scripts
Pull Enrichment ScriptsDownload only the scripts of the blueprints you pick
Pull RulesDownload the rules you pick
Push Enrichment Script / Push RuleSave the open file to the tenant
Compare … with TenantDiff the tenant's copy with yours
Deploy BlueprintDeploy a blueprint and wait for the result
Export / Replace Managed TableCSV export, and replace from CSV with a backup
Start / Change / Show BOM (test config)Test configurations with the runtime token
Open Configuration by UUIDRead an existing configuration
Export Configuration ValuesSave a configuration as plain values to compare
Run API OperationRun any documented API operation
Clear Stored CredentialsRemove stored keys and tokens

Settings

SettingDefaultDescription
sncpq.workspaceDirservicenow-cpqFolder for pulled files and backups, one subfolder per environment
sncpq.requestTimeout30000Timeout in ms for ServiceNow CPQ requests

Requirements

  • VS Code 1.109 or later, desktop or VS Code for the Web (vscode.dev, github.dev). In the browser, VS Code calls your tenant directly, so your tenant must accept requests from the browser; the MCP server needs desktop VS Code
  • A ServiceNow CPQ (Logik.io) tenant and an Admin API key
  • For test configurations: a runtime token (Runtime Clients in the ServiceNow CPQ admin) and an origin it allows

Security & Privacy

  • Requests go straight from VS Code to your ServiceNow CPQ tenant; no CPQ DevKit™ service sees your tenant data, keys or tokens
  • The extension only sends your key to an https://…logik.io address
  • Keys and tokens are stored in VS Code secret storage, never in the workspace
  • Chat tools and the MCP server never show keys or tokens

Support

License

See LICENSE.md for details.

Frequently Asked Questions

What is CPQ DevKit™ for ServiceNow?

A VS Code extension for ServiceNow CPQ (formerly Logik.ai): edit enrichment scripts and rules as files, compare and push them, deploy blueprints, load managed tables and test configurations, across several tenants.

Where do I get an Admin API key?

In the ServiceNow CPQ admin, under Utilities → Admin API Keys.

Does it change my tenant on its own?

No. Only the push, deploy, replace-table and run-operation commands write to the tenant, and each asks first. The MCP server is read-only.

Which operating systems are supported?

macOS, Windows, and Linux.

What telemetry is collected?

Command names, session, and extension version. Never file contents or tenant data. Stored by CPQ DevKit™ on Cloudflare. Respects VS Code's telemetry setting; opt out with sncpq.enableTelemetry.

Trademarks

ServiceNow, Logik.io, Logik.ai and related marks are trademarks of their respective owners. This extension is not affiliated with or endorsed by ServiceNow.

Built for Oracle, Salesforce, SAP, Epicor, Infor, and ServiceNow CPQ