You are here:
Data Types for Configurator User Interface
The Apex classes contain data accessible through the user interface. The Configurator’s Data Manager acts as the primary user interface component that exports data to other components. As a third-party user you can pass the data into your own user interface component without the need for separate queries to fetch data.
Required Editions
| Available in: Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions of Revenue Cloud with the Revenue Cloud Growth license or the Revenue Cloud Advanced license |
The effective method to interact with the user interface is to import data through the Flow user interface properties that the Data Manager exports.
The effective way to modify quantities, attribute values, product options, and other state changes is to trigger LMS events for any updates your user interface component makes.
The Data Manager simplifies data management in your user interface component. It constantly updates and sends the latest information whenever changes occur. This creates a seamless flow where you don't need to actively listen for updates. Instead, you can simply import or watch the data directly from the flow properties.
The Configurator User Interface Data Manager exports the following Apex data types. This data is readily available for use by third-party configurators in the user interface, eliminating the need for them to query the data separately.
Apex Data Type: ProductConfig__Product
| Field Name | Type |
|---|---|
| id | String |
| quantity | Double |
| isConfigurable | Boolean |
| isActive | Boolean |
| quantityReadOnly | Boolean |
| isAssetizable | Boolean |
| isQuantityEditable | Boolean |
| isSelected | Boolean |
| isPersisted | Boolean |
| isHidden | Boolean |
| disabled | Boolean |
| isSoldOnlyWithOtherProds | Boolean |
| name | String |
| nodeType | String |
| productCode | String |
| productType | String |
| productComponentGroups | List<OptionGroup> |
| attributeCategories | List<AttributeCategory> |
| productKey | List<String> |
| additionalFields | Map<String, Object> |
| prices | List<Price> |
| productClassification | ProductClassification |
| productSellingModelOptions | List<ProductSellingModelOption> |
| qualificationContext | QualificationContext |
| minOptions | Integer |
| maxOptions | Integer |
| sequence | Integer |
Apex Data Type: ProductConfig__Attribute
| Field Name | Type |
|---|---|
| id | String |
| name | String |
| label | String |
| attributeCategoryId | String |
| attributeNameOverride | String |
| code | String |
| dataType | String |
| defaultValue | String |
| description | String |
| productKey | List<String> |
| isCloneable | Boolean |
| isConfigurable | Boolean |
| isHidden | Boolean |
| isPriceImpacting | Boolean |
| isReadOnly | Boolean |
| isRequired | Boolean |
| assetAttributeValue | String |
| attributeValue | String |
| attributeKey | String |
| attributePicklistValue | String |
| businessObjectType | String |
Apex Data Type: ProductConfig__AttributeCategory
| Field Name | Type |
|---|---|
| code | String |
| id | String |
| name | String |
| attributes | List<Attribute> |
Apex Data Type: ProductConfig__ConfiguratorContext
| Field Name | Type |
|---|---|
| transactionLineId | String |
| parentName | String |
| origin | String |
| transactionId | String |
| addedNodes | List<SalesTransactionItem> |
Apex Data Type: ProductConfig__Message
| Field Name | Type |
|---|---|
| text | String |
| type | String |
Apex Data Type: ProductConfig__NavigationInfo
| Field Name | Type |
|---|---|
| index | Integer |
| name | String |
| productKey | List<String> |
Apex Data Type: ProductConfig__OptionGroup
| Field Name | Type |
|---|---|
| id | String |
| name | String |
| minOptions | Integer |
| maxOptions | Integer |
| sequence | Integer |
| components | List<Product> |
| productKey | List<String> |
| classifications | List<ProductClassification> |
| parentProductId | String |
| pricebookId | String |
| parentProductName | String |
Apex Data Type: ProductConfig__Price
| Field Name | Type |
|---|---|
| pricebookEntryId | String |
| pricebookId | String |
| unitPrice | Double |
| pricingModel | PricingModel |
Apex Data Type: ProductConfig__PricingModel
| Field Name | Type |
|---|---|
| id | String |
| name | String |
| pricingModelType | String |
Apex Data Type: ProductConfig__PricingSummary
| Field Name | Type |
|---|---|
| id | String |
| name | String |
| sequence | Integer |
| quantity | Double |
| hasErrors | Boolean |
| productRelatedComponentId | String |
| productKey | List<String> |
| prices | List<SummaryPrice> |
| transactionLineAttributes | List<Attribute> |
| transactionLineGroups | List<OptionGroup> |
Apex Data Type: ProductConfig__ProductClassification
| Field Name | Type |
|---|---|
| id | String |
Apex Data Type: ProductConfig__ProductSellingModel
| Field Name | Type |
|---|---|
| id | String |
| name | String |
| sellingModelType | String |
| status | String |
Apex Data Type: ProductConfig__ProductSellingModelOption
| Field Name | Type |
|---|---|
| id | String |
| productId | String |
| productSellingModelId | String |
| productSellingModel | ProductSellingModel |
Apex Data Type: ProductConfig__QualificationContext
| Field Name | Type |
|---|---|
| reason | String |
| isQualified | Boolean |
Apex Data Type: ProductConfig__SalesTransactionItem
| Field Name | Type |
|---|---|
| id | String |
| salesTransactionItemSource | String |
| pricebookEntry | String |
| productSellingModel | String |
| sellingModelType | String |
| subscriptionTerm | Integer |
| pricingTermUnit | String |
| unitPrice | Double |
| quantity | Double |
| product | String |
| productCode | String |
| productName | String |
| productBasedOn | String |
| businessObjectType | String |
Apex Data Type: ProductConfig__SummaryPrice
| Field Name | Type |
|---|---|
| netAmount | Double |
| netUnitPrice | Double |
| isInclusive | Boolean |
| pricingTermUnit | String |
Apex Data Type: ProductConfig__TransactionRecord
| Field Name | Type |
|---|---|
| parentId | String |
| parentName | String |
| origin | String |
| pricingTermUnit | String |
