Add an Attribute on an Existing Product in Multiplay Subscription Management (Managed Package)

Consider a scenario where you want to use most of the existing product model as it is, but you need to add an attribute on one of the existing products. For example, let's say you want to add an attribute to the mobile services used in the Manage Features workflow.

This feature is part of the Communications Cloud managed package.

Here's how you can add an attribute:

Note

In this example, we consider modifying a product used in the Manage Features workflow. The process to modify products used in other workflows is similar. However, in other workflows, after adding the new attribute you might have to update the workflow components to display and use the new attribute.

1. Create the required product attribute.
   1. Go to the App Launcher. Under All Items, click Vlocity Product Console.
   2. Under Foundation, go to Attribute and click the add icon to create an attribute.
   3. Enter the required details of the attribute. For this example, select the attribute category ATC_FEATURES and the value type Checkbox. Ensure Active is selected. When you are done setting up the new attribute, click Save.
2. Add the new attribute to the product.
   1. Go to the Vlocity Product Console Dashboard.
   2. Under Product Management, go to Product and click the search icon.
   3. Enter a search string or just click the search icon again to display all products.
   4. Go to the product that you want to update and click the edit icon. In this example, update the Mobile Services product.
   5. Click the Attributes and Fields subtab.
   6. Click Assign Attributes/Fields.
   7. From the list of attributes displayed in the Assign Attributes and Fields section, select the attribute that you want to assign and then click Assign.
   8. Run the EPCProductAttribJSONBatchJob
3. Run the cacheable API jobs to update the cache with the updated product attributes.
   1. In the App Launcher, go to All Items and click Vlocity CMT Administration.
   2. Under Admin Console, click Cacheable API Jobs.
   3. Go to LOAD API METADATA and click Start.
   4. Next, update the API metadata to add required parameters in the GetOffers record.
   5. In the App Launcher, go to All Items and click Vlocity API Metadata.
   6. Go to the GetOffers API and click the metadata name. If you don't see the GetOffers API, check that the view is set to All.
   7. On the Details tab, go to API Params and click the edit icon.
   8. Replace the existing parameters with {"productFields":["Family", "vlocity_cmt__Type__c", "vlocity_cmt__SubType__c"]} and click Save.
   9. Switch back to Vlocity CMT Administration subtab. Go to DELETE EXPIRED API CACHE and click Start.
   10. When the Delete Expired API Cache job completes, run the POPULATE API CACHE job.
   11. Select all and click OK.
4. Create the custom metadata records.
   1. In Quick Find, enter Custom Metadata and click Custom Metadata Types.
   2. Go to VPL Abstraction Layer Setup and click Manage Records.
   3. You can create a new custom metadata record or clone an existing record that is similar to the one that you want to create. For this example, click VPL_MF_ROAMING_CR and then click Clone.
   4. Update the new custom metadata record fields with the details of the attribute that you just created.
   5. Specify a value in the Label and the VPLAbstrationLayerSetup Name fields.
   6. Enter the attribute code of the new attribute in the Target field.
   7. Ensure that the IntegrationKey value is unique.
   8. Verify that the other values are accurate. In this example, the target entity won't change. However, if you updated a different product, ensure that the Target Entity field has the product code of the updated product. Ensure that the flow name reflects the workflow you expect to use this attribute in. In this example, the flow name should be Manage Features.
   9. When you're done creating the custom metadata record for the new attribute, click Save.
5. The updated product with the new attribute won't be available for existing subscriptions or assets. To test that the new attribute is available for new subscriptions and assets, add a new subscriber and then run the Manage Features workflow. See Add New Subscribers Using Guided Selling in Multiplay Subscription Management (Managed Package) and Manage Features as an Agent in Multiplay Subscription Management (Managed Package).
   

   Note

   The Manage Features workflow is designed to display all the attributes of the Mobile Services in the UI. So when you add an attribute to the Mobile Services product, it is automatically picked up by the Manage Features workflow. However, if you add an attribute to a product used by the Shop workflow, the Request SIM Replacement workflow, or other workflows, you must also update the workflow components to display and update the new attributes as per your requirements.