Customize the Enrich Enterprise Quote or Enterprise Order Options (Managed Package)

Customize the enterprise quote and enterprise order enrichment options to suit your business needs. .

Managed Package Icon This feature is part of the Communications Cloud managed package.

Quote and order enrichment display options and the associated functionality are determined by the CustomViewSetup Integration Procedure and the associated OmniScripts that are called by this Integration Procedure.

To customize the enterprise quote and order enrichment options, follow these instructions:

Enable Inline Edits for Values in a Column
On the Summary page in Enterprise Sales Management, you can update data in some columns by just going to the cell that you want to update and clicking the edit icon. However, many columns don't allow you to perform these inline edits.
Add, Rename, or Remove a Display Option
On the Summary page in Enterprise Sales Management, the Displaying list provides the default set of options for grouping and displaying fields. You can add, rename, or remove these default options based on your business needs.
Customize the Fields Associated with a Display Option
On the Summary page in Enterprise Sales Management, the Displaying list provides some options for grouping and displaying fields. Customize these options based on your business needs.
Modify the OmniScript Associated with a Display Option
On the Summary page in Enterprise Sales Management, you can use the Enrich Quote or Enrich Order button to launch an OmniScript to update identical values in multiple line items at one time.

Enable Inline Edits for Values in a Column

On the Summary page in Enterprise Sales Management, you can update data in some columns by just going to the cell that you want to update and clicking the edit icon. However, many columns don't allow you to perform these inline edits.

For example, you can perform inline edits for the Service Identifier column and the Connect Date column. However, you can't perform inline edits for the Billing Address, One Time Total, or Recurring Total columns.

The CustomViewSetup Integration Procedure controls which columns on the Summary page allow inline edits. To enable inline edits:

In the App Launcher, go to All Items and click OmniStudio Integration Procedures.
In the list of Integration Procedures, go to ESM/CustomViewSetup. Expand the node and click the active version of this Integration Procedure.
In the Procedure Configuration element, click Create Version.
In the ReadOnlyFields element, click Edit as JSON.

The elementValueMap node shows all the fields that have the isEditable value set to false. For example:

{
	"Fields": {
		"vlocity_cmt__OneTimeTotal__c": {
			"align": "right",
			"isEditable": false,
			"isVisible": true,
			"label": "One Time Total",
			"type": "Currency"
		},
		"vlocity_cmt__QuoteGroupId__r.vlocity_snair3__MemberType__c": {
			"isEditable": false,
			"isVisible": false,
			"type": "Text"
		},
.
.
.
	}
}

Edit this list to update isEditable to true for fields for which you want to enable inline edits.

In the Procedure Configuration element, click Save and then click Activate Version.
Refresh the Summary page of an enterprise quote or enterprise order to verify your changes.

If you specified isEditable as true for a field, you can update the values in that column directly on the Summary page.
If you specified isEditable as false for a field, you can't update the values in that column directly on the Summary page.

Add, Rename, or Remove a Display Option

On the Summary page in Enterprise Sales Management, the Displaying list provides the default set of options for grouping and displaying fields. You can add, rename, or remove these default options based on your business needs.

In the App Launcher, go to All Items and click OmniStudio Integration Procedures.
In the list of Integration Procedures, go to ESM/CustomViewSetup. Expand the node and click the active version of this Integration Procedure.
In the Procedure Configuration element, click Create Version.
In the CustomViewFieldsMapper element, go to the Element Name section. The names listed here appear as options in the Displaying list on the Summary page.
To add a display option:
1. Click Add New Value.
2. Enter the name that you want to show in the Displaying list on the Summary page.
3. Click Edit as JSON to enter the JSON structure for the fields that you want to associate with the new display option.
4. Associate the relevant OmniScript with the new display option.
To rename a display option, enter the new name in the Element Name field.
To remove a display option, click the delete icon.
In the Procedure Configuration element, click Save and then click Activate Version.
Refresh the Summary page of an enterprise quote or enterprise order to verify your changes.

Customize the Fields Associated with a Display Option

On the Summary page in Enterprise Sales Management, the Displaying list provides some options for grouping and displaying fields. Customize these options based on your business needs.

For example, you can:

Move fields around to associate them with different display options.
Customize the labels that appear as column headings.
Enable inline edits, specify data type and format for a field.
Hide fields.

The CustomViewSetup Integration Procedure controls which columns on the Summary page are associated with the Displaying options and the properties of these columns. To customize fields associated with options in the Displaying list:

In the App Launcher, go to All Items and click OmniStudio Integration Procedures.
In the list of Integration Procedures, go to ESM/CustomViewSetup. Expand the node and click the active version of this Integration Procedure.
In the Procedure Configuration element, click Create Version.
In the CustomViewFieldsMapper element, click Edit as JSON.

Note Fields of the type "picklist" aren't supported.

The elementValueMap node shows the fields that are associated with each display option. For example:

{
 	"All": {
 		"vlocity_cmt__BillingAccountId__r.Name": {
 			"isEditable": false,
 			"isVisible": true,
 			"label": "Billing Account Name",
 			"type": "Text"
 		},
 		"vlocity_cmt__ConnectDate__c": {
 			"format": "MM/DD/YYYY",
 			"isEditable": true,
 			"isVisible": true,
 			"label": "Connect Date",
 			"outputFormat": "YYYY-MM-DD",
 			"type": "Date"
 		},
 		"vlocity_cmt__ServiceIdentifier__c": {
 			"isEditable": true,
 			"isVisible": true,
 			"label": "Service Identifier",
 			"type": "Text"
 		}
 	},
 	"Installation": {
 		"vlocity_cmt__ConnectDate__c": {
 			"format": "MM/DD/YYYY",
 			"isEditable": true,
 			"isVisible": true,
 			"label": "Connect Date",
 			"outputFormat": "YYYY-MM-DD",
 			"type": "Date"
 		}
 	},
 	"Number Assignment": {
 		"vlocity_cmt__ServiceIdentifier__c": {
 			"isEditable": true,
 			"isVisible": true,
 			"label": "Service Identifier",
 			"type": "Text"
 		}
 	},
 	"Payment": {
 		"vlocity_cmt__BillingAccountId__r.BillingAddress": {
 			"isEditable": false,
 			"isVisible": true,
 			"label": "Billing Address",
 			"type": "Address"
 		},
 		"vlocity_cmt__BillingAccountId__r.Name": {
 			"isEditable": false,
 			"isVisible": true,
 			"label": "Billing Account Name",
 			"type": "Text"
 		}
 	},
 	"Status": {
 		"vlocity_cmt__IsValidated__c": {
 			"align": "center",
 			"isEditable": false,
 			"isVisible": true,
 			"label": "Validated",
 			"type": "Status"
 		},
 		"vlocity_cmt__ValidationDate__c": {
 			"format": "MM/DD/YYYY",
 			"isEditable": false,
 			"isVisible": true,
 			"label": "Validation Date",
 			"type": "Date"
 		}
 	}
 }

This JSON indicates that:

Columns labeled Billing Account Name, Connect Date, and Service Identifier are displayed when the All option is selected in Displaying.
A column labeled Connect Date is displayed when the Installation option is selected in Displaying.
A column labeled Service Identifier is displayed when the Number Assignment option is selected in Displaying.
Columns labeled Billing Address and Billing Account Name are displayed when the Payment option is selected in Displaying.
Columns labeled Validated and Validation Date are displayed when the Status option is selected in Displaying.

For each column, attributes also indicate the field it maps to, whether it allows inline editing, whether it’s displayed or hidden, and the type and format of data.

To customize the fields associated with each display option:
1. Move fields to the relevant node in the JSON structure. For example, you can copy the field with the label Billing Address and add it under the All node. The column with the label Billing Address is then displayed when the All option is selected in Displaying.
2. Set isEditable to true to enable inline editing for a column or to false to disable inline editing.
3. Set isVisible to false to hide a field in a display option without removing it altogether.
4. Update the label associated with a field. For example, under Number Assignment, you can update Service Identifier to Phone Number. This column is then displayed with the label Phone Number.
5. Add new fields that you want to display for a specified display option. Create the JSON structure for the new field, specifying the field name along with the attributes.
In the Procedure Configuration element, click Save and then click Activate Version.
Refresh the Summary page of an enterprise quote or enterprise order to verify your changes.

Modify the OmniScript Associated with a Display Option

On the Summary page in Enterprise Sales Management, you can use the Enrich Quote or Enrich Order button to launch an OmniScript to update identical values in multiple line items at one time.

The OmniScript that is launched by the Enrich Quote or Enrich Order button varies depending on the option selected in the Displaying list. Each OmniScript allows you to update values in columns that are associated with the selected display option. By default, the following OmniScripts are associated with each display option:

Display Option	Associated OmniScript
Payment	QuoteEnrichForPayment
Number Assignment	QuoteEnrichForNumberAssignment
Installation	QuoteEnrichForInstallation
All	QuoteEnrichForAll

The CustomViewSetup Integration Procedure controls which OmniScript is launched by each display option. To customize the OmniScript that is associated with a display option:

Modify an existing OmniScript or create a new OmniScript based on an existing OmniScript.
1. In the App Launcher, enter OmniScripts and then click OmniScripts.
2. On the OmniScripts page, to modify an existing quote enrichment OmniScript, search for QuoteEnrich.
3. Go to the OmniScript that you want to modify. Expand the node and click the active version of the OmniScript.
4. Click New Version.
5. If you want to modify the existing OmniScript, you can specify a new Name if required, but don't change the Type or SubType of the OmniScript. If you want to create a new OmniScript, change the Type or SubType of the OmniScript and optionally specify a new name.
6. Click the step that you want to update. For example, in the QuoteEnrichForAll OmniScript, click Payment, Installation, or Number Assignment, to update the fields in that step of the OmniScript.
7. In the right pane, click the Build subtab and expand the Inputs section.
8. Drag the required input type from the Inputs section and drop it on to the relevant step element. Configure the input as required.
9. Click Update Cart Items.
10. In the right pane, click the Properties subtab and then click Edit Properties as JSON.
11. Look for the node extraPayload. In the QuoteEnrichForAll OmniScript, it looks like this:
```
{
	"cartItemIds": "%CartItemIds%",
	"fieldValues": {
		"vlocity_cmt__BillingAccountId__c": "%BillingAccount%",
		"vlocity_cmt__ConnectDate__c": "%Installation:ConnectDate%",
		"vlocity_cmt__ServiceIdentifier__c": "%ServiceIdentifier%"
		}

}
```
12. Update this JSON payload with the values for the fields that you just added.
13. Similarly, click UpdateCartItemsBatch and update the extraPayload node with the relevant field values there as well.
14. Click Activate.
Associate the modified OmniScript with the relevant display option.

Note If you modified an OmniScript that is already associated with the appropriate display option, you don't need to do anything else. However, if you want to associate the modified OmniScript with a new display option, or if you created a new OmniScript, set up the association between the OmniScript and the Integration Procedure by updating the CustomViewSetup Integration Procedure.
1. In the App Launcher, go to All Items and click OmniStudio Integration Procedures.
2. In the list of Integration Procedures, go to ESM/CustomViewSetup. Expand the node and click the active version of this Integration Procedure.
3. In the Procedure Configuration element, click Create Version.
4. In the CustomViewFieldsMapper element, in the Element Name section, note the name of the display option for which you want to customize the associated OmniScript. You can rename a display option or add a new display option here.
5. If you made any changes to the element name in the CustomViewFieldsMapper element, enter the same name here. If you added a new display option in the CustomViewFieldsMapper element, click Add New Value and enter the same name here.
6. In the CustomViewOMMapper element, in the Value section, enter the name of the OmniScript that you want to launch.
7. In the Procedure Configuration element, click Save and then click Activate Version.
Refresh the Summary page of an enterprise quote to verify your changes.