1. NetSuite CPQ
  2. NetSuite CPQ Configurator
  3. Working with Product Building Blocks
  4. List of Functions

List of Functions

The following table classifies functions as client-side, server-side, or both. Any function marked with Yes in both columns is a universal function.

The table also contains information about governance usage units for server-side functions. Because NetSuite CPQ Configurator is a Suitelet, each server-side action can use up to 1,000 usage units. However, some units are used to launch the action itself, so the maximum usage units allowed for each server-side action is 927. Depending on the record type, the governance units used vary:

In the table, these units are referred to as record type units.

For more information about governance usage units in NetSuite, see SuiteScript Governance and Limits.

Function

Description

Client-Side

Server-Side

Governance Usage Units

Help Topic

addBreakoutItem()

Adds an additional item to the current configuration and includes it in the transaction when submitted.

Yes

-

-

addBreakoutItem()

addLink()

Adds a clickable URL to the product interface's Link section.

Yes

-

-

addLink()

addMaterial()

Adds a material item to the list of active materials in the current configuration.

Yes

-

-

addMaterial()

addMessageListener()

Sets up a listener to handle incoming messages in the current window.

Yes

-

-

addMessageListener()

addRuleset()

Adds building blocks such as items, materials, or validations to the configuration session based on specified rules.

Yes

-

-

addRuleset()

ajax()

Performs HTTP requests to send or receive data from a server and supports both synchronous and asynchronous modes.

Yes

-

-

ajax()

changeRuleset()

Modifies a single answer attribute within the configuration using specified parameters.

Yes

-

-

changeRuleset()

closeConfig()

Closes the configuration window or frame without submitting any changes.

Yes

-

-

closeConfig()

copyRecord()

Creates a new record by duplicating an existing one and optionally updates specified fields.

-

Yes

Record type units × 3

copyRecord()

createEvent()

Creates a synchronization event for coordinating asynchronous actions and callbacks.

Yes

-

-

createEvent()

createRecord()

Creates a new record with the specified data and field values.

-

Yes

Record type units × 3

createRecord()

createRecords()

Creates multiple records at the same time using a provided list of field values.

-

Yes

Record type units × 3 × Number of records to be created

createRecords()

createTable()

Generates a table in the configuration interface with the specified columns and rows.

Yes

Yes

None

createTable()

customizeUI()

Modifies the look and feel of the submit modal or a question modal.

Yes

-

-

customizeUI()

deleteEvent()

Deletes a previously created synchronization event from the current session.

Yes

-

-

deleteEvent()

deleteFile()

Deletes a file from the File Cabinet.

-

Yes

  • Deleting by id: 20

  • Deleting by name: 30

deleteFile()

deleteRecord()

Deletes a record of the specified type from the database.

-

Yes

Record type units

deleteRecord()

evalRule()

Evaluates a rule and returns the result based on current configuration data.

Yes

Yes

None

evalRule()

findList()

Retrieves metadata and content for a static or CSV product table.

Yes

-

-

findList()

getAnswerCode()

Retrieves the answer code for a given question.

Yes

Yes

None

getAnswerCode()

getAnswerDesc()

Retrieves the description for an answer.

Yes

-

-

getAnswerDesc()

getAnswerLabel()

Retrieves the label for a specific answer.

Yes

-

-

getAnswerLabel()

getAnswerName()

Retrieves the name of a specific answer.

Yes

-

-

getAnswerName()

getAnswers()

Retrieves all selected answers for a particular question.

Yes

Yes

None

getAnswers()

getAnswersCodes()

Retrieves the codes of all selected answers for a question.

Yes

Yes

None

getAnswersCodes()

getAnswerVariable()

Retrieves the value of the custom variable associated with the answer.

Yes

-

-

getAnswerVariable()

getContextVariable()

Retrieves processing context data within a configuration environment.

Yes

-

-

getContextVariable()

getData()

Retrieves data based on given parameters.

-

Yes

  • Using the id parameter: Number of required record types × Record type units

    Process records with the same record type units

  • Without the id parameter: (Number of required record types ÷ 10) + 5

getData()

getEvent()

Retrieves a previously created event object by name.

Yes

-

-

getEvent()

getEvents()

Retrieves all event objects currently defined in the configuration.

Yes

-

-

getEvents()

getFieldOptions()

Retrieves available options for a NetSuite dropdown field,multi-select field, or list.

-

Yes

Record type units + (Number of required options ÷ 10) + (Number of fields × 5)

getFieldOptions()

getFromExternal()

Retrieves data or perform a task in a parent window.

Yes

-

-

getFromExternal()

getItemPrice()

Retrieves pricing information for an item.

-

Yes

(Number of price levels ÷ 10) + 5

getItemPrice()

getLineNum()

Retrieves the line number associated with the configuration record.

Yes

-

-

getLineNum()

getMovDate()

Retrieves a date and time value from an answer and adds or subtracts days.

-

Yes

None

getMovDate()

getOrderData()

Retrieves body and sublist field values of the transaction page from which users open the product.

Yes

Yes

30

getOrderData()

getOrderField()

Retrieves the value of body fields of the transaction page from which users open the product.

Yes

-

-

getOrderField()

getOrderItems()

Retrieves line field values for the Items sublist of the transaction page from which users open the product.

Yes

-

-

getOrderItems()

getOrderSublist()

Retrieves the field values of sublist belonging to the transaction page from which users open the product.

Yes

-

-

getOrderSublist()

getParsedValue()

Retrieves and parses a date and time value from a date and time field.

Yes

Yes

None

getParsedValue()

getProgress()

Controls the status of a progress indicator associated with a configuration process.

Yes

-

-

getProgress()

getQTable()

Provides access to a qTable object.

Yes

Yes

None

getQTable()

getRemainingUnits()

Retrieves the number of remaining governance usage units.

-

Yes

None

getRemainingUnits()

getRuleset()

Retrieves data for a group of NetSuite CPQ building block.

Yes

-

-

getRuleset()

getTable()

Provides access to a table object to retrieve data for any product table type.

Yes

Yes

None

getTable()

getTable().loadContent()

Loads table content from the database.

Yes

Yes

  • Dynamic tables: (Number of required tables ÷ 10) + 10

  • Static tables: 10

  • CSV tables: 20

  • Function-generated tables: none

getTable()

getValue()

Retrieves the value associated with a specific answer.

Yes

Yes

None

getValue()

hasAnswer()

Determines if a question has been answered with a specific answer.

Yes

Yes

None

hasAnswer()

hideMessage()

Hides a message currently shown in the product interface.

Yes

-

-

hideMessage()

hideModal()

Hides or displays a tab or a group included in a popup window.

Yes

-

-

hideModal()

isAnswered()

Determines if a question has been answered in the current configuration.

Yes

Yes

None

isAnswered()

loadConfig()

Loads a saved configuration.

-

Yes

  • Loading from the File Cabinet: 10

  • All other cases: 5

loadConfig()

loadFavorite()

Loads a saved favorite configuration.

-

Yes

-

loadFavorite()

loadFile()

Loads files from the File Cabinet.

-

Yes

10

loadFile()

loadListKeyValue()

Retrieves a specific row from a static or CSV table.

Yes

-

-

loadListKeyValue()

loadListWithArray()

Retrieves multiple rows from a static or CSV table.

Yes

-

-

loadListWithArray()

nresolve()

Resolves the numeric value from a resolve expression.

Yes

Yes

None

nresolve()

priceMatrix()

Wraps the object returned by getItemPrice() in a method for retrieving prices.

Yes

Yes

See getItemPrice()

priceMatrix()

processItemCreations()

Creates items required by the configuration using active item creation records.

Yes

-

-

processItemCreations()

processRecordCreations()

Creates records required by the configuration using active creation records.

Yes

-

-

processRecordCreations()

queryParent()

Sends general communication requests from the current window to the parent window that has launched the script.

Yes

-

-

queryParent()

readFiles()

Retrieves information for every file attached to a file question.

Yes

-

-

readFiles()

recalcRulesets()

Updates information about answers and building blocks.

Yes

-

-

recalcRulesets()

removeLink()

Removes a link from the Link section on the product interface.

Yes

-

-

removeLink()

renderView()

Updates the product interface with the most recent data.

Yes

-

-

renderView()

reset()

Clears all answers given to a question or clears a specific answer.

Yes

Yes

None

reset()

resetTab()

Clears a tab selection in the product interface.

Yes

-

-

resetTab()

resolve()

Resolves a string that includes resolve expressions.

Yes

Yes

None

resolve()

restartAction()

Stops a server-side action and sends information to the client about whether to restart it.

-

Yes

None

restartAction()

runAction()

Runs a specified action.

Yes

-

-

runAction()

runSavedSearch()

Runs a previously created NetSuite saved search and returns the results.

-

Yes

5

runSavedSearch()

saveFile()

Creates or updates a file in the File Cabinet.

-

Yes

10

saveFile()

scopeApply()

Updates the product interface.

Yes

-

-

scopeApply()

scopeRefresh()

Updates the product interface and refreshes building blocks.

Yes

-

-

scopeRefresh()

sendMessage()

Sends messages from the current window to the parent window.

Yes

-

-

sendMessage()

setAnswer()

Sets a specific answer for a question.

Yes

Yes

None

setAnswer()

setFormattedValue()

Converts a JavaScript Date object into the string format expected by a NetSuite CPQ date and time field.

Yes

Yes

None

setFormattedValue()

setPicklistColumn()

Changes the reference column associated with a popup table or a popup list.

Yes

-

-

setPicklistColumn()

setTab()

Changes the active tab to the specified tab.

Yes

-

-

setTab()

setValue()

Sets or updates the value of a specific answer.

Yes

Yes

None

setValue()

showAudit()

Displays or hides the Audit button on the product interface.

Yes

-

-

showAudit()

showMessage()

Displays a custom alert message on the product interface.

Yes

-

-

showMessage()

showModal()

Displays a tab or a group in a popup window.

Yes

-

-

showModal()

showPicklistModal()

Prompts users to select options from popup tables or popup lists;

Yes

-

-

showPicklistModal()

sresolve()

Resolves a value from a resolve expression and, if possible, converts it into a number

Yes

Yes

None

sresolve()

startConfig()

Opens the configuration interface for the specified product using the provided information.

Yes

-

-

startConfig()

submitConfig()

Submits the configuration and determines what happens after the submission and where the configuration is submitted.

Yes

-

-

submitConfig()

updateRecordFields()

Updates specific fields on a given record type without saving the record.

-

Yes

Record type units × 2

updateRecordFields()

Related Topics

General Notices