CPQ DevKit™ for Oracle

CPQ DevKit™ for Oracle® CPQ Cloud is a Visual Studio Code extension for Oracle CPQ Cloud (BigMachines) development. It improves day-to-day work on BML and BMQL with formatting, snippets, and project sync workflows.

Highlights

• BML/BMQL editing: snippets, autocomplete helpers, and formatting for .bml, .json, .xml
• Project sync: download/sync CPQ objects (Functions/BML, Data Tables, Assets, Parts, Products, Pricing, Integrations, and more)
• Navigation: Go to Definition for util. / commerce. functions and BMQL Data Table references
• Environment management: configuration-driven folder structure and fast environment switching
• Table previews: preview JSON/CSV/XML data as a searchable table
• Action palette: quickly run common DevKit workflows from one menu
• Explorer view: a dedicated CPQ DevKit™ sidebar with environment + common actions
• Tasks: run downloads/deploy/test from the VS Code Tasks UI (Terminal: Run Task…)

What's new in Release 2.6.2

• Consistent command titles across the Command Palette, Actions menu, explorer, walkthroughs, and tests.
• Hardened build and packaging pipeline for the dual Node + browser extension bundle.
• Marketplace-ready metadata, release notes, and a leaner VSIX package.

See the full release notes in CHANGELOG.

Account and Docs

You can register for CPQ DevKit™ for free at cpqdevkit.com. The CPQ DevKit™ web app extends Oracle® CPQ Cloud workflows for Visual Studio Code users.

Features

CPQ DevKit™ for Oracle® CPQ Cloud (BigMachines) includes:

• safe functions with fast autocomplete
• a formatter and beautifier for .bml, .json, and .xml
• all BMI system attributes and constants
• safe loop snippets for array and jsonarray
• project sync workflows for a *.bigmachines.com website
• optional auto-commit support when downloading updated files into a Git-initialized workspace

Contact

For questions or concerns about the extension, use the Q&A tab or contact us on the CPQ Consultant. You can also find CPQ Consultant on LinkedIn.

How to interact with a *.bigmachines.com domain?

After installation, you should go to the DevKit settings (in Visual Studio Code settings) and add configuration data for your environments, be that dev, test or prod.

Make sure your BigMachines user has the following properties:

1. is FullAdmin
2. has User Administrator checkbox checked
3. in the All Access administrator group

Open a new directory where you want to set up the project in Visual Studio Code.

📁 Configuration Files

To use CPQ DevKit™ for Oracle, you need to create two configuration files in your project directory:

1. project.config.jsonc - Project Configuration

This file defines your project-specific settings and folder structure. Create this file in your project root:

{
  "apiVersion": "v19", // v17 is the default; any version after v15 is supported
  "tableFormat": "json",
  "folderSettings": {
    "files": "_files",
    "parts": "_parts",
    "tables": "_tables",
    "utilFunctions": "_utils",
    "commerceFunctions": "_commerce",
    "assets": "_assets",
    "pricing": "_pricing",
    "metadata": "_metadata",
    "dictionary": "_dictionary",
    "integrations": "_integrations"
  },
  "fileSettings": {
    "bmlUtilPrefix": "util.",             // set to "" to keep legacy function names
    "bmlCommercePrefix": "commerce.",     // set to "" to keep legacy function names
    "bmlIncludeMetaTag": "true",          // set to "false" to omit the meta tag
    "bmlIncludeTestTag": "true",          // set to "false" to omit the test tag
    "defaultDataFormat": "json"
  }
}

Configuration Options:

• apiVersion: Oracle CPQ API version (e.g., "v19", "v17", "v15")
• tableFormat: Format for downloaded tables ("json" or "csv")
• folderSettings: Local folder names for different file types:
  • files: Static files and documents
  • parts: Part definitions and configurations
  • tables: Data tables
  • utilFunctions: Utility BML functions
  • commerceFunctions: Commerce BML functions
  • assets: Asset management files
  • pricing: Pricing rules and configurations
  • metadata: Metadata catalogs
  • dictionary: Translation dictionaries
  • integrations: Integration configurations
• fileSettings:
  • bmlUtilPrefix: Prefix for utility functions (default: "util.")
  • bmlCommercePrefix: Prefix for commerce functions (default: "commerce.")
  • bmlIncludeMetaTag: Whether to include meta tag in BML files ("true"/"false")
  • bmlIncludeTestTag: Whether to include test tag in BML files ("true"/"false")
  • defaultDataFormat: Default format for data files ("json" or "xml")

2. .cpqdevkit/developer.config.jsonc - Developer Configuration (keep in .gitignore)

This file contains your personal developer settings and credentials. Create the .cpqdevkit directory and this file:

{
  "name": "CPQ DevKit™ for Oracle CPQ Cloud - developer's secret file",
  "_git_auto_commit": false,
  "_table_format": "json",
  "_ocpq_environment_active": "dev",
  "_ocpq_environments": [
    {
      "name": "dev",
      "url": "https://<subdomain-dev>.bigmachines.com",
      "username": "<username>",
      "password": "<password>"
    },
    {
      "name": "uat",
      "url": "https://<subdomain-uat>.bigmachines.com",
      "username": "<username>",
      "password": "<password>"
    }
  ]
}

To open the list of available commands, you must right-click on the project explorer panel and select the DevKit menu or open the list of all available commands (CTRL+SHIFT+P) and type DevKit into the search bar.

Complete List of Commands

In the Command Palette, these commands appear under the CPQ DevKit™ for Oracle category.

🔐 Authentication Commands

• Sign In - Authenticate with CPQ DevKit™ services
• Sign Out - Sign out from CPQ DevKit™ services
• Open Authentication Settings - Open authentication configuration

⚙️ Setup & Configuration

• Open Actions - Open the action palette for common workflows
• Set Up Project - Initialize project configuration, folders, and .gitignore
• Create Developer Configuration File - Create .cpqdevkit/developer.config.jsonc
• Change Environment - Switch between environments
• Open Configuration Files - Open project.config.jsonc and .cpqdevkit/developer.config.jsonc
• Diagnose Workspace - Validate configs and active environment setup

🧩 BML Scaffolding

• Create BML Function - Create a new util.* / commerce.* BML file in the correct folder

📥 Download Commands

• Download Data and Metadata - Download the complete data and metadata catalog
• Download Files - Download all files from the server
• Download Assets - Download all assets from the server
• Download Parts - Download all parts from the server
• Download Products - Download all products from the server
• Download BML Functions - Download all BML functions from the server
• Download Data Tables - Download all data tables from the server
• Download Shopping Carts - Download all shopping cart data
• Download Integrations - Download integrations such as Vendors, Settings, Types, Commerce, and Product Families
• Download Data Table - Download a specific data table

🚀 Deploy & Development Commands

• Deploy Functions - Deploy BML functions to the server
• Save Functions - Save BML functions to the server
• Test Functions - Test BML functions on the server
• Validate Functions - Validate BML functions on the server

🛠️ Utility Commands

• View as Table - Preview JSON/CSV/XML as a searchable table
• Convert to JSON - Convert XML/CSV files to JSON format
• Convert to XML - Convert JSON/CSV files to XML format
• Convert to CSV - Convert JSON/XML files to CSV format

Legal

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Node.js is a trademark of Joyent, Inc. We are not endorsed by or affiliated with Joyent.