Properties of Outputs

Each output type has its own properties specific to the functionality of the output. Generally speaking, they each share the following common properties.  Remember, these properties can be hard-coded during design time, and overwritten with dynamic settings by your output rules during run time.

 

Property Description
Name A title for the output.
Description A short description of what the output is used for.

Tags

Tags control document visibility.  If you set "post to cloud" below so this file can be seen by authenticated Epicor CPQ users, first add tags here to define who should see it at a general level, and then in the workflow associate those same tag names with specific users or groups.  Tag names can be created on the fly, and there is no restriction to the number of tags or which users/groups you associate them with.  If a file has no tags, then it won't be visible to any users (except Company Administrators).

Example: if you have an editable Word Doc version of your quote that only salespeople should see, and a PDF version that both your salespeople and distributors should see, then tag the DOC with a tag like "forSales" and the PDF with "forSales" and "forPartners".  Then in the workflow, you can associate these two tags with the right users or groups.  

Enabled

If this is unchecked, the output will not be built.

Example: if your company creates quotes in English and French, then create one output file for each language.  In each output file, set the "enabled" to false, so they are not built.  Then add code to the output rule to set the "enabled" to true on either one or the other, based on your business rules (such as what language the user prefers, or what country they live in).  In this way, one configurator can generate different documents in different situations.  Learn more about localizing your outputs.

Post to Cloud

Output files can be stored in various places.  Posting to the cloud is the most common destination.  Check this box to attach the output file to the quote or configured product from which it was based. Note: as long as the output is "enabled", the file will be built. This property only controls whether the file is attached back to the quote.

Example: if your configurator creates a CAD output, set this to false for that CAD output, and remove any tags.  Rarely do you want the native CAD files to be visible for the customer or salesperson to download. But perhaps you have a PDF export of this CAD output.  Set this to true for the PDF output, and add any necessary tags so it's visible on the quote to the right users.

Post to Public Cloud

Some files you want to share more widely than just to those authenticated users who can see the quote in Epicor CPQ.  Set this to true to save the file at a public URL that anyone on the internet can see. Any outputs built after this one via the workflow will also be on public blob storage.

The URL can be shared easily, and is visible to anyone connected to the public internet.  The URL to download the output follows the syntax:

https://[company].kbmax.com/api/quotes/productfile/download/[quote_product_file_id] where quote_product_file_id is the ID of the file attached to the quote product.

Example: if your configurator creates an attractive scene render output, you may want to store this image in a way your user can easily share on social media.  Check "post to public cloud" for this scene render, and use an email template to share this public link to the creator.  They can use the link to share the image easily to anyone on the web, no password required.

Overwrite Pre-Existing Builds

Quotes may be submitted, rejected, and re-submitted into a workflow.  Or your workflow may have a loop.  When this happens, this build may be performed more than once. 

  • Set to "True" to overwrite the old version of the document. 
  • Set to "False" to keep the old version.  It remains visible to the same users, with its original name, only with a version number appended to the name. 

Example: for internal files that you want to keep as a "paper trail" showing all the changes made across the many times this quote has been revised, set to false.  For customer-facing files, where only the most recent version is important and seeing other versions could be confusing, set to true.

Target Filename

Leave blank to default to the name of the output above.  Or enter a default filename here.  Or use a Snap output rule to set the name of the file dynamically. 

Note: simple, short filenames are best.  Longer filenames, or filenames that include complicated characters or whitespace characters, can cause problems. When using your own output builder, remember to only use characters supported by your output builder's file system.  For example, a filename of "Quote1234.pdf" is easy to share, but a filename of "引用1234 for customer use/only/.pdf" may cause some filesystems to have an error.  Keep it simple.

Target Directory
  • If you use the Epicor CPQ cloud builder to make this output, the path is ignored.
  • If you use your own output builder to make this output, then use this parameter to specify the folder path where the output file should be written. If left blank (recommended), the default location specified in your output builder settings will be used.   
Template File
  • If you use the Epicor CPQ cloud builder to make this output, click on the button to select the correct template file from the Resources > Templates directory.  If it doesn't exist yet, you can upload your template into the Templates directory, create subfolders, and perform other maintenance on the Templates directory.
  • If you use your own output builder to make this output, specify a full absolute path, from the perspective of the output builder machine. When an absolute path is used, Epicor CPQ will attempt to find the file at that location from the machine that output builder is running on.

Example: if you are creating CAD outputs, and have a few output builder machines in your company network assigned to the Queue servicing these requests, don't repeat yourself by saving the same templates over and over on each output builder.  Rather, save your templates once in a shared network location within your company network accessible by all the builders, like "E:/CAD/Templates".   Of course, each output builder should have this same drive mapping and the same access to that drive.


Was this article helpful?