You are here: Integrating With CPQ Cloud > Integration Guides > Bulk Downloads

Bulk Downloads


You can make changes to large quantities of system data in CPQ Cloud. For example, you may need to download data in bulk, make batch edits, and then upload the data back to CPQ Cloud.

There are several ways to move data and files in CPQ Cloud. See the table below to determine which help topic to use.

To Move... See...
Data to CPQ Cloud tables, in bulk Bulk Uploads
Data from CPQ Cloud tables, in bulk This document
Data Tables Import & Export of Data Tables
File Manager files, such as images, .PDFs, or XSL files File Manager
Documents in Document Engine Document Migration: Document Engine
Migration changes between CPQ Cloud environments Migration Management Overview

ClosedData Types Available for Bulk Upload and Download

The following table shows the Data Types that can be uploaded and downloaded, and in which format.

All data that can be uploaded into the system can also be downloaded. For the XML data type, all downloaded data can be uploaded. However, only some downloaded CSV data can be uploaded.

Data Type XML CSV
Accounts X X
Company X X
Configurable Attributes X X
File Manager* X X
Part Associations X X
Part Extended Descriptions X X
Parts X X
Price Book Associations X X
Serial Number Associations X X
Serial Numbers X X
User** X X
Part Pricing Rule Information   X
Translations   X
Account/User Associations X  
Commerce Processes*** X  
Commerce Transactions**** X  
Configuration Rules X  
Data Tables* X  
Library Functions X  
Printer Friendly Document X  
Product Definition X  
Text Administration X  

* Downloading Data Tables and File Manager is useful if you want to download all Data Tables or all File Manager files in a single ZIP file. However, specific tools, besides Bulk Upload and Download, are used to manage Data Tables and File Manager. See Import & Export of Data Tables and File Manager for more information.

** Users cannot be deleted. Instead, change a user's status to Inactive..

*** The Commerce Process can also be obtained from the Process Definition Deployment center, by using "Import Process".

**** Commerce Transactions cannot be added or deleted, so the <action> tag can only be update, and the <action_var_name> tag must be populated with this valid action.

ClosedTransferring the Product Family Data Type

The following data types require that a Product Family be specified in order to be transferred between sites, such as through migration or bulk download/upload:

Data Type XML CSV
Model (requires Product Family) X X
Product Line (requires Product Family) X X
Catalog Data (requires Product Family) X  

Configuration Data (requires Product Family)

  1. Migrate the Product Definition first, because it contains the information of what Product Family has been defined.

    This will add the reference of the Product Family to the site.

    If the Product Family already exists on the site, then you can see the categories that are listed.

  2. Manually add the Product Family under Catalog Definition.
  3. Continue migrating the Product Line.
  4. Migrate the Catalog.
  5. Migrate Configuration data.
  6. Migrate Attributes.
  7. Migrate Rules.


ClosedPerforming a Bulk Data Download

  1. ClosedNavigate to the Download Category List page.

    1.  Click Admin to go to the Admin Home Page.
    2.  Click - Download under Bulk Data Services in the Utilities section.

      The Download Category List page appears.

  2. Select a category to download.
  3. Click Next.

    The Search Criteria page appears.

  4. Specify the criteria. Only the data that satisfies the criteria will be downloaded.

    Filter Field Names Description

    The CPQ Cloud system generates a unique ID for each item it stores, be it a rule, attribute, account record, ... and so on. For downloads, the ID field can be used to filter a single record in that download category.

    In general, you can locate an ID by navigating to the item you want to download and then viewing the corresponding ID in the URL.

    company_id Company IDs can be located in the home page URL.

    This is the ref_type ID that is generated (for example, Model ID, Product ID, Company ID for all Product Families).

    Navigate to the Model List Admin Page and view the ref_type ID in the URL.


    For the "all product family" product category, the segment ID equals the company ID. Company IDs can be viewed on a Commerce page, if the attribute has been placed on the layout.

    For the "single segment" product category, the segment ID is a unique number associated with a particular segment. Segment IDs can be located by navigating to the Product Line Administration List page and viewing the segment_ID in the URL.


    To locate a product line ID, navigate to the Product Line Administration List page, click the Product Line, and view the parent_id in the URL.

    The URL shows /edit_pline.jsp?id=5543984 &segment_id=11&_fromQlink=0. The specific ID for the product line is 5543984.

    model_id To locate a model ID, navigate to a rule at the model level and view the model_ID in the URL.
    attribute_id To located an Attribute ID, navigate to the Attribute Administration List page, put the cursor over a specific attribute link and view the ID that dynamically appears in the browser window's bottom bar.
    rule_id To locate a Rule ID, navigate to the Rule List page, put the cursor over a specific rule link and view the ID that dynamically appears in the browser window's bottom bar.
    part_id To locate a Part ID, navigate to the Part Administration page for a specific part and view the "pid" in the URL.
    serial_number_id To locate a serial number ID, navigate to the Serial Number Administration page for a specific serial number and view the ID in the URL.
    part_association_id Part Association IDs can be found on the Part Tree for Part Number page, which displays part associations for a select part. To view a part association ID, highlight a part number and view the ID that dynamically appears in the browser window's bottom bar.
    parent_part_id, child_part_id

    When downloading a single part association, these IDs must be used together.

    Each field expects a part_id: one for the parent part association and the other for the child part association.

    Part Associations can also be downloaded using the part_association_id instead of these two IDs.

    serial_number_id, part_id

    When downloading a single serial number association, these IDs must be used together.

    The first field expects the serial_number_id, and the second field expects the part ID for the associated part.

    To download all the data in the Data Table, leave all criteria blank.

  5. Click Download.

    The Download Status page appears.

    Downloaded files are stored on the server. Files that are stored on the server can be downloaded onto your local system or viewed in your browser from the server location.

      The types of Configuration rules you can download are: recommendations, constraints, and pricing.

      Only one type of rule can be downloaded at a time.

      Product line and model data can be downloaded for one segment at a time.

      When downloading Commerce or Asset Management data, the entire transaction, including all documents and sub-documents, is downloaded.

ClosedViewing Download Status

The Download Status page shows the module name and status of all files scheduled for download in the previous seven days. The page also displays the status message and the scheduled date and time.

Successful downloads showing a status of Completed are removed from the Download Status page after seven days. Download tasks with any other status are not removed from the Download Status page.

To access the Download Status page:

  1. Click Admin to go to the Admin Home Page.
  2. Click (Status), next to - Download, under Bulk Data Services in the Utilities section.

The Download Status page appears.

Using this page, you can:

Up to five download files can be stored on the server at any given time.


ClosedData Table Change Log

You may have an optional feature that allows you to audit changes to the Data Tables. For more information, see Data Table Change Log and Auditing


Related Topics Link IconSee Also