Home Search

DriveWorks Pro 23
Using The CPQ DriveApp

Send Feedback

Using The CPQ DriveApp

The DriveWorks CPQ DriveApp allows you to manage the entire sales process of your configurable products.

Administer lists of Accounts, Quotes, Price Lists and more. Configure your own catalog, for both Standard and Custom Products.

Running CPQ

When the CPQ DriveApp is running (see DriveApps) the Home screen will be shown (unless the Start Parameter has been customized).

The following tiles appear on the default Home screen:

  • Accounts

    Opens the Accounts list.

  • Contacts

    Opens the Contacts list.

  • Quotes and Orders

    Opens the CPQ Quotes and Orders dashboard, containing the following tiles:

    • View All

      Opens the View All list.

    • View Saved

      Opens the View Saved list.

    • View Quotes

      Opens the View Quotes list.

    • View Orders

      Opens the View Orders list.

    • View Shipped

      Opens the View Shipped list.

  • Catalog Administration

    Opens the CPQ Catalog Administration dashboard, containing the following tiles:

    • Items

      Opens the Items list.

    • Price Lists

      Opens the Price Lists list.

    • Catalog Categories

      Opens the Catalog Categories list.

  • CPQ Administration

    Opens the CPQ Administration dashboard, containing the following tiles:

    • Currencies

      Opens the Accounts list.

    • Territories

      Opens the Territories list.

    • Teams

      Opens the Teams list.

    • Users

      Opens the Users list.

  • CPQ KPIs

    Opens the CPQ Administration dashboard, containing the following tiles:

    • Total Orders
    • Quoted
    • Ordered
    • Shipped
    • Last Hour
    • Last 24 hrs
    • Last Week
    • Last Month
    • Last 3 Months
    • Last Year

CPQ Quick Start Guide

Before using the DriveWorks CPQ DriveApp - follow the steps below to allow quick set up of the CPQ DriveApp.

1. Set up the Base Currency

CPQ requires a Base Currency to specify the pricing of the items.

All other Currency Exchange Rates will be based off the specified Base Currency.

To set up the Base Currency, follow the steps below:

  1. From the main CPQ Dashboard, go to CPQ Administration > Currencies.
  2. Click Add in the Currencies List.
  3. Add the currency that will be the Base Currency. Set the Currency Exchange Rate to 1.
  4. With the Currency added, go to the DriveApp Settings (click the button at the top right of the header) > CPQ Settings.
  5. Select the General tab, and from the Base Currency drop down, select the Currency previously added.

2. Set up the Default Initial Category

Items are added to orders using the CPQ Catalog.

The CPQ Catalog includes Standard and Custom Items.

These Items can be categorized by creating Catalog Categories.

One Category must be selected to be the Default Catalog Category.

This category will be the first category that is shown when new Items are added to an Order.

  1. From the main CPQ Dashboard, go to Catalog Administration > Catalog Categories.
  2. Add a new Category. Enter a name (for example Main or Default).
  3. With the Category added, go to the DriveApp Settings (click the button at the top right of the header) > CPQ Settings.
  4. Select the Catalog tab, and from the Default Initial Category drop down, select the new Category from the list.

3. Next Steps

Once the above steps are completed the CPQ DriveApp is ready to use.

The following are additional steps that may be required before creating the first Order.

  • Add a Standard Item using the Catalog Administration > Items.
  • Add the Standard Item to the Catalog using the Catalog Administration > Catalog Categories Dashboard Tile and edit either the existing Category or create a new one.
  • Create a new Account and Contact in the CPQ DriveApp. This will allow an Order to be linked with an Account.
  • Create a Price List and add Standard Items. Price Lists can be created for different Currencies that have been added.
  • Look through the DriveWorks CPQ DriveApp Templates - these show further customizations to enhance the DriveWorks CPQ DriveApp.

4. DriveWorks CPQ DriveApp Templates

There are a number of Templates that come with the DriveWorks CPQ DriveApp.

These Templates enable further customization of the CPQ experience, by setting up custom exports, custom items and linking DriveWorks Orders with Third Party systems.

Each Template has its own guide, which can be followed to link your own DriveWorks Projects to the CPQ DriveApp.

Adding Existing Configurators to the CPQ DriveApp

For existing configurators that are required to be consumed in the CPQ DriveApp we have provided a Form template.

This template can be used to add the necessary Variables\Form Controls etc to a configurator that is required to be used as a Custom Product inside the DriveWorks CPQ DriveApp.

For more information on adding this template to an existing configurator please see CPQ Custom Item.

Embedding CPQ into your website

A customer facing entry point for the CPQ DriveApp can be used to embed your catalog\configurators into a website to create custom quotes and orders.

This removes the need for a user to log in before they can start configuring their own order. Less options are also available, so discounts, shipping costs etc cannot be applied.

Any data that is configured using the embedded entry point of the CPQ DriveApp can be accessed and managed from a standard CPQ DriveApp entry point, if they are both linked to the same database.

Learn more about how to set up an embedded entry point using the following guide:

Embedding a CPQ Order

Settings

Click the Settings button (top right of the header) to customize the CPQ DriveApp.

Teams that have the setting Administer DriveApps applied (found in Team Security Setting) will only be able to customize the Dashboard.

If the logged on user is a member of more than one Team a dialog will be shown, select the required Team from the drop down.

Select the following menu items from the left of the Settings screen to customize the CPQ DriveApp:

Running Multiple DriveApps

When running multiple DriveApps that share the same database any global customizations made will apply to all DriveApps.

Customizations will need to be applied to each DriveApp if they have their own database.

Appearance

By default, the appearance of the DriveApp will be skinned with the DriveWorks logo and default DriveWorks color schemes.

Two versions of a logo are required:

  • Small (200x200px)- used in device responsive DriveApps, when viewed from a smaller screen (phone or tablet for example)
  • Large (400x200px)- used when viewed from a monitor screen or larger tablet

Image files must be .jpg or .png file and less than 100kb.

We recommend using .png with transparency set for any white space.

  1. Click the Upload button under each Logo version.

    The Preview tile will display the selected logo.

  2. Browse to the location of the image and click Open.

Font

Choose the Font required to use in the DriveApp.

  1. Click the browse button at the end of the current font field.
  2. Select from the list of available fonts, or check the Custom box to define a custom font.
  3. When using a custom font the changes will need to be saved.

Choose the size required for the selected font.

Select from:

  • Small
  • Default
  • Large

Date

Select the required format for dates displayed in the DriveApp.

Select from:

  • DD-MM-YY (Day-Month-Year)
  • MM-DD-YY (Month-Day-Year)

Colors

DriveApps use four areas where the color scheme can be customized:

  • Highlight

    Controls the highlight strip applied just above the header.

  • Background

    Controls the header color.

  • Workspace

    Controls the color of the area behind the tiles.

  • Contrast

    Controls the color of any side menu that could become available.

Each color area can have the following elements customized:

  • Background

    Select the required element from the color area and enter the color Hex Code in the Preview Color field.

    Click the save icon to apply.

  • Text Color

    Select the required element from the color area and enter the color Hex Code in the Preview Color field.

    Click the save icon to apply.

  • Icons

    Select the required element from the color area and choose Light or Dark.

    Click the save icon to apply.

Dashboard Tiles

Control the size and colors used on tiles in the appearance settings.

  • Ratio

    Control the aspect ratio of the tiles by selecting from:

    • Square
    • Portrait
    • Landscape

    The Tile Layout Preview displays the tile in the selected Ratio.

  • Size

    Choose the size of a tile by selecting from:

    • Small
    • Medium
    • Large

    The height and width of each selection depends on the chosen Ratio.

    The height and width is displayed, in pixels, on the Tile Layout Preview.

  • Hover Border Color

    Choose a hexadecimal color value to apply to the tiles border when it is hovered over.

  • Left Border

    Toggle to display a bar on the left hand border of a tile.

  • Left Border Color

    Choose a hexadecimal color value to apply to the left border.

Dashboard Tiles - Preview

Control the position of text and icons used on tiles in the appearance settings.

  • Title

    Toggle to choose if the tile title is to be displayed.

    The title placeholder will be shown or hidden on the Tile Layout Preview.

  • Description

    Toggle to choose if the tile description is to be displayed.

    The description placeholder will be shown or hidden on the Tile Layout Preview.

  • Icon

    Toggle to choose if the tile icon is to be displayed.

    The icon placeholder will be shown or hidden on the Tile Layout Preview.

  • Tile Layout Preview

    The Preview of the tile layout shows the actual size and aspect ratio selected for the tile.

    The position of each text block and icon can be controlled using the Move Up and Move Down arrows to the left hand side of the preview.

    The vertical alignment of the text within the title and description placeholders can be adjusted by:

    1. Select the placeholder required to have its vertical justification changed in the preview window.
    2. Select the required justification arrow on the left hand side of the preview.

Preview

The Preview section shows a preview of how the current dashboard will look.

The toggle options allows the dashboard to be previewed in Phone, Tablet or Desktop modes.

The Menu section changes behavior of Dashboards that have been set to be displayed as a menu.

The Dashboard type is set when adding or editing a Dashboard.

See Add, Edit or Delete a Dashboard below for more information.

There are two settings available for Menu type dashboards:

  • Show Icons

    When selected and the menu is collapsed the icons will remain in view.

  • Expand On Open

    When selected and the dashboard is opened the menu will automatically expand to the full width (including the text).

Language

All DriveApps are designed to be translatable.

The default language is English, but each DriveApp has the ability to translate the text used into your preferred language.

Expand to see how to set up languages

Dashboard Manager

The Dashboard Manager allows Dashboards to be created and edited.

It is also where the tiles that appear on each dashboard are applied.

Add, Edit or Delete a Dashboard

To add a new Dashboard:

  1. Click Add.
  2. Enter a Dashboard Name.
  3. Enter a Description.
  4. Select the Alignment for the text.
  5. Select Hide Header to hide the main header bar.
  6. Select Wrap Tiles to wrap the tiles in view when others become hidden.
  7. Select the Type of dashboard:
    • Standard - displays all items on the dashboard as tiles in the main window.
    • Menu - displays all items on the dashboard as a collapsible menu on the left of the main window.
  8. Upload an image for the background, if required.
  9. Click Save.

To edit an existing Dashboard:

  1. Select the Dashboard from the dashboard list.
  2. Click Edit.
  3. Change the required settings.
  4. Click Save.

To delete an existing Dashboard:

  1. Select the Dashboard from the dashboard list.
  2. Click Delete.
  3. From the Delete Dashboard confirmation dialog, click Delete.

Modify Tiles

Modify Tiles allows tiles to be added and positioned on the selected Dashboard.

A maximum of 12 tiles can exist on any dashboard.

To add a new tile to the dashboard:

  1. Select the Dashboard to add tiles to and click Modify Tiles
  2. Select an empty row in the list and click Add.
  3. Enter text to display on the Header of the tile.
  4. Enter a description.
  5. Select a Type for the tile.

    See Tile Types for a description and extra fields added for each available Tile.

  6. Select the Background to be located on the tile, this can either be a default color or a custom background (created in the Tile Background Creator setting).
  7. Select an Image (optional) - an additional smaller image that appears on top of the tile can be selected.

    This field is not available for any KPI type tile.

  8. Select the Text Color - This can be toggled between Black or White.
  9. Select the Text Alignment - The options for the alignment are Left, Right, or Center and this will be how the text appears on the tile.
  10. Select Permissions.

    Permissions allows Teams access to the tile on the dashboard.

    By default this is set to Allow All.

    When a tile requires access for certain Teams only, they can be granted permission here.

    Once Custom is selected, the single chevron can be used to move the currently selected team to the allow column or the double chevron can be used to move all teams to the allowed column (the same works in reverse).

  11. Visibility

    Enter a rule to dynamically change the visibility of a tile.

  12. Click Save.

To Edit an existing tile:

  1. Select the Dashboard with the tiles to be edited and click Modify Tiles.
  2. Select the tile from the list and click Edit.
  3. Change the required fields.
  4. Click Save.

To Reposition a tile:

  1. Select the Dashboard with the tiles to be repositioned and click Modify Tiles.
  2. Select the tile from the list and click Move Up or Move Down.

To Delete a tile:

  1. Select the Dashboard with the tiles to be deleted and click Modify Tiles.
  2. Select the tile from the list and click Delete.

Tile Types

The Types of Tile that can be added are as follows:

  • Dashboard

    This will add a field named Dashboard.

    Select the Dashboard that will be loaded when this tile is selected

  • DriveApp

    This will add fields named DriveApp and Additional Data.

    DriveApp is the DriveWorks DriveApp that will be loaded when the tile is selected.

    Data is text that will be passed into a constant called Data on the selected DriveWorks DriveApp.

  • DriveWorks Project

    This will add fields named Project, Data, Macro Name and Macro Argument.

    Project is the DriveWorks Project that will be loaded when the tile is selected.

    Data is the text that will be passed into a constant called Data on the selected DriveWorks Project.

    Macro Name is the name of a macro to run in the DriveWorks Project.

    Macro Argument is an optional argument provided to the macro, see Macro Argument for more information.

  • Embedded

    This will add fields named DriveApp and Start Parameter.

    DriveApp is the DriveWorks DriveApp that will be loaded when the tile is selected.

    Start Parameter

  • Hyperlink

    This will add a field named URL.

    Enter the URL for the hyperlink to navigate to.

  • KPI

    This will remove the Image field and add a field named KPI.

    KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

  • KPI & Dashboard

    This will remove the Image field and add fields named KPI and Dashboard.

    KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

    Dashboard is the Dashboard that will be loaded when this tile is selected

Tile Types (continued)

The Types of Tile that can be added are as follows:

  • KPI & DriveApp

    This will remove the Image field and add fields named KPI, DriveApp and Data.

    KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

    DriveApp is the DriveWorks DriveApp that will be loaded when the tile is selected.

    Data is text that will be passed into a constant called Data on the selected DriveWorks DriveApp.

  • KPI & DriveWorks Project

    This will remove the Image field and add fields named KPI, Project and Additional Data.

    KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

    Project is the DriveWorks Project that will be loaded when the tile is selected.

    Additional Data is the text that will be passed into a constant called Data on the selected DriveWorks Project.

  • KPI & Hyperlink

    This will remove the Image field and add fields named KPI and URL.

    KPI Name is the KPI that you want to be displayed on the tile. Next to Background, there will also now be a Use KPI Settings button which will pull through the Background and Text Color of the KPI to be used on the tile if required.

    The property URL will be added where the required hyperlink for the tile to redirect to can be entered.

  • List

    This will add fields named List, Macro Name and Macro Argument and allows a list to be selected to be displayed on the KPI.

    Macro Name is the name of a macro to run when the list is launched.

    Macro Argument is an optional argument provided to the macro, see Macro Argument for more information.

    Macros are set up in lists created from the CPQ Custom Item template.

    Lists are set up in the List Manager.

  • List - Add Record

    This will add a field named List and allows an add record list to be displayed on the KPI.

Tile Background Creator

Create a Tile with a custom image.

Expand to see how to create tile backgrounds

KPI Manager

This displays a list of default KPIs.

Each has a description of what KPIs they will report.

The search bar located above the Table to the left, can be used to search the existing KPIs by name.

The KPIs can be filtered by Category using the Category drop down.

Expand to see how to change KPI settings

List Manager

A DriveApp List is a view of a table of data into which items can be added, edited or removed.

The Dashboard DriveApp uses Lists to allow administration of Teams and Users

The List Manager allows Lists to be applied that will be displayed on Dashboard Tiles.

Expand to see how to edit the List Manager

CPQ Settings

Additional settings for CPQ are found in the following tabs across the top of the CPQ Settings window:

General

General Settings

Base Currency.

Select the Base Currency to use, from the drop down.

A Currency must have been applied, to be available from the drop down.

Record Exclusion Teams

Identify Teams to be excluded from being linked to new records.

Use the controls to add Teams that are not required to be linked to Records (Order, Accounts, Contacts).

The Teams Will be excluded from the drop down when creating a new record.

Catalog

Price List Settings

Specify Price List prices in Base Currency.

Check this option to use the Base Currency.

Catalog Settings

  • Default Initial Category

    A Category must have been applied, to be available from the drop down.

  • Catalog Image Size

    Set the size of the Catalog Image (px).

  • Show Title and Description

    Check this to display the Title and Description.

Custom Fields

Set the Custom Field Project to use with each record.

See CPQ Custom Fields for instructions to create a Custom Fields Project.

Orders

Apply Order and Workflow settings.

Order Settings

Alternate Order Details Project Required

Order Details Project

Order Permissions

  • Discounts
  • Quote Pricing
  • Freight
  • Tax

Workflow Settings

Keep Quote/Order open on Workflow Transition

Reload Workflow Project automatically after Transition

Reload delay duration

Linked Order Items Settings

Delete Linked Order Items when Parent Order Item is deleted

Delete Parent Order Items when Linked Order Item is deleted

Copy Linked Order Items when Parent Order Item is copied

Copy Parent Order Item when Linked Order Item is copied

Copy Order Settings

Update line item pricing when an Order is copied?

  • Always
  • Prompt
  • Never

Sync

A CPQ Data Synchronization Project must exist.

Set the Project to use, for each Record type, when synchronizing data with a Third Party system.

Check the box under each Record type to enable synchronization on Add/Edit.

Tabs

Select the tabs to appear on each List view.

Columns

Columns displayed in the Orders Table can be applied and controlled.

To Add a column to the Orders Table, select CPQ Settings and then the Columns Tab and:

  1. Select Orders from the List Type drop down.
  2. Click Add.
  3. From the Adding Column window, choose Standard or Custom

    Custom Columns

    Custom columns are added in the CPQ Custom Fields template.

  4. Add the required properties for the column:
    • Name (this is fixed and cannot be changed)

      The name of the column.

    • Alias

      The name displayed in the Orders table.

      Translation

      Translation (see Language above) of the Alias field is only maintained for the default columns.

    • Width

      The width of the column.

    • Justification

      The justification (alignment) of the column text.

  5. Click the Save icon to save the column.

CPQ Help

This links to the online version of this page.