Loading
Salesforce Enforces New Security Requirements in Summer 2026Read More
Get Started with Communications, Media, and Energy & Utilities (CME)...
Export a Product Version Report

Export a Product Version Report

You can create a PDF report that lists all the related objects for a specific version of a product specification or offer. The newer version clones or inherits these related objects. Use this report to review and approve changes for new versions.

Before You Begin

Verify that the UPC/Extract Integration Procedures are installed. If not, run the Install Datapack for Product Report job.

The report is available only for products with Specification Type set to Offer or Product. It's not available when the Specification Type field is Service, Resource, or undefined.

  1. From the Vlocity Product Designer, click the The down angle icon for the app navigation menu button, and select Products.
  2. Open a product or offer from the list.
  3. Click the arrow and select Generate All References.
    Generate All Reference menu item

You receive an email with the attached PDF report.

If a section has no data, then that section isn't in the report. For example, if an offer has no attachments or discounts, the Attachments and Discounts sections aren’t included in the report.

Example of a version report

Configure the Product Version Report

For the product version report in the Product Designer, you can modify integration procedures to set the columns, or fields, that are included in the PDF report.

Before You Begin

Verify that the UPC/Extract Integration Procedures are installed. If not, run the Install Datapack for Product Report job.

The report includes a list of the related objects for a specific version of a product specification or offering. The report sections can’t change, but you can modify the columns that appear in each section and their names in the report.

To change what columns are in the report, you can edit the UPC/ExtractProductInformation Vlocity integration procedure. While you can add or remove these columns, you can't select which attributes are reported.

For each section (or sometimes two sections), an integration procedure defines the data to retrieve. You can modify the output for the Omnistudio Data Mapper associated with the integration procedure.

example
example

Report Changes

Monique doesn’t want the ParentID column in the report and wants to add the IsNotAssetizable and AttributeID fields as report columns.

Note
Note

Don’t remove the ProductCode column because it’s required to match products for the report.

  1. Open the Vlocity Integration Procedures tab.
  2. Expand the UPC/Extract integration procedure that corresponds to the section that you want to modify, and open the most recent version.
  3. Click Create Version.
  4. Click the Extractor block.

    The exact name varies depending on the data that's extracted.

    In the example, Monique selects the ProductAttributeExtractor block.

  5. In the Properties tab, click the link icon to open the associated Data Mapper page.

    In the example, Monique opens the ExtractProductAttributes Data Mapper.

  6. On the Data Mapper page, click the Output tab, and change the mappings.

    Task

    Steps

    To add a report column

    • Click the + icon to add a mapping, and select from the Extract JSON Path list.

    • For the Output JSON Path, enter a value.

      • For attributes, you must use the attributes: prefix, such as attributes:IsFilterable.

      • Product fields don’t require a prefix, such as active.

      • Use a descriptive name of your choice.

      Highlighted fields for Extract JSON Path and Output JSON Path fields
    • Click the Collapse button.

    To remove a report column

    Click the Delete icon.

    The Delete icon
    Important
    Important

    Don’t delete or modify the JSON paths named for the section (such as the attributes or pricingAdjustments prefix, the fieldsMetadata path, or the response path. These are required keys for the Data Mapper to match and extract data for the report.

    Highlighted paths that shouldn't be deleted: the ​attributes​ or ​pricingAdjustments​ prefix, the ​fieldsMetadata​ path, or the ​response​​ path.
  7. In the Product Information Extractor tab, click Save and, if ready to use, Activate Version.

Future product version reports include the changes to the columns.

 
Loading
Salesforce Help | Article