Download as pdf or txt
Download as pdf or txt
You are on page 1of 113

Vlocity Enterprise Product Catalog

Exercise Guide

Doc Version: CME08 Vlocity EPC EG v8.0.1.docx


CONFIDENTIAL

Vlocity Enterprise Product Catalog - Page 2


CONFIDENTIAL

Table of Contents
Table of Contents ............................................................................................................................ 3
Legal Notice ..................................................................................................................................... 4
Document Conventions.................................................................................................................. 5
Preface ............................................................................................................................................. 6
Vlocity Product Overview............................................................................................................... 9
Quick Setup for Vlocity Communications .................................................................................. 11
Exercise EPC-1: Creating Picklists (30 mins) ............................................................................ 13
Exercise EPC-2: Creating Product Attributes (15 mins) ........................................................... 25
Exercise EPC-3: Creating Product Object Types (30 mins) ..................................................... 34
Exercise EPC-4: Reviewing Product Life Cycles (15 mins)...................................................... 48
Exercise EPC-5: Creating Products (30 mins) ........................................................................... 58
Exercise EPC-6: Creating Product Bundles (15 mins) .............................................................. 77
Exercise EPC-7: Managing the Shared Catalog (20 mins) ....................................................... 88
Exercise EPC-8: Review the New Products in Vlocity Cart (15 mins) ................................... 103
Exercise EPC-9: Create Tablet Products .................................................................................. 109

Last Revision: 1/2/20

Table of Contents Vlocity Enterprise Product Catalog – Page 3


CONFIDENTIAL

Legal Notice
USE OF OUR EDUCATIONAL SERVICES, COURSES, AND TRAINING MATERIALS (COLLECTIVELY REFERED
TO AS “EDUCATIONAL SERVICES”) IS CONDITIONED UPON THE ACCEPTANCE OF THESE TERMS BY YOU
(ALSO REFERRED TO AS “PARTICIPANT”). BY DOWNLOADING, INSTALLING, OR OTHERWISE ACCESSING OR
USING THE EDUCATIONAL SERVICES, YOU AGREE THAT YOU HAVE READ, UNDERSTOOD, AND AGREE TO
BE BOUND BY THESE TERMS OF SERVICE. IF YOU DO NOT WISH TO BE BOUND BY THESE TERMS OF
SERVICE, PLEASE DISCONTINUE USE OF THE EDUCATIONAL SERVICES IMMEDIATELY.

For your review, the terms of service are available at the following URL:

https://vlocity.com/cms/resources/vlocity-university-terms-of-service-2016.pdf

Restrictions on Your Use

You are granted a nonexclusive, nontransferable, revocable, limited license to access and use our Educational Services
in accordance with the Terms of Service (https://vlocity.com/cms/resources/vlocity-university-terms-of-service-
2016.pdf). Only the authorized registrant may participate as a licensee and user of our Educational Services. As a
condition of your use of our Educational Services, you warrant to us that you will not use our Educational Services for
any purpose that is prohibited by the Terms of Service.

Our Proprietary Information

The material, content, and Educational Services provided by us or accessible from this Site and any other website
owned, operated, licensed, or otherwise controlled by us (the “Content”) is our proprietary information or the proprietary
information of the party that provided or licensed the Content to us, whereby we or such providing party retain(s) all
right, title, and interest in the Content.

Accordingly, the Content may not be copied, decompiled, reverse engineered, disassembled, transferred, distributed,
republished, resold, sublicensed, uploaded, posted, used to create derivative works, or transmitted in any way without
our prior written consent or the prior written consent of the Content owner, except that you may print out a copy of the
Content solely for your personal use, including as part of the applicable training or educational program.

Representations; Warranties; Disclaimer

YOUR USE OF OUR EDUCATIONAL SERVICES IS AT YOUR OWN RISK. THE EDUCATIONAL SERVICES ARE
PROVIDED “AS IS” AND WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED. WE
DISCLAIM ALL WARRANTIES, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
A PARTICULAR PURPOSE, TITLE, OR NON-INFRINGEMENT. WE DO NOT WARRANT THAT THE FUNCTIONS
OR CONTENT ASSOCIATED WITH OUR EDUCATIONAL SERVICES WILL BE UNINTERRUPTED OR ERROR-
FREE, THAT DEFECTS WILL BE CORRECTED, OR THAT OUR SITE AND EDUCATIONAL SERVICES ARE FREE
OF VIRUSES OR OTHER HARMFUL COMPONENTS. WE DO NOT WARRANT OR MAKE ANY REPRESENTATION
REGARDING USE, OR THE RESULT OF USE, OF THE EDUCATIONAL SERVICES IN TERMS OF ACCURACY,
RELIABILITY, OR OTHERWISE. THE EDUCATIONAL SERVICES MAY INCLUDE TECHNICAL INACCURACIES OR
TYPOGRAPHICAL ERRORS, AND WE MAY MAKE CHANGES OR IMPROVEMENTS AT ANY TIME.

© 2020 Vlocity, Inc.

Vlocity Enterprise Product Catalog - Page 4 Legal Notice


CONFIDENTIAL

Document Conventions
This training material uses the following conventions.

Convention Meaning Example


Boldface text This formatting highlights the name Click Save.
of a button, menu, link, field,
checkbox, radio button, list, list
option, or panel.

[Boldface text in This formatting highlights a variable /services/apexrest/vlocity_[NS]/v2/DataRapto


brackets] name. Replace this value with the r/AccountExtract/
value for your training environment.

Monospace text This formatting highlights text that IF(CONTAINS(%input_string%, %valu


you must type exactly as it appears, e%), %thenValue%, %elseValue%)
or it is a code example.

VLOCITY SUPPORT

For questions or assistance with your Vlocity implementation, please contact Vlocity Support
or your account manager.

ADDITIONAL RESOURCES

Indicates additional supporting materials or online resources.

TIPS AND TRICKS | BEST PRACTICES

Indicates nice-to-know information, best practices, or useful tips and tricks.

Remove the titles that do not apply. For example, if the callout is a best practice, just have
“BEST PRACTICES” as the callout title.

IMPORTANT

Indicates cautionary or important information.

NOTE

This is an informational note. It provides more detail and draws the reader’s attention.

Document Conventions Vlocity Enterprise Product Catalog – Page 5


CONFIDENTIAL

Preface
These training exercises are based on the Fall’19 release of Vlocity Communications. For additional
information about the topics covered in this module, see the documentation available in Vlocity Success
Community at https://success.vlocity.com.

Overview
This Vlocity EPC module covers fundamental features and functionality of Vlocity Enterprise Product
Catalog, a key product of the Vlocity Communications & Media application. This module will introduce
Vlocity’s shared catalog capabilities including how to use Vlocity Product Console to create products and
manage the shared catalog.

This is a hands-on course with practical lab exercises. The lab exercises are designed to be used with the
provided Trialforce organization.

What You Will Learn


When you complete this training, you will be able to:

• Navigate Vlocity Product Console


• Create picklists and picklist items
• Create product attributes and attribute categories
• Create product object types and understand the inheritance architecture
• Define product selling periods and create products using them
• Set product attribute metadata and override attribute defaults
• Create product bundles and define product cardinality
• Calibrate product attributes
• Explain and set up the platform cache
• Build product hierarchies and initialize the cache
• Describe the CME batch jobs and review their status

Prerequisites
The prerequisites for this training include a solid understanding of basic Salesforce concepts and
functionality. You should also have a working knowledge of telecommunications industry business
objectives.

Vlocity Enterprise Product Catalog - Page 6 Preface


CONFIDENTIAL

About the Exercises


With Vlocity applications, it’s important to learn by doing. In this exercise guide, you’ll be presented with
many hands-on exercises. There are two types of hands-on exercises: lab exercises and challenge
exercises. It's recommended that you complete the exercises in order.

Lab exercises include:

• A brief scenario that explains the use case or business need that drives the
application feature or functionality.
• A list of tasks
• Step-by-step instructions on how to complete the tasks.

Challenge exercises include:

• A brief scenario that explains the use case or business need that must be met.
• A list of requirements or tasks to complete.

There are three levels of challenge.

A Level 1 Challenge:

• Reinforces the skills you learned in the lab exercises

A Level 2 Challenge:

• Is similar to a Level 1 Challenge


• Requires additional practice of the current skill or skills from previous lessons

A Level 3 Challenge:

• Is more advanced
• Requires you to integrate several skills from different lessons together

Challenge exercises solidify what you learned in the lab exercises, build your skills, and allow you to
make mistakes—which is how you will master this application.

Preface Vlocity Enterprise Product Catalog – Page 7


CONFIDENTIAL

Vlocity Enterprise Product Catalog - Page 8 Preface


CONFIDENTIAL

Vlocity Product Overview


Vlocity Enterprise Product Catalog
Vlocity Enterprise Product Catalog, or Vlocity EPC, revolutionizes the CPQ and order management space
by providing the first enterprise catalog-driven applications that:

• Integrates into your end-to-end ecosystem by combining a complete product, service and
resource model to drive sales, CPQ, ordering and fulfillment functions.
• Provides one user interface with common tools, enabling your teams to collaboratively and rapidly
create, manage and deliver offerings to market.
• Allows for an evolutionary approach to transform both front office and back office systems to
become catalog-driven over time. This supports the elimination of data silos and the mastering of
both commercial and technical entities in a single model.

Vlocity EPC is powered by a shared catalog. Vlocity’s shared catalog uses a metadata-driven approach to
accommodate all of the incarnations of a product, as it travels from a twinkle in the customer’s eyes to the
physical implementation in the customer’s hands. Vlocity EPC is TMForum SID compliant. It supports all
levels of product definitions, including offers, product specifications, services, and resource specifications.

• Offers are designed by Marketing, sold to particular channels, customer segments with specific
pricing.
• The Product Spec is created by Product Management and describes all of the product
components.
• Then, using Vlocity Order Management, the Product Spec is translated into the various technical
and manufacturing spec products that are tuned for each of the downstream systems that use
them.

Vlocity Product Console


Vlocity Product Console provides a unified user experience to manage EPC elements in a single,
contextual interface. Using this interface, you will perform product management by defining and
maintaining product entities. You will also build foundational constructs like attributes and picklists, as well
as metadata constructs like product object types. You will also see many elements of Vlocity CPQ co-
located in the Product Console, to provide seamless integration between the shared catalog and the
ability to configure, price and quote the products in the catalog.

Vlocity CPQ
Vlocity CPQ is a powerful rules engine that ensures that quotes and orders are valid before they’re
submitted, minimizing order delays and customer confusion and dissatisfaction. CPQ picks up where
CRM ends, providing real-time product, pricing, and business rules using natural language and
declarative administration. Using Vlocity CPQ, you can:

• Design basic and advanced availability, eligibility, compatibility, and pricing rules
Vlocity Product Overview Vlocity Enterprise Product Catalog – Page 9
CONFIDENTIAL

• Standardize new product and service introductions


• Ensure accurate capture of new, move, add, change and disconnect orders

Vlocity CPQ supports both B2B and B2C lead-to-cash processes. Vlocity’s open architecture allows you
to use Vlocity CPQ components, services, and user interface selectively as individual components and to
integrate process flows with external systems, all using a unified user interface.

Product Model
The product model of the product entities that you will build in this training module is diagrammed below.

Vlocity Enterprise Product Catalog - Page 10 Vlocity Product Overview


CONFIDENTIAL

Quick Setup for Vlocity Communications


Before starting your exercises, ensure that you have completed the setup tasks. This only needs to be
completed once for each Communications, Media & Energy org. For detailed information on these tasks,
please see Vlocity EPC training.

1. Set up My Domain.

a. Log into your training org.


b. Go to Setup.
c. In the Quick Find box, type my domain. Click My Domain.
d. In My Domain Step 1, enter a unique domain name. You can try the unique part of your training
org login plus the industry for this. For example, if your login is name@company.com.vusrvo-
999999, try vusrvo-999999-cme. Or if your login is student9999@cme.edu, try
student9999-cme.
e. Click Check Availability.
f. Click Register Domain. This process typically takes less than 30 minutes.

2. Calibrate product attributes.

a. Using the Lightning App Launcher in the upper-left, click the Vlocity CME Admin app.
b. In the Lightning navigation bar, click Vlocity Attributes.
c. Click Recently Viewed and change the list view to All.
d. In the upper-right, click Process Attributes.
e. Click Start processing.

3. Set up the platform cache.

a. Open Setup in a new browser tab.


b. In the Quick Find box, type Platform Cache. Click Platform Cache.
c. Click Edit to edit the CPQPartition.
d. Under Org Cache Allocation, enter 5.
e. Click Save.
f. Click Back to Platform Cache Partitions.
g. Click Request Trial Capacity and click OK.
h. Close the Setup browser tab.

4. Initialize the platform cache.

a. Return to the browser tab that has the Vlocity CME Admin app open.
b. In the Lightning navigation bar, click Vlocity CMT Administration.
c. Under Admin Console, click Maintenance Jobs.
d. On the Maintenance Jobs page, find the PRODUCT HIERARCHY MAINTENANCE job, and
click Start.
e. In the Product Hierarchy Maintenance dialog box, click OK.
f. Messages should display indicating that the job completed successfully.
g. At the bottom of the list of jobs, find REFRESH PLAFORM CACHE, and click Start.
h. In the REFRESH PLATRFORM CACHE dialog box, click OK.
Quick Setup for Vlocity Communications Vlocity Enterprise Product Catalog – Page 11
CONFIDENTIAL

i. A message will display on the page indicating that the job completed successfully.

5. Deploy Your Domain.

a. Go to Setup.
b. In the Quick Find box, type my domain. Click My Domain.
c. If your domain is ready to be deployed, you will see My Domain Step 3. If you do not see this,
wait until your domain is ready. You should receive an email notification.
d. Under your domain name in the middle of the page, click the Log in button to relaunch your
browser in your domain.
e. Click Deploy to Users and click OK.
f. Click Switch to Lightning Experience to return to Lightning.
g. Close any extra browser tabs open in the old domain.

That’s it! Your Communications, Media & Energy training org is ready for you to begin the lab exercises.

Vlocity Enterprise Product Catalog - Page 12 Quick Setup for Vlocity Communications
CONFIDENTIAL

Exercise EPC-1: Creating Picklists (30 mins)


Scenario

Following Vlocity’s product modelling best practices, Felix builds the new smartwatch
product model in the Vlocity Product Console from the bottom up, which means his first step
is to create attribute picklists for Connectivity, Band Type, and Band Color. As Felix knows
well, picklists protect us from the human frailty of data entry errors, and thus the attributes
he will create rely heavily on picklists.

What You Will Learn


• Navigate Vlocity Product Console
• Create a picklist
• Create picklist items

Task Overview
Task 1: Review Vlocity Product Console
Task 2: Create a picklist
Task 3: Create picklist items
Task 4: Create additional picklists and picklist items

What is Vlocity picklist?

When an attribute has multiple values, a picklist represents all of the defined values for that attribute.
Picklists in Vlocity EPC perform a similar function as Salesforce picklists, but they are custom objects
called Vlocity Picklists (API name: vlocity_cmt__Picklist__c). Picklists can be created with data
types of text, number, Boolean (True/False), date or date time. Picklists are designed to be globally
reusable across attributes assigned at the object type level or at the product level.

EPC-1: Creating Picklists (30 mins) Vlocity Enterprise Product Catalog – Page 13
CONFIDENTIAL

Task 1: Review Vlocity Product Console

Using the Lightning App Launcher , click Vlocity CPQ.

In the Lightning navigation bar, click Vlocity Product Console.

Review the Dashboard, which provides a unified user experience to manage EPC and CPQ
elements in a single contextual interface.

a. Notice the EPC elements: Product, Attribute, Picklist, Object, Facet, and Section.
b. Notice the CPQ elements: Promotion, Discount, Offer Migration Plan, Pricing, String
Translations and Rules (Context Rules)
c. Notice the Switch to Salesforce link in the upper right, which allows you to exit Vlocity
Product Console.

Under Product Management next to Product, click the search icon.

Next to the Search Product… entry dialog, click the search icon. The list of all products is
returned.

Click the name of the 4G LTE Data Plan product in the list or click the Edit icon to open the
product for editing.

Vlocity Enterprise Product Catalog - Page 14 EPC-1: Creating Picklists (30 mins)
CONFIDENTIAL

Similar to the tab navigation bar in Salesforce, notice the list of tabs that have built in the
Console’s tab navigation bar.

Notice the reload icon in the in the right corner.

IMPORTANT

Do not use your browser’s refresh or back buttons while working in Vlocity Product Console.
Using these buttons will cause you to exit from the Console, and any changes that have not
been saved will be lost. Instead, use the reload icon to refresh the page when necessary, and
the Console’s tab navigation bar.

Notice the Save button.

IMPORTANT

Vlocity Product Console does not use an implicit save model. All changes must be explicitly
saved using the provided buttons in the user interface.

Notice the related items (like General Properties) listed on the left; these interface elements are
called facets.

In the Console’s tab navigation bar, click the Xs to dismiss the tabs that you opened and return to
the Dashboard.

EPC-1: Creating Picklists (30 mins) Vlocity Enterprise Product Catalog – Page 15
CONFIDENTIAL

Task 2: Create a picklist

2.1 Under Foundation next to Picklist, click the new icon. This launches the New Picklist
dialog.

2.2 Notice the required fields: Name, Code and Data Type.

NOTE

Required fields for picklists and other EPC objects are not set via Salesforce Setup; rather,
they are set within Vlocity Product Console using Object Type Layout Management field
requirements. You can configure EPC object field requirements to your own unique
specifications and processes. We will look at this in detail later in the Creating Product Object
Types exercise.

2.3 In the New Picklist dialog, enter the following information.

Field Value Notes

Name Connectivity

Code PKL_CONNECT Vlocity recommends using a PKL_ prefix


to easily identify picklists. This value is
not required to be unique.

Description Wearable connectivity options

Data Type Text


Active ✓ Vlocity recommends setting Active
flag, although it is not currently
enforced.
Effective From [today’s date] Vlocity recommends setting the
Effective From (and Effective Until, if
desired) fields, although it is not
currently enforced.

NOTE

The picklist fields above are only visible at design-time. In other words, none of the
information entered above will be visible at run-time to users during order capture.

Vlocity Enterprise Product Catalog - Page 16 EPC-1: Creating Picklists (30 mins)
CONFIDENTIAL

2.4 Click Save. You will see a green “Picklist created!” success message.

EPC-1: Creating Picklists (30 mins) Vlocity Enterprise Product Catalog – Page 17
CONFIDENTIAL

2.5 Once the picklist is saved, you will now see a panel on the left, listing all of the facets for this
object, which for picklists includes the General Properties facet and the Picklist Items facet.

Vlocity Enterprise Product Catalog - Page 18 EPC-1: Creating Picklists (30 mins)
CONFIDENTIAL

Task 3: Create picklist items

3.1 Click the Picklist Items facet.

3.2 Under Picklist Items, click New Item. The new picklist item dialog will open in a pane on the
right.

3.3 In the New Picklist Item dialog under the reload icon, notice the resize and close buttons on the

right.

3.4 Enter the following information.

Field Value Notes


Text Value GPS This value will be evaluated programmatically, such as in
Vlocity Order Management’s decomposition process. The data
type of this field is set by the picklist data type. Because we
specified a text data type on the picklist, we have a text entry
field on the picklist item.
Label GPS This value will be visible to the user at run-time in Vlocity Cart.
Code PLI_GPS This value is not required to be unique.
Abbreviation This value is optional. It is used to abbreviate the label
text when needed.
Sequence 10 Vlocity recommends using sequences of 10, 20, 30 to
simplify later insertions.
Active ✓ Vlocity recommends setting the Active flag, although it is
not currently enforced.
Effective From [today’s date] Vlocity recommends setting the Effective From (and
Effective Until, if desired) fields, although they are not
currently enforced.

EPC-1: Creating Picklists (30 mins) Vlocity Enterprise Product Catalog – Page 19
CONFIDENTIAL

3.5 Click Save. You will see a green success message.

3.6 Under Picklist Items, click New Item.

3.7 Enter the following information.

Field Value
Text Value GPS Cellular
Label GPS + Cellular
Code PLI_GPS_CELL
Sequence 20
Active ✓
Effective From [today’s date]

Vlocity Enterprise Product Catalog - Page 20 EPC-1: Creating Picklists (30 mins)
CONFIDENTIAL

3.8 Click Save. You will see a green success message.

3.9 In the Console tab navigation bar, click the X to close the Connectivity tab.

EPC-1: Creating Picklists (30 mins) Vlocity Enterprise Product Catalog – Page 21
CONFIDENTIAL

Task 4: Create additional picklists and picklist items

4.1 Create a picklist and picklist items for Band Type using the steps you’ve just learned.

BAND TYPE PICKLIST

Field Value
Name Band Type
Code PKL_BAND_TYPE
Description Wearable watchband options
Data Type Text
Active ✓
Effective From [today’s date]

BAND TYPE PICKLIST ITEMS

Picklist Text Label Code Sequence Active Effective


Item # Value From
1 Sport Sport PLI_SPORT 10 ✓ [today’s date]
2 Stainless Steel Stainless Steel PLI_STEEL 20 ✓ [today’s date]

Vlocity Enterprise Product Catalog - Page 22 EPC-1: Creating Picklists (30 mins)
CONFIDENTIAL

4.2 Create a picklist and picklist items for Band Color.

BAND COLOR PICKLIST

Field Value
Name Band Color
Code PKL_BAND_COLOR
Description Wearable watchband color options
Data Type Text
Active ✓
Effective From [today’s date]

BAND COLOR PICKLIST ITEMS

Picklist Text Label Code Sequence Active Effective


Item # Value From
1 Fog Fog PLI_CLR_01 10 ✓ [today’s date]
2 Pink Sand Pink Sand PLI_CLR_02 20 ✓ [today’s date]
3 Gray Gray PLI_CLR_03 30 ✓ [today’s date]
4 Black Black PLI_CLR_04 40 ✓ [today’s date]
5 White White PLI_CLR_05 50 ✓ [today’s date]
6 Seashell Seashell PLI_CLR_06 60 ✓ [today’s date]

In the next exercise, we will put these picklists to work by linking them to product attributes.

EPC-1: Creating Picklists (30 mins) Vlocity Enterprise Product Catalog – Page 23
CONFIDENTIAL

Review
Confirm your understanding by answering these questions.

• Are picklists in Vlocity EPC the same as picklists in Salesforce?


• Why would you create a picklist? What purpose does it serve?
• Which fields of the picklist or picklist item are visible to the user at run-time?
• Which field in a picklist item is used for programmatic evaluation?

Vlocity Enterprise Product Catalog - Page 24 EPC-1: Creating Picklists (30 mins)
CONFIDENTIAL

Exercise EPC-2: Creating Product Attributes (15 mins)


Scenario

Vlocity Product Attributes are an important part of Vlocity Communications & Media since
they are used not only to price and configure products at run-time but also to map
commercial products to technical products in order management processes. Felix is on
board with the beauty of product attributes, and so he creates attributes to describe his new
smartwatch wearable products.

What You Will Learn


• Create attribute categories
• Create product attributes
• Link picklists to product attributes

Task Overview
Task 1: Create a Wearable attribute category
Task 2: Create a Band Type product attribute
Task 3: Create a Connectivity product attribute
Task 4: Review the product attributes in the Wearable attribute category

What is an attribute category?

Attribute categories are used to group attributes. They also display as headings at run-time in Vlocity
Cart’s Filter and Configuration windows. Attribute categories are required to create product attributes.

What is a product attribute?

Product attributes provide a powerful and flexible way to extend product entities. Product attributes are
stored in an aggregate JSON blob on the Product object and are used extensively throughout Vlocity
CPQ and Vlocity Order Management. In Vlocity CPQ, we can use product attributes to filter products at
run-time, displaying the best fit products to customers. We can use them to configure product
specifications, allowing users to specify product colors, sizes, and other options. We can also use
attributes to change product pricing using attribute-based pricing rules. Finally, in Vlocity Order
Management, we can use attributes to map commercial products, or the products that customers see,
with technical products that communicate with backend systems to fulfil the products that are purchased.

EPC-2: Creating Product Attributes (15 mins) Vlocity Enterprise Product Catalog – Page 25
CONFIDENTIAL

Create a Wearable attribute category

We’ll group all of our smartwatch attributes in a Wearable attribute category.

IMPORTANT

Product attributes should be created and managed only through Vlocity Product Console and
never through the Salesforce Product tab.

In the Lightning navigation bar, click More, and then right-click Vlocity Attribute Categories to
open in a new browser tab.

Click New.

Enter the following information.

Field Value Notes


Name Wearables This value is displayed at run-time in Vlocity Cart’s filter and
configuration windows, so it should be customer friendly.
Code ACAT_WEAR This value is required and must be unique. This code is
displayed only during design-time.
Description For wearable This value is used only during design-time.
product options
Applicable Types Product2 This value is required for product attributes.
Applicable Sub Type Product Attribute This value is required for product attributes.
Display Sequence 40 This value is required and must be unique. It’s used to
sequence the attribute category in Vlocity Cart’s filter and
configuration windows. Vlocity recommends using a 10,
20, 30 sequence to enable easy insertions in the
sequence at a later date.

Vlocity Enterprise Product Catalog - Page 26 EPC-2: Creating Product Attributes (15 mins)
CONFIDENTIAL

Click Save.

Click X in this browser tab to close the current tab. This will bring you back to Vlocity Product
Console.

EPC-2: Creating Product Attributes (15 mins) Vlocity Enterprise Product Catalog – Page 27
CONFIDENTIAL

Create a Band Type product attribute

In the Product Console’s tab navigation bar, click X on any open tabs to close them. This will
bring you back to the Dashboard.

Under Foundation next to Attribute, click the new icon. This will launch the New Attribute
dialog.

In the New Attribute dialog, enter the following information.

Field Value Notes


Name Band Type This value is required and will be visible at run-time in Vlocity
Cart’s filter and configuration windows.
Code ATT_RT_BT This value is required, and only visible during design-time.
Vlocity recommends using an ATT_ prefix to easily identify
attributes. This value is not required to be unique. In addition,
if desired, you can code in the type of attribute, such as RT
for Run-Time, DT for Design-Time, or DC for Decomposition
(used in Vlocity Order Management).
Description Smartwatch band This value is displayed only at design-time and can be used
types to provide more information about the attribute.
Active ✓ The Active flag must be checked for the attribute to display.
Attribute Category Wearables Using the lookup dialog, select the Wearables attribute
category that we just created.
Value Type Picklist For more information on the other attribute value types,
please see Vlocity Success Community.
Value This field is used to enter a value for other value types such
as Text or Number. We are using a picklist, so no value is
needed because all values will come from the linked picklist.
Picklist Band Type Using the lookup dialog, select the Band Type picklist we
created in the previous exercise.
Display Sequence 10 This value is required and must be unique within the Attribute
Category, although it is not enforced currently during data
entry. If it is not unique, the attribute will not display in Vlocity
Cart’s filter window.

NOTE

The Filterable flag is used to create filterable attributes that filter the product list in Vlocity
Cart. However, attributes using picklist or multi-picklist value types are currently not
supported as filterable attributes.

Vlocity Enterprise Product Catalog - Page 28 EPC-2: Creating Product Attributes (15 mins)
CONFIDENTIAL

NOTE

The Display Sequence and Filterable fields have been configured in your training org to
display in Vlocity Product Console. Out of the box, these fields are accessed in the Vlocity
Attribute Category Detail – Vlocity Attribute Edit page in the Aloha interface.

Click Save, and a green Attribute created! message displays.

Click the Applicable Objects facet on the left.

EPC-2: Creating Product Attributes (15 mins) Vlocity Enterprise Product Catalog – Page 29
CONFIDENTIAL

In the Applicable Objects list, verify the box next to Product2 Object is checked.

Click Save. (No success message will display this time.)

IMPORTANT

If the Applicable Object is not set (or you forget to save it), the attribute will not display when
creating an object type or a product. This is a very common mistake, so don’t let this happen
to you!

In the Console’s tab navigation bar, click the X to close the Band Type window.

Vlocity Enterprise Product Catalog - Page 30 EPC-2: Creating Product Attributes (15 mins)
CONFIDENTIAL

Create a Connectivity product attribute

Under Foundation next to Attribute, click the new icon. This will launch the New Attribute
dialog.

In the New Attribute dialog, enter the following information.

Field Value

Name Connectivity

Code ATT_RT_CT

Description Smartwatch connectivity option

Active ✓
Attribute Category Wearables
Value Type Picklist
Picklist Connectivity
Display Sequence 20

EPC-2: Creating Product Attributes (15 mins) Vlocity Enterprise Product Catalog – Page 31
CONFIDENTIAL

Click Save, and a green Attribute created! message displays.

Click the Applicable Objects facet on the left.

In the Applicable Objects list, verify the box next to Product2 Object is checked.

Click Save. (No success message will display this time.)

Vlocity Enterprise Product Catalog - Page 32 EPC-2: Creating Product Attributes (15 mins)
CONFIDENTIAL

Review the product attributes in the Wearable attribute category

In the Lightning navigation bar, click More, and then right-click Vlocity Attribute Categories to
open in a new browser tab.

Under Recently Viewed, click Wearables.

Review the new attributes in the attribute category.

Click X in your browser tab to close the current tab. This will bring you back to Vlocity Product
Console.

In case that wasn’t enough, there’s more to learn about product attributes. They have additional metadata
properties that are set when the attributes are assigned to an object type or a product, which we will do in
the next two exercises.

Review
Confirm your understanding by answering these questions.

• What are attribute categories and how are they used?


• What are product attributes and how are they used?
• What interface should be used to manage attribute categories? Product attributes?
• What fields will display at run-time in Vlocity Cart for attribute categories? Product attributes?

EPC-2: Creating Product Attributes (15 mins) Vlocity Enterprise Product Catalog – Page 33
CONFIDENTIAL

Exercise EPC-3: Creating Product Object Types (30 mins)


Scenario

Now that Felix has the “foundation” of his product model built, he’s ready to develop the
“framing”. Using the power of product object types, he can streamline the creation of his
product catalog by creating classes of products that have similar characteristics. In his model,
he decides to add a new SmartWatch as an object subtype of the SmartPhone object type,
which will allow his new object type to inherit all of the fields and attributes defined in the
object hierarchy.

What You Will Learn


• Create product object types
• Understand the inheritance architecture of product object types
• Assign product attributes and attribute metadata to an object type
• Modify object type layouts

Task Overview
Task 1: Review the existing product object type hierarchy
Task 2: Review the attribute and field assignments
Task 3: Review an object type layout
Task 4: Create a new product object type
Task 5: Add attributes for the product object type
Task 6: Set attribute metadata for the product object type
Task 7: Modify the product object type’s layout

What is a product object type?

A product object type is a reusable entity that describes a common set of fields and attributes as well as
the layouts for all linked products. We can use object types to group products with similar characteristics,
to ensure consistent behavior and application of rules.

Object types are designed with an IS-A inheritance type architecture. For those of you familiar with object-
oriented programming and design, you’ll recognize that object types create relationships between
abstractions where one object type is a subtype of another object type. The first level of abstraction is
called simply an object type, and the subsequent levels are called subtypes.

Vlocity Enterprise Product Catalog - Page 34 EPC-3: Creating Product Object Types (30 mins)
CONFIDENTIAL

Then, when we apply this relationship to a product, the object type allows the product to inherit all of the
characteristics of its object type hierarchy.

Vlocity recommends creating a base object type for each layer of your SID model (Offer Specs, Product
Specs, Service Specs and Resources Specs) during initial setup. These are essentially your product
catalog’s “primordial objects” from which all other products descend. You’ll assign all of the fields in the
product catalog to the base product object type, and then you can create object subtypes for all the
product classes and products in your catalog. They will then inherit the base product’s layout, fields, and
any attributes. Note that the base object type layouts must be created manually, which takes a few
minutes, but after that, all the subsequent object subtypes will inherit the layout when they are created.

NOTE

In your training org, an initial product object type hierarchy has already been created for you,
including all of the base product object types.

IMPORTANT

Currently, Vlocity does not recommend moving object types within the hierarchy.
Consequently, careful consideration is required when planning your object type hierarchy and
your product catalog design. Vlocity Services can assist with product catalog design and
modeling best practices.

EPC-3: Creating Product Object Types (30 mins) Vlocity Enterprise Product Catalog – Page 35
CONFIDENTIAL

Review the existing product object type hierarchy

You should be in the Dashboard of Vlocity Product Console. Click X to close any open tabs, if
necessary.

Under Metadata, click the search icon next to Object.

NOTE

There is no new icon next to Object because the Vlocity Product Console does not
allow the creation of custom EPC or CPQ objects. The objects in Vlocity Product Console are
created during installation and are part of the managed package.

Next to the Search Object… entry dialog, click the search icon. The list of objects is
returned.

Scroll down and click Product2 Object.

On Product2 Object, click the Object Types facet.

Review the object type hierarchy that has been prebuilt for you.

a. Notice the BASE objects types for the four SID layers.
b. Notice that the BASE Offer Spec Type has no object subtypes.

BEST PRACTICES

Vlocity recommends that object types in each of the SID layers are “tuned” to the product
entity as it is manifested within the current layer only. Product entities can then be
transformed from one layer to the next using Vlocity Order Management’s decomposition
mappings. In keeping with this best practice, you will notice that the BASE Offer Spec Type in
our product catalog has no object subtypes because “an offer is an offer” and should have
homogenous characteristics. However, the other BASE object types are not flat hierarchies
because the product entities they describe are fundamentally distinct from one another.

Click SmartPhone Product Spec or click the Edit icon next to the name to open the object
type for editing.

Vlocity Enterprise Product Catalog - Page 36 EPC-3: Creating Product Object Types (30 mins)
CONFIDENTIAL

Notice the SmartPhone Product Spec’s parent object type is the BASE Product Spec Type,
which means that all its fields and its layout have been inherited by the SmartPhone Product
Spec.

NOTE

Vlocity recommends that any data element that is common across the catalog be described
using a field, and data elements that are unique to a subset of products in the catalog be
described using an attribute. Following this best practice, all of the BASE object types in your
training have no attributes assigned, only fields.

EPC-3: Creating Product Object Types (30 mins) Vlocity Enterprise Product Catalog – Page 37
CONFIDENTIAL

How are attributes inherited within the object type hierarchy?

Within the object type hierarchy, attribute inheritance is a true dynamic inheritance. If you assign new
attributes to an object type, all object subtypes and products linked to the object type hierarchy will
dynamically be assigned those attributes. Importantly, however, any attributes or fields that are inherited
cannot be deleted from the object type, and instead must be unassigned from the object type or
deactivated at the product level.

Review the attribute and field assignments

In the SmartPhone Product Spec, click the Attributes and Fields facet in the sidebar.

Notice the six attributes and all the fields that have been assigned to this object type.

Vlocity Enterprise Product Catalog - Page 38 EPC-3: Creating Product Object Types (30 mins)
CONFIDENTIAL

What is an object type layout?

Object type layouts are like Salesforce page layouts, and they allow you to control the layout and
organization of an object type’s attributes and fields. Using object type layouts, you can customize layouts
for each class of product, so that the attributes and fields displayed at design-time for a SmartPhone are
different than for a backpack, for example. An object type layout is made up of facets, sections, and
section elements.

As we have seen in the past few exercises, a facet displays on the left navigation menu, and it contains
sections and section elements.

A section is essentially a container for a Visualforce page, and a section can have either a standard field
layout view type or a custom view type. Vlocity provides several common custom view types, and
customers can create their own custom view types by creating custom Visualforce pages.

NOTE

For a list of custom view types provided as part of the managed package, go to Vlocity
Success Community and search for custom view uris.

Section elements are fields or attributes, and they are grouped in sections.

How are object type layouts inherited within the object type hierarchy?

Unlike the attribute and field dynamic inheritance model, object type layouts use a “hybrid” inheritance
model. When a new object subtype is created, Vlocity Product Console creates a new layout for the
object subtype via a deep copy. What this means is that any subsequent changes to the object subtype’s
layout will not be replicated down the hierarchy after initial creation. This allows you to change the layout,
adding or deleting fields for each object type, without having to worry about your layouts being altered
with the additions of any fields on the object subtype.

Review an object type layout

Click the Layout Management facet.

Notice the facets, sections, and section elements for the SmartPhone Product Spec.

Scroll down to the Attribute Properties facet.

NOTE

We have configured your training org to include two custom facets and corresponding
sections, and they are Attribute Properties and Debug. These custom facets can be
implemented in your own orgs, if desired.

Click on the Design Time Attributes Section. The section details window will display.

Notice the View Type is set to Field Layout. This is the standard field layout view type, like a
standard Salesforce page layout, and no View URI is needed.

EPC-3: Creating Product Object Types (30 mins) Vlocity Enterprise Product Catalog – Page 39
CONFIDENTIAL

Notice that this facet groups the six assigned attributes into design-time and run-time attributes,
for ease of data entry.

Scroll down to the Attributes and Fields Facet and click the Attributes and Fields Section.
The section details window will display.

Notice the View Type is set to Custom View, and the View URI specifies the corresponding
custom Visualforce page for this section.

Vlocity Enterprise Product Catalog - Page 40 EPC-3: Creating Product Object Types (30 mins)
CONFIDENTIAL

Create a new product object type

In the Console’s tab navigation bar, click the Product2 Object tab.

Click New Object Type.

In the New Object Type window on the right, enter the following information.

Field Value
Name SmartWatch Product Spec
Parent Object Type SmartPhone Product Spec
Is Active ✓
Effective From [today’s date]

EPC-3: Creating Product Object Types (30 mins) Vlocity Enterprise Product Catalog – Page 41
CONFIDENTIAL

Click Save.

NOTE

You might be wondering should smartwatches be created as a subtype of smartphones; in


other words, “IS-A” smartwatch a smartphone, following product modelling best practices? In
real life, probably not. But in our simplified training environment, yes! And we will use it to
have some fun with inheritance.

Vlocity Enterprise Product Catalog - Page 42 EPC-3: Creating Product Object Types (30 mins)
CONFIDENTIAL

Add attributes for the product object type

Click the new SmartWatch Product Spec to open the object type for editing.

Click the Attributes and Fields facet.

Notice that the fields and attributes have been inherited from the SmartPhone Product Spec.

Click Assign Attributes/Fields.

In the Assign Attributes and Fields window, click the boxes next to the Band Type and
Connectivity attributes that we created in the previous exercise.

In the Assign Attributes and Fields window, click Assign.

The two new attributes now display in the assigned attributes and fields list.

EPC-3: Creating Product Object Types (30 mins) Vlocity Enterprise Product Catalog – Page 43
CONFIDENTIAL

Set attribute metadata for the product object type

Attribute metadata can be set during assignment at the object-type level, and then products created from
the object type will inherit both the attributes and their metadata. Attribute metadata is overridable or non-
overridable depending on which attribute metadata is selected. Non-overridable metadata includes Run-
time Configurable, Is Encrypted, Is Not Assetizable, and Is Not Translatable. These attribute metadata
flags must be set at the object type level and cannot be changed at the product level. Overridable
metadata includes Has Rule, Hidden, Read Only and Required, and these can be changed at the product
level. Both are demonstrated later in this module.

Click on Band Type to open the Attribute Metadata pane on the right.

In the Attribute Metadata window under BEHAVIORS, enter the following metadata information.

Field Value Notes

Required ✓ This will require all users to select a value before they can submit the
order.

In the Attribute Metadata window, click Save.

Next, select Color and Connectivity. Check the Required BEHAVIORS for both. Click Save in
the Attribute Metadata window before moving on to the next attribute.

Vlocity Enterprise Product Catalog - Page 44 EPC-3: Creating Product Object Types (30 mins)
CONFIDENTIAL

Modify the product object type’s layout

Click the Layout Management facet.

Scroll down to the Attribute Properties facet.

In the Run Time Attributes section, click Add Section Element.

In the Add Section Element dialog on the right, enter the following information.

Field Value
Field Band Type
Display Label Band Type
Sequence 30

Click Save.

In the Run Time Attributes section, click Add Section Element.

In the Add Section Element dialog on the right, enter the following information.

Field Value
Field Connectivity
Display Label Connectivity
Sequence 40

EPC-3: Creating Product Object Types (30 mins) Vlocity Enterprise Product Catalog – Page 45
CONFIDENTIAL

Click Save.

In the Console’s tab navigation bar, click X on all the open tabs to close them. This will bring you
back to the Dashboard.

Vlocity Enterprise Product Catalog - Page 46 EPC-3: Creating Product Object Types (30 mins)
CONFIDENTIAL

Review
Confirm your understanding by answering these questions.

• What is a product object type? What purpose does it serve?


• What type of inheritance architecture do product object types use?
• What types of information can be inherited through object types?
• How are attributes and fields inherited?
• What is the difference between overridable and non-overridable attribute metadata?
• What is an object type layout? What are they comprised of?
• What is a section? What are the two view types of a section?
• How are object type layouts inherited? What implications does the inheritance model have on
product catalog change management?

EPC-3: Creating Product Object Types (30 mins) Vlocity Enterprise Product Catalog – Page 47
CONFIDENTIAL

Exercise EPC-4: Reviewing Product Life Cycles (15 mins)


Scenario

Felix is just about ready to enter the new products into the shared catalog. But he needs to
understand the concept of a product life cycle and how product selling period dates are used
in Vlocity’s EPC first.

What You Will Learn


• Define product selling periods
• Find product references
• Identify product selling period dates in Vlocity cart

Task Overview
Task 1: Review product selling periods on a product
Task 2: Use the Find References button
Task 3: Review product selling periods in the cart

What is a product life cycle?

Vlocity’s shared catalog supports the commercial product lifecycle by allowing you to define current
future, past and retired products. The stages defined below use Product Selling Period dates.

• Current Product – is a product that is currently available for sale.


• Future Product – is a product that will be sold in the future. This product can be configured and
ordered but will be fulfilled once its selling period and fulfilment begins. In order to ensure that
future products are not assetized until they are fulfilled, you must implement Future Date
Ordering.
• Past Product – is a product that is no longer for sale but still can be fulfilled for orders that have
already been placed and changed for order that have already been assetized.
• Retired Product – is a product that is no longer supported, cannot be ordered or fulfilled, or
changed for orders that have been assetized.

Vlocity Enterprise Product Catalog - Page 48 EPC-4: Reviewing Product Life Cycles (15 mins)
CONFIDENTIAL

What do product selling period dates allow?

Product Selling Period Dates allow you to set the selling period, fulfillment start date, and a date to retire
commercial products.

• Selling Start Date vlocity_cmt__SellingStartDate__c: defines when the commercial


product can be ordered and sold.
• Selling End Date vlocity_cmt__SellingEndDate__c: defines when the commercial
product can be stopped from ordering. Changes to existing assets are supported after the
end of selling and before it is retired.
• Fulfilment Start Date vlocity_cmt__FulfilmentStartDate__c: defines when the
commercial product is ready to be fulfilled. By default, this is the same as the selling start
date but can be a future date.
• End Of Life Date vlocity_cmt__EndOfLifeDate__c: the EOL date of a product is the
date on which the commercial product is no longer supported.

NOTE

The product selling period fields have a Data Type of Date/Time and are intended for
commercial products only. Technical products and promotions do not use these fields and
should use the existing effectivity and date fields. Assets do not use these fields.

You set the product selling period date fields in Vlocity Product Console in the General Properties facet of
the product.
EPC-4: Reviewing Product Life Cycles (15 mins) Vlocity Enterprise Product Catalog – Page 49
CONFIDENTIAL

Vlocity Product Console validates all dates and times entered using the below rule and will not allow you
to save products until the dates are set correctly:
SellingStartDate<=FulfilmentStartDate<=SellingEndDate<=EndOfLifeDate

IMPORTANT

Product selling period data is stored in the platform cache. After you make changes to product
selling period fields, you must update the product hierarchy data in the platform cache by
running Product Hierarchy Maintenance, Clear Managed Platform Cache, and Refresh Platform
Cache in this sequence.

Vlocity Enterprise Product Catalog - Page 50 EPC-4: Reviewing Product Life Cycles (15 mins)
CONFIDENTIAL

Review product selling periods on a product

You should be on the Dashboard of Vlocity Product Console.

Under Product Management, click the search icon next to Product.

In the Search Product… entry dialog, enter Offer and click the search icon. The list of
products is returned.

Click on the Mobile Data Plan Offer.

Notice the Selling Start/End Date, Fulfilment Start Date and End of Life Dates are not populated.
This implies that the product will be available for all of time.

Click on the Product Structure facet.

EPC-4: Reviewing Product Life Cycles (15 mins) Vlocity Enterprise Product Catalog – Page 51
CONFIDENTIAL

Click on the 4G Data Plan link and notice the Effectivity dates for the 4G Data Plan product.

Click on the Mobile Data Plan Offer tab to return to the product. Notice the selling period dates
for each product in the bundle.

NOTE

When a product is used in bundles, it is the responsibility of the product administrator to


ensure the selling periods are consistent.

Vlocity Enterprise Product Catalog - Page 52 EPC-4: Reviewing Product Life Cycles (15 mins)
CONFIDENTIAL

Use the Find References button

Product administrators use the Find References button to find references to a given product in active
promotions, product bundles, assets, quote line items, order line items and opportunity line items. The
button assists administrators in determining the effect of changing product selling period and end of life
dates.

Return to the open 4G Data Plan tab on the Dashboard. If you closed it, click on the 4G Data
Plan link from the Mobile Data Plan Offer Product Structure.

On the General Properties facet, click the Find References button at the bottom of the page.

The Partial List of Active References dialog box displays. Notice the types of reference objects.

Click the > symbol to expand the Opportunity Item References, Asset Item References and
Bundled Product References. The 4G Data Plan is an opportunity item and asset on Carole
White’s account. It’s also part of a bundled product for the Mobile Data Plan Offer.

Click Close.

NOTE

The default number of rows returned for each reference object is 20, but the limit can be
increased by setting the FindReferencesRowCountLimit custom setting in CPQ
Configuration Settings Overview. The maximum number of rows returned is 1000.
EPC-4: Reviewing Product Life Cycles (15 mins) Vlocity Enterprise Product Catalog – Page 53
CONFIDENTIAL

IMPORTANT
In order to find order, quote and opportunity line items references, each line item's fulfilment
status (vlocity_cmt__FulfilmentStatus__c) must be set to Draft, In Progress, PONR,
or Pending.

In order to find asset references, the asset's provisioning status


(vlocity_cmt__ProvisioningStatus__c) must be set to Active, Changed or Deleted.
These values are normally set by order management processes. If the statuses have null or
other values, the references will not display.

Vlocity Enterprise Product Catalog - Page 54 EPC-4: Reviewing Product Life Cycles (15 mins)
CONFIDENTIAL

Review product selling periods in the cart

In the Lightning navigation bar, click Orders.

On the Orders page, change the Recently Viewed list view to All Orders.

Select the New Mobile Plan Order.

From the Actions toolbar, click Configure Order. This invokes Vlocity Cart.

Click the > symbol to expand the Mobile Data Plan Offer in the cart.

EPC-4: Reviewing Product Life Cycles (15 mins) Vlocity Enterprise Product Catalog – Page 55
CONFIDENTIAL

Hover over the green clock icon for the 5G Data Plan product. Notice the selling period start
date.

Hover over the yellow clock icon for the 4G Data Plan product. Notice the selling period end
date.

Hover over the red clock icon for the 3G Data Plan product. Notice the end of life date.

Notice the 4G LTE Data Plan product does not have a colored clock icon, this is a current
product.

NOTE

To support MACD and asset-based ordering, the Cart can display current, future, past and
retired products based on the Order (or Quote or Opportunity) Start Date.
• Current and future products display in the cart normally, but future products are
indicated with a green clock icon.
• Past products are products that have passed their Selling End Date but have not
passed their End of Life date. They are indicated by a yellow clock icon. They cannot
be added to the cart or configured for new orders, but they can be configured or
deleted during MACD or asset-based ordering.
• Retired products are products that have passed their end of life date and they are
indicated by a red clock icon. In a new order, they cannot be added to the cart or
configured but during MACD or asset-based ordering they can be deleted.

Locate the 5G Data Plan in the Products list to the left of the cart and hover over the green
clock icon.

Vlocity Enterprise Product Catalog - Page 56 EPC-4: Reviewing Product Life Cycles (15 mins)
CONFIDENTIAL

Similar to the products added to the cart, the product list also displays current and future products
based on the Order Start Date.

IMPORTANT

Product selling period functionality does not override other standard controls for displaying
products in the Products list. In order to display, products must be marked Orderable, Active
and have a price list entry. The price list entry Effective From date must be current as well.
• Products that have reached the end of their selling period or are at their end of life
date will not display in the product list and can’t be added to the cart.
• You can add a future dated product to the cart and submit the order normally,
however Future Dated Ordering functionality must be implemented in order to
manage the fulfilment of future products.

Review
Confirm your understanding by answering these questions.

• What does it mean If a product does not have product selling period dates populated?
• If a product is used in a bundle, do the selling period dates need to match?
• When would you want to use the Find References button?
• In the products list and/or the cart, what do the green, yellow, and red clock icons indicate?

EPC-4: Reviewing Product Life Cycles (15 mins) Vlocity Enterprise Product Catalog – Page 57
CONFIDENTIAL

Exercise EPC-5: Creating Products (30 mins)


Scenario

Felix can’t wait! It’s time to enter his new products into the shared catalog. All of his careful
planning and product modeling work now pays off!

What You Will Learn


• Create product specifications
• Set and override product attribute metadata
• Assign attributes and fields to products
• Add product images
• Add a base price
• Understand product layout management

Task Overview
Task 1: Create a product specification for the Apple Watch Series 3
Task 2: Set design-time attribute metadata values for the product
Task 3: Set run-time attribute metadata values for the product
Task 4: Add a product image as an attachment
Task 5: Add a base price to the product
Task 6: Review Layout Management and Debug facets

Create a product specification for the Apple Watch Series 3

In the Lightning navigation bar, click Vlocity Product Console.

Under Product Management next to Product, click the new icon. This will launch the New
Product dialog.

Vlocity Enterprise Product Catalog - Page 58 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

NOTE

We have configured your training org to simplify the New Product dialog. This configuration
can be implemented in your organization’s orgs, if desired, by modifying the Product2 object
layout.

In the New Product dialog, enter the following information.

Field Value Notes


Object Type SmartWatch Product Spec Vlocity recommends (but does not require) that all products
be created with an object type in order to benefit from the
powerful inheritance architecture.
Name Apple Watch Series 3 This value will be visible and searchable at run-time in
Vlocity Cart.
Specification Type Product Specification Type is aligned with the four SID layers of
Offer, Product, Service and Resource. Although it is
possible to configure this picklist, Vlocity does not
recommend changing these picklist values because future
functionality will be designed to utilize them.
Product Code C-WAT-001 This value will be visible at run-time in the Product Details
window of Vlocity Cart.

Click Save, and a green Product created! message will display.

Review the facets and sections for this product’s layout that have been inherited from its object
type.

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 59
CONFIDENTIAL

In the General Properties facet, enter the following information.

Field Value Notes


Product Description Answer a call from your surfboard. This value will be visible at run-time in the
Ask Siri to send a message. Stream Product Details window of Vlocity Cart, and
your favorite songs on your run. And searchable in the Search dialog. Notice the
do it all while leaving your phone
expand icon which allows you to
behind.
increase the size of the entry dialog.
Status Active This value is not used in any current
functionality, but it will be! Vlocity
recommends setting this value in anticipation
of future functionality.
Orderable ✓ The Orderable flag must be set for a product
to be visible in Vlocity Cart’s product list.
Active ✓ The Active flag must be set for a product to
be visible in Vlocity Cart.
Selling Start Date [today’s date] This date defines when a commercial
product can be ordered and sold.
Fulfilment Start Date [today’s date] This date defines when a commercial
product is ready to be fulfilled. By default,
this is the same as the selling date, but can
be a future date to support pre-orders.

Vlocity Enterprise Product Catalog - Page 60 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

Click Save, and a green saved! message will display.

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 61
CONFIDENTIAL

Set design-time attribute metadata values for the product

Click the Attribute Properties facet.

Notice the Band Type and Connectivity attributes that we added to this facet in the last
exercise.

Under Design Time Attributes, click the Details link next to Brand to open the Attribute
Metadata window.

NOTE

Using the Attribute Metadata window, you can set overridable attribute metadata behaviors
that control whether the attribute value is active, editable or required as well as default
values. In addition, you can override the attribute data type and picklist that has been
inherited from the object type. Notice the non-overridable behaviors inherited from the
product object type that are not editable.

Vlocity Enterprise Product Catalog - Page 62 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

In the Attribute Metadata window, enter the following information.

Field Value Notes


Value Apple This will set Apple as the value for this attribute.
Read Only ✓ This will cause this attribute to be not editable.

In the Attribute Metadata window, click Save.

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 63
CONFIDENTIAL

IMPORTANT

When making changes to attribute metadata, be sure to click Save in the Attribute Metadata
window and not the Attribute Properties facet. Otherwise, your metadata changes will not
save!

Notice that the Brand attribute value is now set to Apple.

Under Design Time Attributes, click the Details link next to Size to open the Attribute
Metadata window.

Notice that this is a Text attribute with no picklist defined.

Vlocity Enterprise Product Catalog - Page 64 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

In the Attribute Metadata window, enter the following information.

Field Value
Value 38mm
Read Only ✓

In the Attribute Metadata window, click Save.

Using the steps above, enter the following metadata information for the Capacity attribute.

Field Value
Value 8 GB
Read Only ✓

Enter the following metadata information for the Mobile OS attribute.

Field Value
Value watchOS 4
Read Only ✓

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 65
CONFIDENTIAL

For our next trick, we will override an attribute picklist that has been inherited from the object type.

Vlocity Enterprise Product Catalog - Page 66 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

Set run-time attribute metadata values for the product

Under Run Time Attributes, click the Details link next to Color to open the Attribute Metadata
window.

In the Attribute Metadata window under DATA INFO, click the delete icon next to the
Colors picklist.

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 67
CONFIDENTIAL

Using the Picklist Lookup dialog, select the Band Color picklist we made earlier.

In the Attribute Metadata window, click Save.

Vlocity Enterprise Product Catalog - Page 68 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

Hover over the Color attribute and notice how the cursor turns to a no-go icon. This indicates that
the attribute is not available for editing during design-time because it is run-time configurable
only. It also has a red asterisk next to it indicating that it is required. These metadata attributes
were assigned at the product object type in the previous exercise.

Using the steps you’ve learned, enter the following metadata information for the Payment Type
attribute. Click Save.

Field Value
Value Pay in Full
Read Only ✓

Click the Attributes and Fields facet.

Click the Assign Attributes/Fields button.

Notice the list of attributes (and fields) that can be assigned directly to the product.

IMPORTANT

When you assign attributes and fields directly to a product, you “break” the dynamic attribute
inheritance from the object type, and all subsequent attribute assignment changes must
continue to be directly managed at the product level.

Click the X to close the Assign Attributes and Fields window on the right without saving.

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 69
CONFIDENTIAL

Add a product image as an attachment

Click the Attachments facet.

Click New Attachment.

In the Attachment General Properties window, enter the following information.

Field Value Notes


Name Apple Watch Series 3 Image 1 This value is only visible at design-time in the
Attachments facet of the Console.
Description Image of two watches This value is only visible at design-time in the
Attachments facet of the Console.
Content Type Image
Url https://vlocity.com/cms/resou
rces/applewatch-1.png
Default Image ✓ If the default flag is checked, the image will display as
the default image in the Product Details window in
Vlocity Cart.
Sequence 10 The sequence value is used to order multiple images in
the Gallery in the Product Details window in Vlocity Cart.

NOTE

Vlocity does not have the capability to upload files, therefore it only supports product images
via an absolute URL.

In the General Properties window, click Save.

Vlocity Enterprise Product Catalog - Page 70 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

In the attachment list, click the view icon to display the new attachment.

Click OK to close the image viewer.

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 71
CONFIDENTIAL

Add a base price to the product

NOTE

In this task, we will add a simple base price to our new product, so that the product will
display in Vlocity Cart. For more information on Vlocity pricing, please see Vlocity Success
Community or the Vlocity Pricing training module.

Click the Pricing facet.

Click New.

In the PRICE LIST ENTRY General Properties dialog, enter the following information.

Field Value
Price List B2C Price List
Display Text $349.99
Base Price ✓

In the PRICE LIST ENTRY Pricing Variable dialog, enter the following information.

Field Value
Charge Type One-time
Sub-Type Standard

In the PRICE LIST ENTRY Pricing Variable dialog, click Search.

In the PRICE LIST ENTRY Pricing Variable dialog, click One Time Std Price.

In the PRICE LIST ENTRY Pricing Element dialog, click $349.99 OT.

In the PRICE LIST ENTRY Effectivity dialog, enter the following information.

Field Value
Effective From [today’s date]
Active ✓

Click Save.

Vlocity Enterprise Product Catalog - Page 72 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 73
CONFIDENTIAL

In the left sidebar, click the Context Rules facet. This is where you can create context rule sets
for a product.

NOTE

For more information on context rules, please see Vlocity Success Community or the Vlocity
Context Rules training module.

Vlocity Enterprise Product Catalog - Page 74 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

Review Layout Management and Debug facets

Click the Layout Management facet.

Notice the Create Custom Layout button.

IMPORTANT

When you click the Create Custom Layout button, Vlocity Product Console will perform a
“deep copy” of the object type layout and then “break” the link to the object type’s layout. All
subsequent layout changes must be directly managed at the product level.

Click the Debug facet.

Notice the JSONAttribute field. This is the field on the product object that stores the attribute
metadata.

Click the Reload icon in the upper right corner to refresh the page and product data.

Click the Debug facet.

EPC-5: Creating Products (30 mins) Vlocity Enterprise Product Catalog – Page 75
CONFIDENTIAL

Notice that the JSONAttribute field now displays the attribute metadata that we created earlier in
this exercise.

IMPORTANT

Do not directly edit the JSONAttribute field, no matter how much you love writing in JSON
notation! This data is intended for debugging purposes only.

Review
Confirm your understanding by answering these questions.

• What two product fields are searchable using the Search dialog in Vlocity Cart?
• What is the Specification Type field?
• What are the three things required in order for a product to display in Vlocity Cart?
• What is attribute metadata? What can it control?
• Can you override attribute properties inherited from an object type? How?
• What happens when you assign attributes directly to a product that has an object type?
• What happens when you click the Create Custom Layout button?

Vlocity Enterprise Product Catalog - Page 76 EPC-5: Creating Products (30 mins)
CONFIDENTIAL

Exercise EPC-6: Creating Product Bundles (15 mins)


Scenario

Felix has just learned from the marketing department that they’ve introduced a whole slew of
product bundles, and the first one they want includes the new Apple Watch Series 3 product.
Of course, they did it yesterday, and are wondering when he’ll have the new bundles
available to their sales and service teams—with a not-so-subtle hint that there’s no time like
the present. Felix is excited to release his new smartwatch product specification into the wild,
so he creates a product bundle for it.

What You Will Learn


• Create product bundles
• Understand product cardinality
• Override the cardinality of child product bundles

Task Overview
Task 1: Create a product bundle
Task 2: Create the structure of the product bundle
Task 3: Override the cardinality of the child product bundle
Task 4: Create a price list entry for the product bundle

What is a product bundle?

A product bundle is a set of products sold together. Products are bundled using a “Has-A” Containment
relationship as either a child or a realization. A product can have one or more product child items (or
PCIs), and you can define cardinalities for each. PCIs can be a single product or a product bundle, which
allows you to create product bundles within product bundles.

What is a product cardinality?

Product cardinality defines the default, minimum and maximum quantities of the product that are allowed
in the product bundle. You can also override the cardinalities of product bundles when they are included
within another product bundle.

EPC-6: Creating Product Bundles (15 mins) Vlocity Enterprise Product Catalog – Page 77
CONFIDENTIAL

Create a product bundle

In the Console’s tab navigation bar, click Dashboard.

Under Product Management next to Product, click the new icon. This will launch the New
Product dialog.

In the New Product dialog, enter the following information. We will create this product bundle as
an offer.

Field Value
Object Type BASE Offer Spec Type
Name Get Smart iPhone + Watch Bundle Offer
Specification Type Offer

Click Save.

In the General Properties facet, enter the following information.

Field Value
Product Code C-OFF-004
Product Description Get smart with the best phone and watch bundle
ever created!
Status Active
Orderable ✓
Active ✓
Selling Start Date [today’s date]
Fulfilment Start Date [today’s date]

Click Save, and a green saved! success message will display.

Vlocity Enterprise Product Catalog - Page 78 EPC-6: Creating Product Bundles (15 mins)
CONFIDENTIAL

Create the structure of the product bundle

Click the Product Structure facet.

Click the Add icon to add a product child item (PCI) to the product bundle.

In the product child item window on the right, enter the following GENERAL PROPERTIES
information.

Field Value Notes


Child Product Apple iPhone X Use the lookup dialog to select the child product.
Relationship Type Child Realization relationships are reserved for future functionality.
Sequence 10 This value determines the order the child products will display in
the bundle. Use a sequence such as 10, 20, 30 to ensure
additions can be easily inserted.

In the product child item window on the right, enter the following CARDINALITY information.

Field Value Notes


Min Quantity 1 This value determines the minimum quantity required for a valid
order.
Default Quantity 1 This value determines the default number of child products that
will be included in the bundle when it is added to the cart.
Max Quantity 2 This value determines the maximum quantity required for a valid
order.

EPC-6: Creating Product Bundles (15 mins) Vlocity Enterprise Product Catalog – Page 79
CONFIDENTIAL

NOTE

The Virtual Item flag, when checked, makes the product item not assetizable. This is
customarily used as a grouping mechanism, and to set cardinality for the parent product
nodes.

The Collapse Hierarchy flag, when checked, enables a Search Item dialog in the cart’s line
items pane, allowing users to search items within the bundle and then add additional
products to the bundle. This is intended for use with very large product bundles.

Click Save.

NOTE

Product Child Items can be added to any product in the bundle, not just the current parent
product.

Click the Add icon next to the Get Smart iPhone + Watch Bundle Offer.

Vlocity Enterprise Product Catalog - Page 80 EPC-6: Creating Product Bundles (15 mins)
CONFIDENTIAL

Using the steps learned above, add the following child products to the bundle with the
cardinalities defined below.

Relationship Collapse
Product Type Sequence Min Default Max Hierarchy

Apple Watch Series 3 Child 20 1 1 2


NumberSync Child 30 0 0 1
Individual Simple Choice Child 40 1 1 1 ✓
Plan

EPC-6: Creating Product Bundles (15 mins) Vlocity Enterprise Product Catalog – Page 81
CONFIDENTIAL

Override the cardinality of the child product bundle

In the product structure window, expand the Individual Simple Choice Plan product bundle by
clicking the toggle arrow > to its left. Click in the white space of the line for the 4G LTE Data
Plan. Do NOT click the product name link because that will navigate you to the product record.

The product child item window will display on the right. Notice the existing CARDINALITY
settings that were set when the 4G LTE Data Plan product was added to the Individual Simple
Choice Plan product bundle.

Click Override Mode.

Click Create Override.

NOTE

Cardinality overrides must be equal or greater than the minimum and maximum limits set by
the original cardinality. For example, if the minimum original quantity is 2, you cannot create a
minimum override quantity of 1; the override must be greater than or equal to 2.

Vlocity Enterprise Product Catalog - Page 82 EPC-6: Creating Product Bundles (15 mins)
CONFIDENTIAL

In the Override Value column, change the following values.

Product Min Max


4G LTE Data Plan 1 2

This override will change the minimum quantity to 1 and the maximum quantity to 2 only when it is
bundled in the Get Smart iPhone + Watch Bundle Offer.

Click Save.

Click in the white space of the line for the Mobile Hotspot. Do NOT click the product name link
because that will navigate you to the product record.

Click Override Mode.

EPC-6: Creating Product Bundles (15 mins) Vlocity Enterprise Product Catalog – Page 83
CONFIDENTIAL

Click Exclude Item.

This override will exclude the Mobile Hotspot product from the Individual Simple Choice Plan bundle only
when it is bundled in the Get Smart iPhone + Watch Bundle Offer.

In the upper right corner, click the refresh icon.

In the left sidebar, click the Product Structure facet.

In the product structure window, expand the Individual Simple Choice Plan product bundle.

Vlocity Enterprise Product Catalog - Page 84 EPC-6: Creating Product Bundles (15 mins)
CONFIDENTIAL

Notice the cardinality override notations.

EPC-6: Creating Product Bundles (15 mins) Vlocity Enterprise Product Catalog – Page 85
CONFIDENTIAL

Create a price list entry for the product bundle

NOTE

In this task, we will add a price list entry for $0 to our new product bundle, so that it will roll up
prices for the child products when it’s displayed in Vlocity Cart. For more information on how
to price product bundles and Vlocity pricing topics in general, please see Vlocity Success
Community or the Vlocity Pricing training module.

Click the Pricing facet.

Click New.

In the PRICE LIST ENTRY General Properties dialog, enter the following information.

Field Value
Price List B2C Price List
Display Text Bundle pricing
Base Price ✓

In the PRICE LIST ENTRY Pricing Variable dialog, enter the following information.

Field Value
Charge Type One-time
Sub-Type Standard

In the PRICE LIST ENTRY Pricing Variable dialog, click Search.

In the PRICE LIST ENTRY Pricing Variable dialog, click One Time Std Price.

In the PRICE LIST ENTRY Pricing Element dialog, click FREE.

In the PRICE LIST ENTRY Effectivity dialog, enter the following information.

Field Value
Effective From [today’s date]
Active ✓

Vlocity Enterprise Product Catalog - Page 86 EPC-6: Creating Product Bundles (15 mins)
CONFIDENTIAL

Click Save.

Review
Confirm your understanding by answering these questions.

• What is product cardinality?


• What is the correct term for a child product?
• What is a virtual item? How is it typically used?
• How can you remove a child product from a bundle that is added to another product bundle?
• How can you override the cardinality of a child product of bundle within another product bundle?

EPC-6: Creating Product Bundles (15 mins) Vlocity Enterprise Product Catalog – Page 87
CONFIDENTIAL

Exercise EPC-7: Managing the Shared Catalog (20 mins)


Scenario

Felix has been busy creating picklists, product attributes, object types, and products and
product bundles. But Felix is quickly realizing he needs to understand the housekeeping tasks
of managing the shared catalog to keep everything running smoothly and quickly!

What You Will Learn


• Explain what the CME batch jobs do, when to run them and why
• Explain how the platform cache is used and when you need to refresh it
• Explain why and when you need to calibrate product attributes

Task Overview
Task 1: Refresh the product hierarchy cache
Task 2: Confirm that batch jobs completed successfully

What does it mean to manage the shared catalog?

Enterprise product catalogs always require administration and management. In the case of Vlocity EPC’s
shared catalog, there are several tasks that must be completed when you are creating or updating
elements in the catalog. These tasks are designed to ensure top performance and faster speeds at run-
time.

Vlocity has created several administrative jobs to help you complete these tasks. The jobs primarily do
three things:

Transform catalog entities into flattened or streamlined records that are easier and faster to
read and load.

Cache catalog data into memory rather than having to request data from the database.

Regenerate metadata that is critical for CPQ operations.

Vlocity Enterprise Product Catalog - Page 88 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

When changes are made to the shared catalog, catalog administrators need to determine when to run
each job. Some jobs can be run without affecting live production environments, but others must be run
during downtimes or low usage.

In this lesson, you will learn about the most common administrative jobs used in managing the shared
catalog and when you should use them.

Understanding Caching in Vlocity Communications

Caching of data is primarily a performance optimization technique for situations where the same data will
be required across multiple transactions. Rather than recalculating or re-retrieving the information, data
can be stored in an easy to access place and reused in later transactions.

Vlocity CPQ primarily caches data in a Salesforce platform cache called the “CPQPartition.” The
CPQPartition is created when Vlocity is installed, but you will need to enable it and ensure that it has
enough space allocated. You can allocate a minimum of 10 MB for the platform cache or a maximum of
whatever your Salesforce platform cache limit is.

ADDITIONAL RESOURCES

For more information on Salesforce platform caches, please see the following Salesforce
Trailhead:

https://trailhead.salesforce.com/modules/platform_cache/units/platform_cache_get_started

The CPQPartition, just like all platform caches, is made up of a session cache and an org cache.

Session cache, as the name implies, is cache space for an individual user session. The session cache
stores a small amount of session data (less than 1KB per user) used by context rules. The session cache
improves application performance during complex processing or when accessing large data structures
throughout a user’s interaction. For example, when a user is searching for products in the Products list of
Vlocity Cart, as the user clicks on the different results and interacts with the records, multiple transactions
are happening on the server side with each click. You don’t want to perform the initial queries and
calculations to repopulate the list for every transaction, instead you want to cache the results.

Besides caching within each user session, you also need to cache items for use by any user across the
application. In the CPQPartition, the org cache performs this function by storing product hierarchy
properties (JSON key-value pairs), rules, and line item properties for your entire organization. For
example, when a user creates a product bundle containing child products, the org caches the product
hierarchy. So, when any user adds the product bundle to Vlocity Cart, Vlocity Cart actually retrieves the
product hierarchy data from cache.

In addition to the CPQPartition platform cache, there are other caches used in Vlocity Communications,
Media & Energy such as the Digital Commerce API Caching. To learn more about the Vlocity Digital
Commerce solution, search for “digital commerce” on Vlocity University at https://success.vlocity.com.

The graphic provides a visual of CPQ operations and when those transaction are reflected in the session
and org caches.

EPC-7: Managing the Shared Catalog (20 mins) Vlocity Enterprise Product Catalog – Page 89
CONFIDENTIAL

Managing the Platform Cache

When you need to initialize or refresh the platform cache, you use a three-step process.

1. Run the Product Hierarchy Maintenance job.

2. Run the Clear Managed Platform Cache job.

3. Run the Refresh Platform Cache job.

The Product Hierarchy Maintenance job builds a streamlined version of the product hierarchies in the
data store sObject. Separately but related, Refresh Platform Cache invokes an Apex job that uses the
product hierarchy data from the data store to build a cached version of the product hierarchy using key-
value pairs.

Ok, so what does all that mean? Let’s take a look at when you would run these jobs. Any time you make
changes to product bundles (i.e., product cardinality), you must rebuild the product hierarchy data store
and cache, which means you must run the Product Hierarchy Maintenance job, followed by the Clear
Managed Platform Cache job and the Refresh Platform Cache job. Otherwise, you will not see your
cardinality changes applied at run-time in Vlocity Cart.

Vlocity Enterprise Product Catalog - Page 90 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

NOTE

These jobs should not be run while orders are being created. Invalid orders and possible run-
time errors may result.

Do you remember running these jobs when you started your training? You should have followed the
Quick Setup steps when setting up your org, which includes all of these jobs.

You probably noticed the Clear Managed Platform Cache job that sits between the Product Hierarchy
Maintenance and Refresh Platform Cache. The Clear Managed Platform Cache job deletes all data in the
org and session caches in the platform cache. This creates a “fresh slate” for the Refresh Platform Cache
job to deliver its revised product hierarchy data to the org cache. Context rules data will be repopulated
when the rules are invoked at run-time.

EPC-7: Managing the Shared Catalog (20 mins) Vlocity Enterprise Product Catalog – Page 91
CONFIDENTIAL

When making changes to a rule, it’s not necessary to run the Product Hierarchy Maintenance job. Why?
Simple, you don’t need to rebuild the product hierarchy data store.

NOTE

When you run the Clear Managed Platform Cache job, all product hierarchy and rules data
will be deleted from both the session and org caches, which may affect run-time
performance, so Vlocity recommends that these jobs be run during times of low usage or
system downtime.

What other jobs should be run?

Another job that is frequently used to manage the shared catalog is EPCProductAttribJSONBatchJob,
which is used to calibrate product attributes. You may also recall from the Quick Setup steps that you
were asked to calibrate product attributes as part of the setup of your new training org. What you may not
understand is why you were asked to do so.

Your training org is a copy of Vlocity University’s master TSO (Trial Source Org), and it contains products
and product attributes that have been seeded in support of the lab exercises. Each product’s attributes
are stored in JSON format in a field called JSONAttribute. The JSONAttribute field contains attribute
record ids, which allow faster direct access for system processes.

However, when we create new orgs from our master TSO, the Salesforce copy process is unable to
detect those record ids embedded in the JSONAttribute field, and so they remain coded as the original
attribute record ids from the TSO. Left as it, this will create errors in other attribute processes.

Vlocity Enterprise Product Catalog - Page 92 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

You can see a sample JSONAttribute field in the screenshot below with the record ids highlighted in
yellow.

Vlocity developed an Apex batch job called EPCProductAttribJSONBatchJob to reprocess these product
attributes and save the JSONAttribute field with your new org’s attribute record ids. We saw this batch job
in action when you clicked the Process Attributes button from the Vlocity Attributes tab within the CME
Admin app.

NOTE

For convenience, we built the Process Attributes button in your training org to invoke the
batch job, otherwise, you would run this job from the Developer Console.

EPC-7: Managing the Shared Catalog (20 mins) Vlocity Enterprise Product Catalog – Page 93
CONFIDENTIAL

IMPORTANT

Never edit your product attributes through this interface. You manage them through Vlocity
Product Console, as we saw earlier in this module.

NOTE

If your org contains migrated product attribute overrides from promotions, you must also run
EPCFixCompiledAttributeOverrideBatchJob to correct the attribute record ids. This training
org does not contain attribute overrides, so we do not need to run it. For more information on
this batch job, go to Vlocity Success Community and search for
EPCFixCompiledAttributeOverrideBatchJob.

Let’s take this concept outside of a controlled training scenario and put this concept to work in the real
world. Any time you spin an org or import data that contains product attributes, such as creating a
sandbox environment, you must correct the product attribute record ids.

Do all these words have your head spinning and seem like mumbo jumbo? The graphic below provide a
visual representation of when to run this Apex job and the update that occurs in the JSONAttribute field.

Vlocity Enterprise Product Catalog - Page 94 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

NOTE

This job also can be helpful when troubleshooting product attribute issues. For example, an
updated attribute or value that is not displaying at run-time. Run this job to reprocess the
product attributes saved to the JSONAttribute field. Once the job completes, the updated
attribute or value will display in the JSONAttribute field and at run-time.

Refresh the product hierarchy cache

Now that Felix has an understanding of how to manage the shared catalog, he needs to put what he’s
learned into action. In the previous exercise Felix created a product bundle and made a change to the
cardinality of that bundle. So, the product hierarchy data in the platform cache must be updated, or the
new product bundle will not display properly in Vlocity Cart.

Build the product hierarchy data store by running the Product Hierarchy Maintenance job.

a. In the Lightning navigation bar, click More, and then click Vlocity CMT Administration.
b. Under Admin Console, click Maintenance Jobs.

c. On the Maintenance Jobs page, find the PRODUCT HIERARCHY MAINTENANCE job and
click Start.
d. Click OK to accept the notification that the job may affect your org settings and items.
e. Messages display indicating that the job completed successfully.

NOTE

Salesforce will also email a successful job completion report to the email address registered
for your training org.

EPC-7: Managing the Shared Catalog (20 mins) Vlocity Enterprise Product Catalog – Page 95
CONFIDENTIAL

Clear the platform cache.

a. On the Maintenance Jobs page, find the CLEAR MANAGED PLATFORM CACHE job, and
click Start.
b. Click OK to accept the notification that the job may affect your org settings and items.
c. Message displays that the job completed successfully.

Vlocity Enterprise Product Catalog - Page 96 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

Populate the platform cache.

a. On the Maintenance Jobs page, find the REFRESH PLATFORM CACHE job, and click Start.
b. Click OK to accept the notification that the job may affect your org settings and items.
c. Messages display indicating that the job completed successfully.

EPC-7: Managing the Shared Catalog (20 mins) Vlocity Enterprise Product Catalog – Page 97
CONFIDENTIAL

Confirm that batch jobs completed successfully

Open Setup in a new browser tab.

In the Quick Find box, type Apex Jobs.

In Environments under Jobs, click Apex Jobs.

In the list of Apex jobs, notice the listings for the following batch jobs. You can see the most
recent listings by looking at the Submitted Date, which shows you the jobs that were run. Ensure
that the job status shows no errors. The rest of the listings were copied from the master training
org.

Batch Job Purpose


ResolveProductHierarchyBatchJob Copies product data to the data store sObject. Is invoked using the CMT
Administration Product Hierarchy Maintenance job and should be run before
Refresh Platform Cache job.
ProductHierarchyBatchProcessor Copies the data store sObject and builds the product hierarchy and product
selling data in the platform org cache. Is invoked using the Refresh Platform
Cache job and should be run after Product Hierarchy Maintenance job.
ProductAttributesBatchProcessor Copies the filterable product attributes to the Cached Filterable Attribute
sObject used by Vlocity Cart. Is invoked using the Refresh Platform Cache
job.
EPCProductAttribJSONBatchJob Regenerates product attribute fields for data that has been migrated from
other orgs.

Vlocity Enterprise Product Catalog - Page 98 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

IMPORTANT

If the ProductAttributesBatchProcessor displays an


INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY error, you have not run the
EPCProductAttribJSONBatchJob successfully. Go back and rerun this job.

Lightning navigation bar--> Vlocity Attributes-->List View All-->Process Attributes --> Start
Processing

In the Quick Find box, type Platform Cache.

Under Custom Code, click Platform Cache.

Click Recalculate.

EPC-7: Managing the Shared Catalog (20 mins) Vlocity Enterprise Product Catalog – Page 99
CONFIDENTIAL

In the Platform Cache Partition page, under Name, click CPQPartition.

Notice that your org cache is now populated.

Vlocity Enterprise Product Catalog - Page 100 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

IMPORTANT

The Clear Cache button shown in this screen will delete the contents of the CPQPartition
cache. There is also a CLEAR MANAGED PLATFORM CACHE button accessible from the
CMT Administration Maintenance Jobs screen that performs the same function. However,
neither of these buttons rebuilds the cache. The cache should never be cleared while orders
are being created.

EPC-7: Managing the Shared Catalog (20 mins) Vlocity Enterprise Product Catalog – Page 101
CONFIDENTIAL

Review
Confirm your understanding by answering these questions.

• What is the name of the platform cache required by Vlocity CME? What is it comprised of? What
are their purposes?
• What must you do if you make changes to your product hierarchies (i.e., change product
cardinalities)?
• What is the purpose of the EPCProductAttribJSONBatchJob? When should it be run?
• What job should you run if you need to troubleshoot changes to a product’s attributes?
• How can you check to make sure your batch jobs have run successfully?

Vlocity Enterprise Product Catalog - Page 102 EPC-7: Managing the Shared Catalog (20 mins)
CONFIDENTIAL

Exercise EPC-8: Review the New Products in Vlocity Cart (15


mins)
Scenario

Felix has a new swagger in his step. With his new product specification and product bundle
added to the product catalog, he’s ready to check them out in the bright lights of Vlocity Cart.

What You Will Learn


• Understand how product bundles display in Vlocity Cart
• Understand how product cardinalities are used in Vlocity Cart

Task Overview
Task 1: Review the new product and product bundle in Vlocity Cart’s product list
Task 2: Add the product bundle to the cart and test the cardinalities

Review the new product and product bundle in Vlocity Cart’s product
list

In the Lightning navigation bar, click Orders.

Click New.

Enter the following information.

Field Value
Order Name New Product Test Order
Account Name White, Carole
Order Start Date [today’s date]
Price List B2C Price List

Click Save.

From the Actions toolbar, click Configure Order. This invokes Vlocity Cart.

In the search dialog, enter apple watch.

EPC-8: Review the New Products in Vlocity Cart (15 mins) Vlocity Enterprise Product Catalog – Page 103
CONFIDENTIAL

In the product list pane, find the Apple Watch Series 3 product, and click More to invoke the
Product Details modal window.

Review the product image.

Click Close.

Vlocity Enterprise Product Catalog - Page 104 EPC-8: Review the New Products in Vlocity Cart (15 mins)
CONFIDENTIAL

Add the product bundle to the cart and test the cardinalities

In the search dialog, enter get smart.

In the product list pane, find the Get Smart iPhone + Watch Bundle Offer product, and click
Add to Cart.

Click the red Messages notification.

Click any of the Take Me There “eye” icons on the right side of the Messages.

In the Line Item Details modal window, click the Color attribute for the Apple iPhone X.

Notice the two iPhone X colors from the standard color picklist. Select one.

In the Line Item Details modal window, click the Color attribute for the Apple Watch Series 3.

EPC-8: Review the New Products in Vlocity Cart (15 mins) Vlocity Enterprise Product Catalog – Page 105
CONFIDENTIAL

Notice the standard color picklist has been overridden by the Band Color picklist. Select one.

Scroll down and set the Wearables Band Type and Connectivity to any values.

Scroll down and set the Mobile Plans – Data Plans attribute to Unlimited.

Notice the design-time attributes that are read-only.

Click Close.

Back in the cart, notice the Recurring Total and One Time Total prices for the Get Smart
iPhone + Watch Bundle Offer. Pricing from the product child items has been rolled up into these
totals, while the Recurring Charge and One Time Charge prices for the parent product remain $0.

Vlocity Enterprise Product Catalog - Page 106 EPC-8: Review the New Products in Vlocity Cart (15 mins)
CONFIDENTIAL

In the Apple iPhone X line item, click into the Quantity field and type 0. Notice the error
message resulting from the minimum quantity set in the product cardinality.

Set the quantity for the Apple iPhone X to 5. Notice the error message resulting from the
maximum quantity set in the product cardinality.

Set the quantity for the Apple iPhone X to 2.

Notice the Add to Cart button for the NumberSync line item. This is because the default quantity
set for this product child item was 0.

EPC-8: Review the New Products in Vlocity Cart (15 mins) Vlocity Enterprise Product Catalog – Page 107
CONFIDENTIAL

Under the Individual Simple Choice Plan product bundle, notice the Search Item dialog. This
dialog was included because the Collapse Hierarchy flag was checked. Notice also that the
Mobile Hotspot product was excluded from the bundle.

Click in the Search Item dialog, and type Netflix. Notice that you can search for products
within the product bundle, which is helpful for very large and complex product bundles.

Review
Confirm your understanding by answering these questions.

• What is the name of the platform cache required by Vlocity CME? What is it comprised of? What
are their purposes?
• What must you do if you make changes to your product hierarchies (i.e., change product
cardinalities)?
• What is the purpose of the EPCProductAttribJSONBatchJob? When should it be run?
• What job should you run if you need to troubleshoot changes to a product’s attributes?
• How can you check to make sure your batch jobs have run successfully?

Vlocity Enterprise Product Catalog - Page 108 EPC-8: Review the New Products in Vlocity Cart (15 mins)
CONFIDENTIAL

Exercise EPC-9: Create Tablet Products


Scenario

RoadRunner has been so focused on introducing new products for mobile devices and
data plans they realized they are missing out on the tablet market. In an effort to
increase revenue and attract additional customers, marketing reached out to Felix,
once again, to create the products to address the need for tablets and their
accessories in Vlocity EPC based on the requirements below.

Task Overview
Task 1: Review product requirements
Task 2: Build products in Vlocity EPC
Task 3: Test new products in Vlocity Cart

EPC-9: Create Tablet Products Vlocity Enterprise Product Catalog – Page 109
CONFIDENTIAL

Review product requirements

Marketing Requirements - Tablet


Product Apple iPad Pro 12.9”
Product Code C-TAB-001
Object Type Tablet Product Spec
Product Description It’s all new, all screen, and all powerful. Completely redesigned and packed with
our most advanced technology, it will make you rethink what iPad is capable of.
Effectivity Sellable and fulfillable immediately
Product Capacities 64GB
256GB
512GB
1TB
Product Colors Silver
Space Gray
Product Connectivity Wifi
Wifi + Cellular
Product Pricing $1149
Configurable at design Apple = Brand
Behavior Read-only
Configurable in the cart Color
and required Capacity
Connectivity

NOTE

For this challenge, assume pricing is the same for all capacities, connectivity and price lists.
Want to challenge your pricing skills further? Refer to the support topic: Attribute-Based
Pricing in documentation.

Marketing Requirements – Styluses


Product Apple Pencil
Product Code C-ACC-001
Object Type Accessory Product Spec
Accessory Type Styluses
Product Description The Apple Pencil delivers pixel-perfect precision and industry-leading low
latency, making it great for drawing, sketching, coloring, taking notes,
marking up email, and more.
Effectivity Sellable and fulfillable immediately

Vlocity Enterprise Product Catalog - Page 110 EPC-9: Create Tablet Products
CONFIDENTIAL

Product Pricing $129


Behavior at design Read-only

Marketing Requirements – Bundle


Product Work Smart iPad Pro Bundle Offer
Product Code C-OFF-030
Product Description Work smarter with the Apple iPad Pro bundle.
Effectivity Selling period begins 1 month from today
Product Pricing Rolled up pricing

Minimum Default Maximum


Bundle Products Orderable Orderable Orderable
Apple iPad Pro 12.9” 1 1 1
Apple Pencil 1 1 2
4G LTE Data Plan 0 0 1

Build products in Vlocity EPC

EPC-9: Create Tablet Products Vlocity Enterprise Product Catalog – Page 111
CONFIDENTIAL

Test new products in Vlocity Cart

TIPS AND TRICKS


?
• Is the product active?
• Did you create and assign correct attributes to the product?
• Assign appropriate attribute metadata?
• Was the correct object type selected?
• Is the cardinality correct?

Vlocity Enterprise Product Catalog - Page 112 EPC-9: Create Tablet Products
CONFIDENTIAL

Vlocity Enterprise Product Catalog – Page 113

You might also like