Overview
BRYTER offers a Salesforce CPQ integration that enables you to build BRYTER modules that interact with Salesforce CPQ API and the object types it provides, such as Quote and Product.
This author guide is for customers who have set up the Salesforce CPQ Integration and wish to use the available actions nodes and data sources inside their BRYTER modules.
The action nodes and data sources made available by this integration are:
- cpq-read-quote Action node
- cpq-read-product Action node
- cpq-read-account Action node
- cpq-update-quote Action node
- cpq-upload-attachment Action node
- cpq-products-read Data Source
Below are in-depth instructions for using these resources in your BRYTER modules.
Action Nodes
BRYTER Salesforce CPQ integration provides five separate capabilities, each of which is reflected in a different Action node.
Get a Quote by ID
The cpq-read-quote Action node lets you get (aka “read” or “retrieve”) a Quote record by ID. The Action node accepts as input the Salesforce ID for the given Quote record. The Action node returns as outputs all of the data fields that make up the Quote record.
Get a Product by ID
The cpq-read-product Action node lets you get (aka “read” or “retrieve”) a Product record by ID. The Action node accepts as input the Salesforce ID for the given Product record. The Action node returns as outputs all of the data fields that make up the Product record.
Get an Account by ID
The cpq-read-account Action node lets you get (aka “read” or “retrieve”) the Account record that is associated with a given Quote. The Action node accepts as input the Salesforce ID for the Quote record, and it returns as outputs all of the data fields that make up the Account record that is associated with the Quote.
Update a Quote
The cpq-update-quote Action node lets you update a Quote record. It accepts as input the Salesforce ID of the Quote you wish to update, and new values for any fields you wish to modify. Note that you must use the data types required by Salesforce. For example you can not use a numerical value to update a text field.
Upload an Attachment to a Quote
The cpq-upload-attachment Action node lets you upload a file as an attachment to a Quote object. It accepts as input the Salesforce Owner ID for the uploaded file, the file itself, the name of the file and the ID for the Quote to which the file will be related. It returns as output the Salesforce ID for the uploaded file.
Note that currently the Owner ID must be the same Owner ID used to create and configure the Salesforce connected app that makes the integration possible.
Data Sources
BRYTER Salesforce CPQ integration also provides one Data Source option.
List of Product Records
The cpq-products-read Data Source lets you provide your end users with a drop down list consisting of all Product records. This Data Source can be used in Single Select Input nodes within a BRYTER module to present the end user with a drop down list of possible answers. Note that the drop down list is enabled with search and autocomplete for managing large records lists.
The values returned by this Data Source, when a single option is selected by the end user, are the name of the Product object and its Salesforce ID.