Understanding Outputs

Outputs are dynamic files generated by placing data from a submitted configurator or quote into a template (such as a Word document or CAD drawing) to build a final output file.


Scalable, Modular Design

Output documents are created by combining data from each unique configuration with an easy-to-maintain template.  Each resulting output document can be exposed to your users directly, or used as building blocks to create more complex documents, such as ZIP archives or multi-page PDF files.  For example, a bill of materials (from a MS Word template), an engineering drawing (from a SolidWorks template), and an existing terms & conditions PDF (stored on your corporate website) can be combined into one multi-page quote PDF.

Visible to different people. 

One quote or configured product can generate many documents for different people. Examples include

  • A read-only PDF for your end user,
  • An editable Word Document for your distributor,
  • A CAD file for your manufacturing team, or
  • An XML or JSON file for your integration to an external system. 

Each of these documents can be created at different stages of the quote's workflow, and tagged to be visible to different users.  Nobody sees a file unless you define it. 

Stored in different places.  Available in different formats.

Files can be saved in various formats: 25 different ones so far, from JPG to EPUB.  And each file can be stored in the best place for your business.  Epicor CPQ can write directly to...

  1. A secure cloud URL in Epicor CPQ, visible only the right Epicor CPQ users, for the PDF quote they must review and approve.
  2. A public cloud URL in Epicor CPQ, visible to anyone who is given the unique path, for a JPG image of the product you want your customer to be able to share easily with partners or social media.
  3. A hard drive or PDM system (such as SolidWorks PDM Professional) in your own corporate network, for sensitive CAD drawings that must be stored internally for compliance.

You decide what information is shared in which format, to whom, and at what time during the workflow. 


Overview

After an administrator defines an output document by connecting a template to one of the two sources of data shown below, and defines when that document should be built, then users can see the completed output documents (or exports of that document into a different format). 

Two types of outputs are available, and offer different features:


Quote Output Configured Product Output
Scope Quote outputs provide a general summary from many or all products related to a quote. Configurator outputs give specific, detailed information from one specific custom product.
Examples (with output types)
  • A Quote,
    showing the SKU, description, quantity, and price of each product in the quote.  (Word Output or Excel Output)
  • A PDF Bundle of any or all pages of other builder outputs, including all the configurator outputs in the next column. (PDF Bundle Output)
  • A Zip File of any or all pages of other builder outputs, including all the configurator outputs in the next column. (Zip File Output)
  • An Image,
    showing a representation of the specific configuration with all its specific settings, based on a 3D scene (Scene Render Output) or a 2D image template (SVG Output).
  • Parts List or Spec Sheet,
    listing all the physical components which make up the current configuration. (Excel Output)
  • A Bill of Materials (BOM),
    showing quantities, descriptions of labor, materials, costs, and prices, based on the PriceObject of the current configurator and all the Lines of that PriceObject. (Word Output)
  • An Engineering Drawing,
    showing dimensions, tolerances, and other schematic/parametric data from the current configuration. (CAD Output)
  • An XML, JSON, or proprietary data format for integrations to other systems (Text Output)
  • Bundle of any or all pages of other builder outputs. (PDF Bundle Output)
Source Data

A Quote and any of its standard or configured products.

A configured product, and all its attributes (including nested configurators).  



Related Terminology

Build Types are labels used to trigger a build in a workflow.

Builds are a collection of output files that you want to automate when a user runs your configurator and adds it to a quote.

Exports are a way to export an output file to another file type.  

External IDs are how a Epicor CPQ Output Field is mapped to a specific entity or location in an output template.  

 

Output Types

  • Word Output — a document based on Microsoft Word. The most commonly used output type, Word outputs can generate just about any type of document, from invoices to installation manuals, using a template format that most businesspeople are familiar with editing.
  • Excel Output — a document based on a Microsoft Excel file.
  • Scene Render Output — a 2D "snapshot" image of your 3D scene for the given configured product. This image can be used alone or included within other outputs, like a Word Output.
  • SVG Outputa dynamic 2D image or diagram which can be exported and placed into other outputs, like Word or Zip outputs.
  • Text Output — Text Outputs let you create a text file where each character in the output is under your complete programmatic control. Create JSON files for logging or integrations, DXF files for laser cutting machines, and more.
  • CAD Output — A CAD Output generates one or more CAD models or documents using a supported CAD platform.
  • Export — allow an output file to be used as another file type. For example, convert a word document into a PDF.
  • PDF Bundle Output — A PDF Bundle output can combine many other outputs together into one single PDF file.
  • Zip File Output — A Zip file output can gather up many other outputs into one single zip archive.

Output Related Objects

When creating an output, other objects are listed below the output in the design tree.  These objects are specific to just that output, and help it work. 

Output Fields

Output fields are the locations in your template where the dynamic content will be placed.  They define parts of an output that you mark for control/automation via output rules. Examples of output fields include a particular location for text in a Word document, a specific dimension or feature in a CAD model, or a specific cell in an Excel spreadsheet.

The best way to collect fields for automation is to use the Capture Tool which captures existing fields and creates new ones depending on the output type. Output fields can also be added manually in the configurator and output file. Similar to configurator fields, output fields must have a unique name.

Once your output fields are defined, then you can write output rules to populate them.

Output Rules

Snap rules help you control when an output build is generated, and what the contents of the output build are. Learn more about Output Rules.

Exports

Each output can be exported to a specific file type for consumption to another output or to be attached to a quote. For instance, a CAD Drawing output can be exported to a JPG file which can be embedded into a Word Output. Also, a CAD Drawing output can be exported directly to PDF. Exports, like outputs, can be tagged and have their own target filename and description. In order for an output to use an export of another output, it must appear in the tree below that export.

CAD Drawings

The CAD Drawings folder is only visible when managing a CAD-based output.


Was this article helpful?