Follow these steps to add a new local builder machine to your CPQ system to build your CAD files.
1) Determine if a local builder is needed.
First learn about the cloud builder and local builders, to see if you need a local builder. Usually the cloud builder meets most needs and local builders are not required.
2) Understand local builder theory.
If your output documents cannot be built in the cloud, the setup of a local builder is straightforward. To connect this document-making server on your network with the cloud-based service of Epicor CPQ , a piece of software called an output builder is installed on that computer. Unix people would call this a daemon, but since our output builder is for Microsoft Windows, it runs as a background process and can be found in the system tray.
The output builder program simply listens for any incoming document requests from Epicor CPQ, and springs to life when called. It feeds CPQ information to the proper software, and commands that software to create the files you need. It then saves and shares the files as you specify, and goes back to sleep.
Technically speaking, once installed and configured and assigned to a queue, this output builder can create any build that is not set to "Build in Cloud".
Unlimited Builders
You can create as many output builders as you want. You can also install them wherever you want. Here are some examples:
- No output builders installed at all.
If you don't generate any CAD files, there's no need to install any output builder. Just use our cloud-based builder and spare your IT organization the bother of caring for yet another computer.
- One output builder installed on a laptop.
When admin users are developing a configurator that generates CAD files, they will typically install an output builder on their own CAD workstation to test the CAD builds. It's faster than waiting for another machine, and you can watch your CAD program being driven by our Output Builder in real time.
- One output builder, installed on a dedicated CAD workstation.
It's headless, and secure in your server room, and your CAD designers can remote-control to it when needed.
- Two or three output builders, each installed on matching blade servers with the CAD software installed.
If you generate many CAD files, having multiple output builders processing requests in your queue can make performance faster and your infrastructure more redundant.
- One output builder installed on a virtual machine.
This is a common use case for production use, where the automatic scalability and redundancy of a VM helps your IT team reduce complexity.
Each output builder requires your licensed software.
- If your builder generates CAD files, then a licensed install of your CAD application(s) of choice is needed.
- If your builder creates Word or Excel-based files locally instead of in our cloud, then a licensed install of Microsoft Office is needed on that machine. The online version of Microsoft Office is not supported.
Multiple versions allowed.
Your CAD builder may have multiple versions of the same CAD software installed. For example, you may have two versions of SolidWorks installed on a workstation to test the newer version. The capture tool will use the version of SolidWorks last run by an administrator of that workstation.
3) Review system requirements.
- Microsoft .NET 6 or higher
- 64-bit Windows Operating System version 7 or higher. (other operating systems, or the 32-bit versions of Windows, are not supported.)
- Internet connection with outbound port 443 set open. The use of the 'Proxy' is not supported. A static IP is not required. The output builder calls only IP addresses in the Microsoft Azure cloud.
- The OS must have a user logged in with privileges to use the software that Epicor CPQ automates and to access the necessary files. This limitation is due to the desktop nature of the CAD applications.
- If your Output Builder automates the creation of CAD files, please refer to the Minimum System Requirements of your vendor.
- If you plan to use any other software (FEM, or PDM such as SolidWorks PDM Professional), please refer to the minimum system requirements of each additional installed/automated application.
4) Install the output builder.
- Be sure the computer you'd like to use as a builder meets the basic requirements listed at the bottom of this page.
- Confirm the CAD software you want to automate is installed correctly. (If you're automating the build of Microsoft Word or Microsoft Excel documents, be sure Microsoft Office is installed and updated.)
- Download the installer for the Epicor CPQ Output Builder:
- On the computer you'd like to use as a builder, log on to Epicor CPQ.
- In the administrative interface, choose Infrastructure > Tools. You'll see a link to the installer.
- Download and launch the installer. Ensure you have administrative rights to install software on your workstation, and accept the defaults for any questions.
5) Log in to the output builder.
The first step to using the output builder is to login with the following inputs:
Environment | Select the environment you want to connect this output builder to (dev, test, prod) |
Subdomain | The subdomain of your company account. The subdomain of your company can be discovered by looking at the url you use to visit Epicor CPQ in the browser. If you use a URL like: https://mycompany-dev.kbmax.com, then your subdomain is 'mycompany'. Note that any CAD output tests you'd like to perform based on our preview site or next site require the proper testing subdomain entered here. |
Email / Password | Any user account with a role of 'Company Administrator' can be used to login to the output builder. |
6) Confirm the new builder connects.
On any computer, log in to Epicor CPQ.
Visit infrastructure > builders, and confirm that your new builder appears in the list. It will appear with the name of the computer you installed it on.