Welcome to Zuora Product Documentation

Explore our rich library of product information

Register custom component in CPQ X

Learn how to register a custom component in CPQ X by navigating through settings, completing component information, and activating the component.

After you have completed the code implementation of your components, you must register your components in CPQ X so that the custom UI components are rendered in the Quote Studio sidebar.
  1. Navigate to Zuora Config > Quote Studio Settings > Custom Component Settings.
  2. Click the Create New Component button.
  3. Complete the component information for registration.
    • (Optional) Component Namespace: Enter the namespace of your component.

    • Component Name: Enter the name of the component.

    • Component Type: Select Aura or LWC from the dropdown lists.

    • (Optional) Component Event Action: Select the event actions you want to handle in your component.

      Sometimes, after you upgrade your Zuora CPQ package from the previous version, newly created events in the upgraded package might not be available. In such cases, you will have to create the event picklist with the value and name as the one present in Event Type for the field zqu__Component_Event_Action__c in the object zqu__Add_on_component_registration__c.

    • (Optional) Use as Headless Component: Check this box to designate the component as headless. For more information, see Headless component - hooks.

      Headless Components will not appear in the Quote Studio Sidebar.

    • Active: Select this check box if you want to activate the registered component on registration.

    • Sort Order: Enter the number of the sequence number such as 1. The registered components are sorted and displayed in the ascending order based on the Sort Order value.

    • (Optional) Title Text: The title text for the registered component.

    • Image Resource Name: Enter the name of your component. It should be identical with the name of the image file that is uploaded to static resource in Salesforce.

  4. Click Create.

    If the created component is added to the table in the Manage Existing Components tab, the component is successfully registered.